GetFilterableTextField<T extends Comparable> class

A wrapper of GetTextField with filterable suggestion features.

Inheritance
Available Extensions

Constructors

GetFilterableTextField({required GlobalKey<GetFilterableTextFieldState<T>> key, required OnValue<T?> itemSubmitted, List<T>? items, GetFilterItemBuilder<T>? itemBuilder, Comparator<T>? itemSorter, Filter<T>? itemFilter, List<TextInputFormatter>? inputFormatters, TextStyle? style, String? label, String? helper, String? error, OnString? textChanged, OnString? textSubmitted, ValueSetter<bool>? onFocusChanged, TextInputType keyboardType = TextInputType.text, int itemCount = 5, int visibleCount = 5, double itemHeight = 58, bool submitOnItemTap = true, bool clearOnSubmit = false, bool showAllOnFocus = false, bool disableFiltering = false, bool onlyAcceptItem = true, TextInputAction textInputAction = TextInputAction.done, TextCapitalization textCapitalization = TextCapitalization.sentences, int minLength = 0, bool readOnly = false, bool validateEmpty = false, TextEditingController? controller, dynamic initialValue, FocusNode? focusNode, FocusNode? nextFocusNode, Widget? suffix})
const

Properties

clearOnSubmit → bool
Clear autoCompleteTextField on submit
final
controller → TextEditingController?
final
disableFiltering → bool
Disable query and filtering for suggestions and show all items
final
error → String?
final
focusNode → FocusNode?
final
hashCode → int
The hash code for this object.
no setterinherited
helper → String?
final
initialValue → dynamic
final
inputFormatters → List<TextInputFormatter>?
final
itemBuilder → GetFilterItemBuilder<T>?
Callback to build each item, return a Widget
final
itemCount → int
The amount of suggestions to show, larger values will go in ListView
final
itemFilter → Filter<T>?
Callback to filter item: return true or false depending on input text
final
itemHeight → double
Item height for suggestions list
final
items → List<T>?
Suggestions that will be displayed
final
itemSorter → Comparator<T>?
Callback to sort items in the form (a of type
final
itemSubmitted → OnValue<T?>
Callback on item selected, this is the item selected of type
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardType → TextInputType
final
label → String?
final
minLength → int
final
nextFocusNode → FocusNode?
final
onFocusChanged → ValueSetter<bool>?
final
onlyAcceptItem → bool
Don't accept simple text, only suggestion item
final
readOnly → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showAllOnFocus → bool
Show all suggestions without filter when focused
final
style → TextStyle?
final
submitOnItemTap → bool
Call textSubmitted on suggestion tap, itemSubmitted will be called no matter what
final
suffix → Widget?
final
textCapitalization → TextCapitalization
final
textChanged → OnString?
Callback on input text changed, this is a string
final
textInputAction → TextInputAction
final
textSubmitted → OnString?
Callback on input text submitted, this is also a string
final
validateEmpty → bool
final
visibleCount → int
The amount of suggestions to be visible at a time in ListView
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<StatefulWidget>
Creates the mutable state for this widget at a given location in the tree.
override
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