FSelect<T>.search constructor

FSelect<T>.search({
  1. required 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
    ) = FSelect.defaultContentLoadingBuilder,
  5. Widget contentErrorBuilder(
    1. BuildContext context,
    2. Object? error,
    3. StackTrace stackTrace
    )?,
  6. FSelectControl<T>? control,
  7. FPopoverControl popoverControl = const .managed(),
  8. FSelectStyle style(
    1. FSelectStyle style
    )?,
  9. bool autofocus = false,
  10. FocusNode? focusNode,
  11. FFieldBuilder<FSelectStyle> builder = _fieldBuilder,
  12. FFieldIconBuilder<FSelectStyle>? prefixBuilder,
  13. FFieldIconBuilder<FSelectStyle>? suffixBuilder = defaultIconBuilder,
  14. Widget? label,
  15. Widget? description,
  16. bool enabled = true,
  17. FormFieldSetter<T>? onSaved,
  18. VoidCallback? onReset,
  19. AutovalidateMode autovalidateMode = .onUnfocus,
  20. String? forceErrorText,
  21. FormFieldValidator<T> validator = _defaultValidator,
  22. Widget errorBuilder(
    1. BuildContext context,
    2. String message
    ) = FFormFieldProperties.defaultErrorBuilder,
  23. String? hint,
  24. TextAlign textAlign = .start,
  25. TextAlignVertical? textAlignVertical,
  26. TextDirection? textDirection,
  27. bool expands = false,
  28. MouseCursor mouseCursor = .defer,
  29. bool canRequestFocus = true,
  30. bool clearable = false,
  31. AlignmentGeometry contentAnchor = AlignmentDirectional.topStart,
  32. AlignmentGeometry fieldAnchor = AlignmentDirectional.bottomStart,
  33. FPortalConstraints contentConstraints = const FAutoWidthPortalConstraints(maxHeight: 300),
  34. FPortalSpacing contentSpacing = const .spacing(4),
  35. FPortalOverflow contentOverflow = .flip,
  36. Offset contentOffset = .zero,
  37. FPopoverHideRegion contentHideRegion = .excludeChild,
  38. Object? contentGroupId,
  39. bool autoHide = true,
  40. Widget contentEmptyBuilder(
    1. BuildContext context,
    2. FSelectStyle style
    ) = defaultContentEmptyBuilder,
  41. ScrollController? contentScrollController,
  42. @Deprecated('Usage of scroll handles seem to be low while its maintenance burden far outweighs its benefits. Please open an issue at https://github.com/duobaseio/forui/issues if you use it and think otherwise.') bool contentScrollHandles = false,
  43. ScrollPhysics contentPhysics = const ClampingScrollPhysics(),
  44. FItemDivider contentDivider = .none,
  45. 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 FSelect.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 FSelect.search({
  required Map<String, T> items,
  FutureOr<Iterable<T>> Function(String query)? filter,
  FSelectSearchFieldProperties searchFieldProperties = const FSelectSearchFieldProperties(),
  Widget Function(BuildContext context, FSelectSearchStyle style) contentLoadingBuilder =
      FSelect.defaultContentLoadingBuilder,
  Widget Function(BuildContext context, Object? error, StackTrace stackTrace)? contentErrorBuilder,
  FSelectControl<T>? control,
  FPopoverControl popoverControl = const .managed(),
  FSelectStyle Function(FSelectStyle style)? style,
  bool autofocus = false,
  FocusNode? focusNode,
  FFieldBuilder<FSelectStyle> builder = _fieldBuilder,
  FFieldIconBuilder<FSelectStyle>? prefixBuilder,
  FFieldIconBuilder<FSelectStyle>? suffixBuilder = defaultIconBuilder,
  Widget? label,
  Widget? description,
  bool enabled = true,
  FormFieldSetter<T>? onSaved,
  VoidCallback? onReset,
  AutovalidateMode autovalidateMode = .onUnfocus,
  String? forceErrorText,
  FormFieldValidator<T> validator = _defaultValidator,
  Widget Function(BuildContext context, String message) errorBuilder = FFormFieldProperties.defaultErrorBuilder,
  String? hint,
  TextAlign textAlign = .start,
  TextAlignVertical? textAlignVertical,
  TextDirection? textDirection,
  bool expands = false,
  MouseCursor mouseCursor = .defer,
  bool canRequestFocus = true,
  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,
  bool autoHide = true,
  Widget Function(BuildContext context, FSelectStyle style) contentEmptyBuilder = defaultContentEmptyBuilder,
  ScrollController? contentScrollController,
  @Deprecated(
    'Usage of scroll handles seem to be low while its maintenance burden far outweighs its benefits. Please open an issue at https://github.com/duobaseio/forui/issues if you use it and think otherwise.',
  )
  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) => inverse[value]!,
    filter:
        filter ??
        (query) => [
          for (final MapEntry(:key, :value) in items.entries)
            if (key.toLowerCase().startsWith(query.toLowerCase())) value,
        ],
    contentBuilder: (context, _, values) => [
      for (final value in values) .item(title: Text(inverse[value]!), value: value),
    ],
    searchFieldProperties: searchFieldProperties,
    contentLoadingBuilder: contentLoadingBuilder,
    contentErrorBuilder: contentErrorBuilder,
    control: control,
    popoverControl: popoverControl,
    style: style,
    autofocus: autofocus,
    focusNode: focusNode,
    builder: builder,
    prefixBuilder: prefixBuilder,
    suffixBuilder: suffixBuilder,
    label: label,
    description: description,
    enabled: enabled,
    onSaved: onSaved,
    onReset: onReset,
    autovalidateMode: autovalidateMode,
    forceErrorText: forceErrorText,
    validator: validator,
    errorBuilder: errorBuilder,
    hint: hint,
    textAlign: textAlign,
    textAlignVertical: textAlignVertical,
    textDirection: textDirection,
    expands: expands,
    mouseCursor: mouseCursor,
    canRequestFocus: canRequestFocus,
    clearable: clearable,
    contentAnchor: contentAnchor,
    fieldAnchor: fieldAnchor,
    contentConstraints: contentConstraints,
    contentSpacing: contentSpacing,
    contentOverflow: contentOverflow,
    contentOffset: contentOffset,
    contentHideRegion: contentHideRegion,
    contentGroupId: contentGroupId,
    autoHide: autoHide,
    contentEmptyBuilder: contentEmptyBuilder,
    contentScrollController: contentScrollController,
    contentScrollHandles: contentScrollHandles,
    contentPhysics: contentPhysics,
    contentDivider: contentDivider,
    key: key,
  );
}