ControlledMultiSelect<T> constructor

const ControlledMultiSelect<T>({
  1. Key? key,
  2. MultiSelectController<T>? controller,
  3. ValueChanged<Iterable<T>?>? onChanged,
  4. bool enabled = true,
  5. Iterable<T>? initialValue,
  6. Widget? placeholder,
  7. Widget? leading,
  8. Widget? trailing,
  9. Widget? indicatorIcon,
  10. bool filled = false,
  11. FocusNode? focusNode,
  12. BoxConstraints? constraints,
  13. BoxConstraints? popupConstraints,
  14. PopoverConstraint popupWidthConstraint = PopoverConstraint.anchorFixedSize,
  15. BorderRadiusGeometry? borderRadius,
  16. EdgeInsetsGeometry? padding,
  17. AlignmentGeometry popoverAlignment = Alignment.topCenter,
  18. AlignmentGeometry? popoverAnchorAlignment,
  19. bool disableHoverEffect = false,
  20. bool canUnselect = true,
  21. bool autoClosePopover = false,
  22. Predicate<Iterable<T>>? showValuePredicate,
  23. Widget? expandIcon = const SelectExpandIcon(),
  24. required SelectPopupBuilder popup,
  25. required SelectValueBuilder<T> itemBuilder,
  26. SelectValueSelectionHandler<Iterable<T>>? valueSelectionHandler,
  27. SelectValueSelectionPredicate<Iterable<T>>? valueSelectionPredicate,
})

Creates a ControlledMultiSelect.

Either controller or onChanged should be provided for interactivity. The widget supports both controller-based and callback-based state management patterns with multiple item selection capabilities.

Parameters:

  • controller (MultiSelectController<T>?, optional): external state controller
  • initialValue (Iterable<T>?, optional): starting selection when no controller
  • onChanged (ValueChanged<Iterable<T>?>?, optional): selection change callback
  • enabled (bool, default: true): whether select is interactive
  • placeholder (Widget?, optional): widget shown when no items selected
  • leading (Widget?, optional): widget displayed before the selected values
  • trailing (Widget?, optional): widget displayed after the selected values
  • indicatorIcon (Widget?, optional): widget displayed as the dropdown indicator
  • filled (bool, default: false): whether to use filled appearance
  • focusNode (FocusNode?, optional): custom focus node for keyboard handling
  • constraints (BoxConstraints?, optional): size constraints for select widget
  • popupConstraints (BoxConstraints?, optional): size constraints for popup
  • popupWidthConstraint (PopoverConstraint, default: anchorFixedSize): popup width behavior
  • borderRadius (BorderRadiusGeometry?, optional): override select border radius
  • padding (EdgeInsetsGeometry?, optional): override internal padding
  • popoverAlignment (AlignmentGeometry, default: topCenter): popup alignment
  • popoverAnchorAlignment (AlignmentGeometry?, optional): anchor alignment
  • disableHoverEffect (bool, default: false): disable item hover effects
  • canUnselect (bool, default: false): allow deselecting all items
  • autoClosePopover (bool, default: false): close popup after each selection
  • popup (SelectPopupBuilder, required): builder for popup content
  • itemBuilder (SelectItemBuilder<T>, required): builder for individual items
  • multiItemBuilder (SelectValueBuilder<T>, required): builder for selected items display
  • valueSelectionHandler (SelectValueSelectionHandler<Iterable<T>>?, optional): custom selection logic
  • valueSelectionPredicate (SelectValueSelectionPredicate<Iterable<T>>?, optional): selection validation
  • showValuePredicate (Predicate<Iterable<T>>?, optional): visibility filter for values
  • expandIcon (Widget): The expand icon for the select, defaults to SelectExpandIcon widget

Example:

ControlledMultiSelect<String>(
  controller: controller,
  popup: (context, items) => ListView(children: items),
  itemBuilder: (context, item, selected) => CheckboxListTile(
    value: selected,
    title: Text(item),
  ),
  multiItemBuilder: (context, items) => Wrap(
    children: items.map((item) => Chip(label: Text(item))).toList(),
  ),
)

Implementation

const ControlledMultiSelect({
  super.key,
  this.controller,
  this.onChanged,
  this.enabled = true,
  this.initialValue,
  this.placeholder,
  this.leading,
  this.trailing,
  this.indicatorIcon,
  this.filled = false,
  this.focusNode,
  this.constraints,
  this.popupConstraints,
  this.popupWidthConstraint = PopoverConstraint.anchorFixedSize,
  this.borderRadius,
  this.padding,
  this.popoverAlignment = Alignment.topCenter,
  this.popoverAnchorAlignment,
  this.disableHoverEffect = false,
  this.canUnselect = true,
  this.autoClosePopover = false,
  this.showValuePredicate,
  this.expandIcon = const SelectExpandIcon(),
  required this.popup,
  required SelectValueBuilder<T> itemBuilder,
  this.valueSelectionHandler,
  this.valueSelectionPredicate,
}) : multiItemBuilder = itemBuilder;