AutocompleteHighlightedOptionModifier class
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.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SingleChildStatelessModifier
- AutocompleteHighlightedOptionModifier
- Available extensions
Constructors
-
AutocompleteHighlightedOptionModifier({Key? key, required ValueNotifier<
int> highlightIndexNotifier, required Widget? child}) -
Create an instance of AutocompleteHighlightedOption inherited widget.
const
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
highlightIndexNotifier
→ ValueNotifier<
int> -
No docs
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- modifierKey → Key?
-
The actual key of the widget, which Modifier wrapped
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited
-
buildWithChild(
BuildContext context, Widget? child) → Widget -
A build method that receives an extra
childparameter.override -
createElement(
) → SingleChildStatelessElement -
Create a SingleChildStatelessElement
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent 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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited