FMultiSelect<T>.search constructor

FMultiSelect<T>.search(
  1. Map<String, T> items, {
  2. FutureOr<Iterable<T>> filter(
    1. String query
    )?,
  3. FSelectSearchFieldProperties searchFieldProperties = const FSelectSearchFieldProperties(),
  4. Widget contentLoadingBuilder(
    1. BuildContext context,
    2. FSelectSearchStyle style
    ) = FMultiSelect.defaultContentLoadingBuilder,
  5. Widget contentErrorBuilder(
    1. BuildContext context,
    2. Object? error,
    3. StackTrace stackTrace
    )?,
  6. FMultiValueControl<T>? control,
  7. FPopoverControl popoverControl = const .managed(),
  8. FMultiSelectStyle style(
    1. FMultiSelectStyle style
    )?,
  9. bool autofocus = false,
  10. FocusNode? focusNode,
  11. FFieldIconBuilder<FMultiSelectStyle>? prefixBuilder,
  12. FFieldIconBuilder<FMultiSelectStyle>? suffixBuilder = defaultIconBuilder,
  13. Widget? label,
  14. Widget? description,
  15. bool enabled = true,
  16. void onSaved(
    1. Set<T> values
    )?,
  17. VoidCallback? onReset,
  18. AutovalidateMode autovalidateMode = .onUnfocus,
  19. String? forceErrorText,
  20. String? validator(
    1. Set<T> values
    ) = _defaultValidator,
  21. Widget errorBuilder(
    1. BuildContext context,
    2. String message
    ) = FFormFieldProperties.defaultErrorBuilder,
  22. Widget? hint,
  23. bool keepHint = true,
  24. int sort(
    1. T,
    2. T
    )?,
  25. FMultiSelectTagBuilder<T>? tagBuilder,
  26. TextAlign textAlign = .start,
  27. TextDirection? textDirection,
  28. bool clearable = false,
  29. AlignmentGeometry contentAnchor = AlignmentDirectional.topStart,
  30. AlignmentGeometry fieldAnchor = AlignmentDirectional.bottomStart,
  31. FPortalConstraints contentConstraints = const FAutoWidthPortalConstraints(maxHeight: 300),
  32. FPortalSpacing contentSpacing = const .spacing(4),
  33. FPortalOverflow contentOverflow = .flip,
  34. Offset contentOffset = .zero,
  35. FPopoverHideRegion contentHideRegion = .excludeChild,
  36. Object? contentGroupId,
  37. Widget contentEmptyBuilder(
    1. BuildContext context,
    2. FMultiSelectStyle style
    ) = defaultContentEmptyBuilder,
  38. ScrollController? contentScrollController,
  39. bool contentScrollHandles = false,
  40. ScrollPhysics contentPhysics = const ClampingScrollPhysics(),
  41. FItemDivider contentDivider = .none,
  42. Key? key,
})

Creates a searchable select with dynamic content based on the given items and search input.

The searchFieldProperties can be used to customize the search field.

The filter callback produces a list of items based on the search query. Defaults to returning items that start with the query string. The contentLoadingBuilder is used to show a loading indicator while the search results is processed asynchronously by filter. The contentErrorBuilder is used to show an error message when filter is asynchronous and fails.

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

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.search(
  Map<String, T> items, {
  FutureOr<Iterable<T>> Function(String query)? filter,
  FSelectSearchFieldProperties searchFieldProperties = const FSelectSearchFieldProperties(),
  Widget Function(BuildContext context, FSelectSearchStyle style) contentLoadingBuilder =
      FMultiSelect.defaultContentLoadingBuilder,
  Widget Function(BuildContext context, Object? error, StackTrace stackTrace)? contentErrorBuilder,
  FMultiValueControl<T>? control,
  FPopoverControl popoverControl = const .managed(),
  FMultiSelectStyle Function(FMultiSelectStyle style)? style,
  bool autofocus = false,
  FocusNode? focusNode,
  FFieldIconBuilder<FMultiSelectStyle>? prefixBuilder,
  FFieldIconBuilder<FMultiSelectStyle>? 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 = _defaultValidator,
  Widget Function(BuildContext context, String message) errorBuilder = FFormFieldProperties.defaultErrorBuilder,
  Widget? hint,
  bool keepHint = true,
  int Function(T, T)? sort,
  FMultiSelectTagBuilder<T>? tagBuilder,
  TextAlign textAlign = .start,
  TextDirection? textDirection,
  bool clearable = false,
  AlignmentGeometry contentAnchor = AlignmentDirectional.topStart,
  AlignmentGeometry fieldAnchor = AlignmentDirectional.bottomStart,
  FPortalConstraints contentConstraints = const FAutoWidthPortalConstraints(maxHeight: 300),
  FPortalSpacing contentSpacing = const .spacing(4),
  FPortalOverflow contentOverflow = .flip,
  Offset contentOffset = .zero,
  FPopoverHideRegion contentHideRegion = .excludeChild,
  Object? contentGroupId,
  Widget Function(BuildContext context, FMultiSelectStyle style) contentEmptyBuilder = defaultContentEmptyBuilder,
  ScrollController? contentScrollController,
  bool contentScrollHandles = false,
  ScrollPhysics contentPhysics = const ClampingScrollPhysics(),
  FItemDivider contentDivider = .none,
  Key? key,
}) {
  final inverse = {for (final MapEntry(:key, :value) in items.entries) value: key};
  return .searchBuilder(
    format: (value) => Text(inverse[value] ?? ''),
    filter:
        filter ??
        (query) => items.entries
            .where((entry) => entry.key.toLowerCase().startsWith(query.toLowerCase()))
            .map((entry) => entry.value)
            .toList(),
    contentBuilder: (context, _, values) => [
      for (final value in values) .item<T>(title: Text(inverse[value]!), value: value),
    ],
    searchFieldProperties: searchFieldProperties,
    contentLoadingBuilder: contentLoadingBuilder,
    contentErrorBuilder: contentErrorBuilder,
    control: control,
    popoverControl: popoverControl,
    style: style,
    autofocus: autofocus,
    focusNode: focusNode,
    prefixBuilder: prefixBuilder,
    suffixBuilder: suffixBuilder,
    label: label,
    description: description,
    enabled: enabled,
    onSaved: onSaved,
    onReset: onReset,
    autovalidateMode: autovalidateMode,
    forceErrorText: forceErrorText,
    validator: validator,
    errorBuilder: errorBuilder,
    hint: hint,
    keepHint: keepHint,
    sort: sort,
    tagBuilder: tagBuilder,
    textAlign: textAlign,
    textDirection: textDirection,
    clearable: clearable,
    contentAnchor: contentAnchor,
    fieldAnchor: fieldAnchor,
    contentConstraints: contentConstraints,
    contentSpacing: contentSpacing,
    contentOverflow: contentOverflow,
    contentOffset: contentOffset,
    contentHideRegion: contentHideRegion,
    contentGroupId: contentGroupId,
    contentEmptyBuilder: contentEmptyBuilder,
    contentScrollController: contentScrollController,
    contentScrollHandles: contentScrollHandles,
    contentPhysics: contentPhysics,
    contentDivider: contentDivider,
    key: key,
  );
}