AutocompleteHighlightedOption class Null safety

An inherited widget used to indicate which autocomplete option should be highlighted for keyboard navigation.

The RawAutoComplete widget will wrap the options view generated by the optionsViewBuilder with this widget to provide the highlighted option's index to the builder.

In the builder callback the index of the highlighted option can be obtained by using the static of method:

final highlightedIndex = AutocompleteHighlightedOption.of(context);

which can then be used to tell which option should be given a visual indication that will be the option selected with the keyboard.



AutocompleteHighlightedOption({Key? key, required ValueNotifier<int> highlightIndexNotifier, required Widget child})
Create an instance of AutocompleteHighlightedOption inherited widget.


child Widget
The widget below this widget in the tree.
final, inherited
hashCode int
The hash code for this object.
@nonVirtual, read-only, inherited
key Key?
Controls how one widget replaces another widget in the tree.
final, inherited
notifier ValueNotifier<int>?
The Listenable object to which to listen.
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited


createElement() InheritedElement
Inflates this configuration to a concrete instance.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel =}) String
A string representation of this object.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
toStringShort() String
A short, textual description of this widget.
updateShouldNotify(covariant InheritedNotifier<ValueNotifier<int>> oldWidget) bool
Whether the framework should notify widgets that inherit from this widget.


operator ==(Object other) bool
The equality operator.
@nonVirtual, inherited

Static Methods

of(BuildContext context) int
Returns the index of the highlighted option from the closest AutocompleteHighlightedOption ancestor.