Autocomplete<T extends Object> class Null safety

A widget for helping the user make a selection by entering some text and choosing from among a list of options.

The user's text input is received in a field built with the fieldViewBuilder parameter. The options to be displayed are determined using optionsBuilder and rendered with optionsViewBuilder.

This example shows how to create a very basic Autocomplete widget using the default UI.

To create a local project with this code sample, run:
flutter create --sample=material.Autocomplete.1 mysample

This example shows how to create an Autocomplete widget with a custom type. Try searching with text from the name or email field.

To create a local project with this code sample, run:
flutter create --sample=material.Autocomplete.2 mysample

Constructors

Autocomplete({Key? key, required AutocompleteOptionsBuilder<T> optionsBuilder, AutocompleteOptionToString<T> displayStringForOption = RawAutocomplete.defaultStringForOption, AutocompleteFieldViewBuilder fieldViewBuilder = _defaultFieldViewBuilder, AutocompleteOnSelected<T>? onSelected, double optionsMaxHeight = 200.0, AutocompleteOptionsViewBuilder<T>? optionsViewBuilder, TextEditingValue? initialValue}): Creates an instance of Autocomplete.
const

displayStringForOption → AutocompleteOptionToString<T>: Returns the string to display in the field when the option is selected.
final
fieldViewBuilder → AutocompleteFieldViewBuilder: Builds the field whose input is used to get the options.
final
hashCode → int: The hash code for this object.
nonVirtual">@nonVirtualread-onlyinherited
initialValue → TextEditingValue?: The initial value to use for the text field.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onSelected → AutocompleteOnSelected<T>?: Called when an option is selected by the user.
final
optionsBuilder → AutocompleteOptionsBuilder<T>: A function that returns the current selectable options objects given the current TextEditingValue.
final
optionsMaxHeight → double: The maximum height used for the default Material options list widget.
final
optionsViewBuilder → AutocompleteOptionsViewBuilder<T>?: Builds the selectable options widgets from a list of options objects.
final
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited

build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement: Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
protected">@protectedinherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

operator ==(Object other) → bool: The equality operator.
nonVirtual">@nonVirtualinherited