FlutterTagging class

FlutterTagging widget displays list of suggestions and enables to select or add those suggestions in the form of tags.

Inheritance

Constructors

FlutterTagging({@required FlutterTaggingCallBack onChanged, @required InputDecoration textFieldDecoration, @required SuggestionsCallback suggestionsCallback, @required Widget addButtonWidget, Icon deleteIcon: const Icon(Icons.cancel, size: 20.0), Color chipsColor, EdgeInsetsGeometry chipsPadding, double chipsFontSize, Color chipsFontColor, String chipsFontFamily, double chipsSpacing: 5.0, WidgetBuilder loadingBuilder, WidgetBuilder noItemsFoundBuilder, double animationStart: 0.25, Duration animationDuration: const Duration(milliseconds: 500), bool getImmediateSuggestions: false, double suggestionsBoxVerticalOffset: 5.0, AxisDirection direction: AxisDirection.down, bool hideOnLoading: false, bool hideOnEmpty: false, bool hideOnError: false, bool hideSuggestionsOnKeyboardHide: true, bool keepSuggestionsOnLoading: true, ErrorBuilder errorBuilder, SuggestionsBoxDecoration suggestionsBoxDecoration: const SuggestionsBoxDecoration(), AnimationTransitionBuilder transitionBuilder, Duration debounceDuration: const Duration(milliseconds: 300) })
Creates a FlutterTagging Widget

Properties

addButtonWidget Widget
A button Widget to be shown when new pattern is typed, which could be added to tag list.
final
animationDuration → Duration
final
animationStart → double
The value at which the transitionBuilder animation starts. [...]
final
chipsColor Color
A chipsColor is a Color to be used as chips background.
final
chipsFontColor Color
A chipsFontColor is a Color to be used as chips font color.
final
chipsFontFamily → String
Defines the font family String.
final
chipsFontSize → double
Defines the font size of chips with double value.
final
chipsPadding EdgeInsetsGeometry
A chipsPadding is a EdgeInsetsGeometry for defining chips padding.
final
chipsSpacing → double
Defines the spacing between chips with double value.
final
debounceDuration → Duration
The duration to wait after the user stops typing before calling suggestionsCallback [...]
final
deleteIcon Icon
A deleteIcon is an Icon used for deleting chips.
final
direction AxisDirection
Determine the SuggestionBox's direction. [...]
final
errorBuilder ErrorBuilder
Called when suggestionsCallback throws an exception. [...]
final
getImmediateSuggestions → bool
If set to true, suggestions will be fetched immediately when the field is added to the view. [...]
final
hideOnEmpty → bool
If set to true, nothing will be shown if there are no results. noItemsFoundBuilder will also be ignored. [...]
final
hideOnError → bool
If set to true, nothing will be shown if there is an error. errorBuilder will also be ignored. [...]
final
hideOnLoading → bool
If set to true, no loading box will be shown while suggestions are being fetched. loadingBuilder will also be ignored. [...]
final
hideSuggestionsOnKeyboardHide → bool
If set to false, the suggestions box will stay opened after the keyboard is closed. [...]
final
keepSuggestionsOnLoading → bool
If set to false, the suggestions box will show a circular progress indicator when retrieving suggestions. [...]
final
loadingBuilder WidgetBuilder
WidgetBuilder to build loading widget.
final
noItemsFoundBuilder WidgetBuilder
WidgetBuilder to build widget when no items are available.
final
onChanged FlutterTaggingCallBack
FlutterTaggingCallBack is callback for registering any change in output data.
final
suggestionsBoxDecoration SuggestionsBoxDecoration
The decoration of the material sheet that contains the suggestions. [...]
final
suggestionsBoxVerticalOffset → double
How far below the text field should the suggestions box be [...]
final
suggestionsCallback SuggestionsCallback
Called with the search pattern to get the search suggestions. [...]
final
textFieldDecoration InputDecoration
InputDecoration for TextField displayed by FlutterTagging Widget.
final
transitionBuilder AnimationTransitionBuilder
Called to display animations when suggestionsCallback returns suggestions [...]
final
hashCode → int
The hash code for this object.
read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createState() → _FlutterTaggingState
Creates the mutable state for this widget at a given location in the tree. [...]
override
createElement() StatefulElement
Creates a StatefulElement 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, inherited
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.debug }) → String
Returns 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 ==(dynamic other) → bool
The equality operator.
inherited