FMultiSelect<T> constructor

FMultiSelect<T>({
  1. required Map<String, T> items,
  2. FMultiValueControl<T>? control,
  3. FPopoverControl popoverControl = const .managed(),
  4. FTextFieldSizeVariant size = .md,
  5. FMultiSelectStyleDelta style = const .context(),
  6. bool autofocus = false,
  7. FocusNode? focusNode,
  8. FFieldIconBuilder<FMultiSelectFieldStyle>? prefixBuilder,
  9. FFieldIconBuilder<FMultiSelectFieldStyle>? suffixBuilder = defaultIconBuilder,
  10. Widget? label,
  11. Widget? description,
  12. bool enabled = true,
  13. void onSaved(
    1. Set<T> values
    )?,
  14. VoidCallback? onReset,
  15. AutovalidateMode autovalidateMode = .onUnfocus,
  16. String? forceErrorText,
  17. String? validator(
    1. Set<T> values
    ) = FFormFieldProperties.defaultValidator,
  18. Widget errorBuilder(
    1. BuildContext context,
    2. String message
    ) = FFormFieldProperties.defaultErrorBuilder,
  19. Widget? hint,
  20. bool keepHint = true,
  21. int sort(
    1. T a,
    2. T b
    )?,
  22. FMultiSelectTagBuilder<T>? tagBuilder,
  23. TextAlign textAlign = .start,
  24. TextDirection? textDirection,
  25. bool clearable = false,
  26. FMultiSelectPopoverBuilder<T> popoverBuilder = FPopover.defaultPopoverBuilder,
  27. AlignmentGeometry contentAnchor = .topStart,
  28. AlignmentGeometry fieldAnchor = .bottomStart,
  29. FPortalConstraints contentConstraints = const FAutoWidthPortalConstraints(maxHeight: 300),
  30. FPortalSpacing contentSpacing = const .spacing(4),
  31. FPortalOverflow contentOverflow = .flip,
  32. bool contentUseViewPadding = true,
  33. bool contentUseViewInsets = true,
  34. Offset contentOffset = .zero,
  35. FPopoverHideRegion contentHideRegion = .excludeChild,
  36. Object? contentGroupId,
  37. bool contentCutout = true,
  38. void contentCutoutBuilder(
    1. Path path,
    2. Rect bounds
    ) = FModalBarrier.defaultCutoutBuilder,
  39. Widget contentEmptyBuilder(
    1. BuildContext context,
    2. FMultiSelectStyle style
    ) = FMultiSelect.defaultContentEmptyBuilder,
  40. ScrollController? contentScrollController,
  41. bool contentScrollHandles = false,
  42. ScrollPhysics contentPhysics = const ClampingScrollPhysics(),
  43. FItemDivider contentDivider = .none,
  44. Key? formFieldKey,
  45. Key? key,
})

Creates a FMultiSelect from the given items.

For more control over the appearance of items, use FMultiSelect.rich.

Contract

Each key in items must map to a unique value. Having multiple keys map to the same value will result in undefined behavior.

Implementation

factory FMultiSelect({
  required Map<String, T> items,
  FMultiValueControl<T>? control,
  FPopoverControl popoverControl = const .managed(),
  FTextFieldSizeVariant size = .md,
  FMultiSelectStyleDelta style = const .context(),
  bool autofocus = false,
  FocusNode? focusNode,
  FFieldIconBuilder<FMultiSelectFieldStyle>? prefixBuilder,
  FFieldIconBuilder<FMultiSelectFieldStyle>? suffixBuilder = defaultIconBuilder,
  Widget? label,
  Widget? description,
  bool enabled = true,
  void Function(Set<T> values)? onSaved,
  VoidCallback? onReset,
  AutovalidateMode autovalidateMode = .onUnfocus,
  String? forceErrorText,
  String? Function(Set<T> values) validator = FFormFieldProperties.defaultValidator,
  Widget Function(BuildContext context, String message) errorBuilder = FFormFieldProperties.defaultErrorBuilder,
  Widget? hint,
  bool keepHint = true,
  int Function(T a, T b)? sort,
  FMultiSelectTagBuilder<T>? tagBuilder,
  TextAlign textAlign = .start,
  TextDirection? textDirection,
  bool clearable = false,
  FMultiSelectPopoverBuilder<T> popoverBuilder = FPopover.defaultPopoverBuilder,
  AlignmentGeometry contentAnchor = .topStart,
  AlignmentGeometry fieldAnchor = .bottomStart,
  FPortalConstraints contentConstraints = const FAutoWidthPortalConstraints(maxHeight: 300),
  FPortalSpacing contentSpacing = const .spacing(4),
  FPortalOverflow contentOverflow = .flip,
  bool contentUseViewPadding = true,
  bool contentUseViewInsets = true,
  Offset contentOffset = .zero,
  FPopoverHideRegion contentHideRegion = .excludeChild,
  Object? contentGroupId,
  bool contentCutout = true,
  void Function(Path path, Rect bounds) contentCutoutBuilder = FModalBarrier.defaultCutoutBuilder,
  Widget Function(BuildContext context, FMultiSelectStyle style) contentEmptyBuilder =
      FMultiSelect.defaultContentEmptyBuilder,
  ScrollController? contentScrollController,
  bool contentScrollHandles = false,
  ScrollPhysics contentPhysics = const ClampingScrollPhysics(),
  FItemDivider contentDivider = .none,
  Key? formFieldKey,
  Key? key,
}) {
  final inverse = {for (final MapEntry(:key, :value) in items.entries) value: key};
  return .rich(
    control: control,
    popoverControl: popoverControl,
    size: size,
    style: style,
    autofocus: autofocus,
    focusNode: focusNode,
    prefixBuilder: prefixBuilder,
    suffixBuilder: suffixBuilder,
    label: label,
    description: description,
    format: (value) => Text(inverse[value] ?? ''),
    sort: sort,
    tagBuilder: tagBuilder,
    enabled: enabled,
    onSaved: onSaved,
    onReset: onReset,
    autovalidateMode: autovalidateMode,
    forceErrorText: forceErrorText,
    validator: validator,
    errorBuilder: errorBuilder,
    hint: hint,
    keepHint: keepHint,
    textAlign: textAlign,
    textDirection: textDirection,
    clearable: clearable,
    popoverBuilder: popoverBuilder,
    contentAnchor: contentAnchor,
    fieldAnchor: fieldAnchor,
    contentConstraints: contentConstraints,
    contentSpacing: contentSpacing,
    contentOverflow: contentOverflow,
    contentUseViewPadding: contentUseViewPadding,
    contentUseViewInsets: contentUseViewInsets,
    contentOffset: contentOffset,
    contentHideRegion: contentHideRegion,
    contentGroupId: contentGroupId,
    contentCutout: contentCutout,
    contentCutoutBuilder: contentCutoutBuilder,
    contentEmptyBuilder: contentEmptyBuilder,
    contentScrollController: contentScrollController,
    contentScrollHandles: contentScrollHandles,
    contentPhysics: contentPhysics,
    contentDivider: contentDivider,
    formFieldKey: formFieldKey,
    key: key,
    children: [for (final MapEntry(:key, :value) in items.entries) .item(title: Text(key), value: value)],
  );
}