FlutterMentions class

Inheritance

Constructors

FlutterMentions({required List<Mention> mentions, Key? key, String? defaultText, SuggestionPosition suggestionPosition = SuggestionPosition.Bottom, double suggestionListHeight = 300.0, ValueChanged<String>? onMarkupChanged, dynamic onMentionAdd(Map<String, dynamic>)?, void onSearchChanged(String trigger, String value)?, List<Widget> leading = const [], List<Widget> trailing = const [], BoxDecoration? suggestionListDecoration, FocusNode? focusNode, InputDecoration decoration = const InputDecoration(), TextInputType? keyboardType, TextInputAction? textInputAction, TextCapitalization textCapitalization = TextCapitalization.none, TextStyle? style, StrutStyle? strutStyle, TextAlign textAlign = TextAlign.start, TextDirection? textDirection, bool autofocus = false, bool autocorrect = true, bool enableSuggestions = true, int maxLines = 1, int? minLines, bool expands = false, bool readOnly = false, bool? showCursor, int? maxLength, MaxLengthEnforcement maxLengthEnforcement = MaxLengthEnforcement.none, ValueChanged<String>? onChanged, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmitted, bool? enabled, double cursorWidth = 2.0, Radius? cursorRadius, Color? cursorColor, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(20.0), bool enableInteractiveSelection = true, GestureTapCallback? onTap, InputCounterWidgetBuilder? buildCounter, ScrollPhysics? scrollPhysics, ScrollController? scrollController, Iterable<String>? autofillHints, bool appendSpaceOnAdd = true, bool hideSuggestionList = false, dynamic onSuggestionVisibleChanged(bool)?})

Properties

appendSpaceOnAdd → bool
Should selecting a suggestion add a space at the end or not.
final
autocorrect → bool
Whether to enable autocorrection.
final
autofillHints → Iterable<String>?
A list of strings that helps the autofill service identify the type of this text input.
final
autofocus → bool
Whether this text field should focus itself if nothing else is already focused.
final
buildCounter → InputCounterWidgetBuilder?
Callback that generates a custom InputDecorator.counter widget.
final
cursorColor → Color?
The color to use when painting the cursor.
final
cursorRadius → Radius?
How rounded the corners of the cursor should be.
final
cursorWidth → double
How thick the cursor will be.
final
decoration → InputDecoration
The decoration to show around the text field.
final
defaultText → String?
default text for the Mention Input.
final
enabled → bool?
If false the text field is "disabled": it ignores taps and its decoration is rendered in grey.
final
enableInteractiveSelection → bool
Whether to enable user interface affordances for changing the text selection.
final
enableSuggestions → bool
final
expands → bool
Whether this widget's height will be sized to fill its parent.
final
focusNode → FocusNode?
Focus node for controlling the focus of the Input.
final
hashCode → int
The hash code for this object.
no setterinherited
hideSuggestionList → bool
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardAppearance → Brightness?
The appearance of the keyboard.
final
keyboardType → TextInputType?
The type of keyboard to use for editing the text.
final
leading → List<Widget>
Leading widgets to show before teh Input box, helps preseve the size size for the Portal widget size.
final
maxLength → int?
The maximum number of characters (Unicode scalar values) to allow in the text field.
final
maxLengthEnforcement → MaxLengthEnforcement
If true, prevents the field from allowing more than maxLength characters.
final
maxLines → int
The maximum number of lines to show at one time, wrapping if necessary.
final
mentions → List<Mention>
List of Mention that the user is allowed to triggered
final
minLines → int?
The minimum number of lines to occupy when the content spans fewer lines.
final
onChanged → ValueChanged<String>?
Called when the user initiates a change to the TextField's value: when they have inserted or deleted text.
final
onEditingComplete → VoidCallback?
Called when the user submits editable content (e.g., user presses the "done" button on the keyboard).
final
onMarkupChanged → ValueChanged<String>?
A Functioned which is triggered when ever the input changes but with the markup of the selected mentions
final
onMentionAdd → (dynamic Function(Map<String, dynamic>)?)
Triggers when the suggestion was added by tapping on suggestion.
final
onSearchChanged → (void Function(String trigger, String value)?)
final
onSubmitted → ValueChanged<String>?
Called when the user indicates that they are done editing the text in the field.
final
onSuggestionVisibleChanged → (dynamic Function(bool)?)
Triggers when the suggestion list visibility changed.
final
onTap → GestureTapCallback?
{@template flutter.material.textfield.onTap} Called for each distinct tap except for every second tap of a double tap.
final
readOnly → bool
Whether the text can be changed.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?
The ScrollController to use when vertically scrolling the input.
final
scrollPadding → EdgeInsets
Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view.
final
scrollPhysics → ScrollPhysics?
The ScrollPhysics to use when vertically scrolling the input.
final
selectionEnabled → bool
no setter
showCursor → bool?
Whether to show cursor.
final
strutStyle → StrutStyle?
The strut style used for the vertical layout.
final
style → TextStyle?
The style to use for the text being edited.
final
suggestionListDecoration → BoxDecoration?
Decoration for the Suggestion list.
final
suggestionListHeight → double
Max height for the suggestion list
final
suggestionPosition → SuggestionPosition
Suggestion modal position, can be alligned to top or bottom.
final
textAlign → TextAlign
How the text should be aligned horizontally.
final
textCapitalization → TextCapitalization
Configures how the platform keyboard will select an uppercase or lowercase keyboard.
final
textDirection → TextDirection?
The directionality of the text.
final
textInputAction → TextInputAction?
The type of action button to use for the keyboard.
final
trailing → List<Widget>
Trailing widgets to show before teh Input box, helps preseve the size size for the Portal widget size.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → FlutterMentionsState
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

Constants

noMaxLength → const int
If maxLength is set to this value, only the "current input length" part of the character counter is shown.