TMultiSelect<T, V, K> class

A multi-select dropdown field with search and tags support.

TMultiSelect combines a list selection UI with a tag-based input field. It supports:

  • Multiple item selection
  • Search/Filtering
  • Displaying selected items as tags
  • Async loading of items
  • Custom item rendering

Basic Usage

TMultiSelect<String, String, String>(
  label: 'Select Fruits',
  items: ['Apple', 'Banana', 'Orange'],
  onValueChanged: (selected) => print(selected),
)

With Custom Objects

TMultiSelect<User, String, String>(
  label: 'Assign Users',
  items: users,
  itemText: (user) => user.name,
  itemValue: (user) => user.id,
  onValueChanged: (ids) => updateUserAssignments(ids),
)

Type parameters:

  • T: The type of the item object
  • V: The type of the value to return (e.g. ID)
  • K: The type of the key used for uniqueness
Inheritance
Mixed-in types
Available extensions

Constructors

TMultiSelect({Key? key, String? label, String? tag, String? helperText, String? placeholder, String? info, bool isRequired = false, bool disabled = false, bool autoFocus = false, bool clearable = false, TTagsFieldTheme? theme, VoidCallback? onTap, FocusNode? focusNode, TTagsController? textController, List<V>? value, ValueNotifier<List<V>?>? valueNotifier, ValueChanged<List<V>?>? onValueChanged, List<String? Function(List<V>?)>? rules, Duration? validationDebounce, TListTheme? listTheme, List<T>? items, int? itemsPerPage, String? search, int? searchDelay, TLoadListener<T>? onLoad, TListController<T, K>? controller, TControllerReadyListener<T, K>? onControllerReady, VoidCallback? onShow, VoidCallback? onHide, TPopupMode? popupMode, bool filterable = true, ItemTextAccessor<T>? itemSubText, ItemTextAccessor<T>? itemImageUrl, ItemChildrenAccessor<T>? itemChildren, TListCardTheme? cardTheme, ItemValueAccessor<T, V>? itemValue, bool lazy = false, int? visibleItemsCount, ItemTextAccessor<T>? itemText, ItemKeyAccessor<T, K>? itemKey, bool? readOnly, ValueChanged<String>? onInputChanged})
const

Properties

addTagOnEnter → bool
Whether to add a tag when Enter is pressed.
no setteroverride
allowDuplicates → bool
Whether to allow duplicate tags.
no setteroverride
autoFocus → bool
Whether the field should autofocus.
final
cardTheme → TListCardTheme?
final
clearable → bool
Whether the field shows a clear button when it has a value.
final
controller → TListController<T, K>?
The controller managing the list state.
final
delimiters → List<String>
List of delimiters that trigger tag creation.
no setteroverride
disabled → bool
Whether the field is disabled.
final
filterable → bool
Whether to show a search bar in the dropdown.
final
focusNode → FocusNode?
Custom focus node.
final
hashCode → int
The hash code for this object.
no setterinherited
helperText → String?
The helper text.
final
info → String?
The info text (optional).
final
isRequired → bool
Whether the field is required.
final
itemChildren → ItemChildrenAccessor<T>?
final
itemImageUrl → ItemTextAccessor<T>?
final
itemKey → ItemKeyAccessor<T, K>?
Function to extract a unique key from an item.
final
items → List<T>?
The list of items to display.
final
itemsPerPage → int?
Number of items to display per page.
final
itemSubText → ItemTextAccessor<T>?
final
itemText → ItemTextAccessor<T>
final
itemValue → ItemValueAccessor<T, V>?
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → String?
The label text.
final
lazy → bool
final
listTheme → TListTheme?
final
offset → double
Offset from the target widget.
no setterinherited
onControllerReady → TControllerReadyListener<T, K>?
Callback fired when the list controller is initialized and ready for setup or binding.
final
onHide → VoidCallback?
Callback when popup hides.
final
onInputChanged → ValueChanged<String>?
Callback fired when the text input changes.
final
onLoad → TLoadListener<T>?
Callback for loading items from a server.
final
onShow → VoidCallback?
Callback when popup shows.
final
onTap → VoidCallback?
Callback for tap events.
final
onValueChanged → ValueChanged<List<V>?>?
Callback fired when the value changes.
final
placeholder → String?
Placeholder text.
final
popupAlignment → TPopupAlignment
Preferred alignment of the popup.
no setterinherited
popupMode → TPopupMode?
Preferred display mode of the popup.
final
readOnly → bool
Whether the field is read-only.
final
rules → List<String? Function(List<V>?)>?
List of validation rules.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
The current search query.
final
searchDelay → int?
Debounce delay for search in milliseconds.
final
showCloseButton → bool
Whether to show a close button in the popup.
no setterinherited
tag → String?
The tag text (optional).
final
textController → TTagsController?
Custom text controller.
final
theme → TTagsFieldTheme?
Custom theme.
final
validationDebounce → Duration?
Debounce duration for validation trigger.
final
value → List<V>?
The initial value.
final
valueNotifier → ValueNotifier<List<V>?>?
A ValueNotifier for two-way binding.
final
visibleItemsCount → int?
The number of items to show as visible in the dropdown before scrolling.
final

Methods

box({double minW = 0.0, double minH = 0.0, double maxW = double.infinity, double maxH = double.infinity}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a ConstrainedBox to apply layout constraints.
center({bool when = true}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Center widget.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<TMultiSelect<T, V, K>>
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
expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in an Expanded widget.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
padding([double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0]) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with flexible edge control.
paddingSymmetric({double h = 0.0, double v = 0.0}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with symmetric horizontal and vertical spacing.
size({double? w, double? h}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a SizedBox to apply fixed width and/or height.
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, int wrapWidth = 65}) → 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
validateValue(List<V>? value) → List<String>
Validates the given value against the rules.
inherited
visible(bool visible, {bool maintainState = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Visibility widget.
when(bool condition) → Widget

Available on Widget, provided by the WidgetX extension

Returns this widget if condition is true, otherwise returns SizedBox.shrink(). Usage: Text('Hello').when(isVisible)

Operators

operator ==(Object other) → bool
The equality operator.
inherited