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,
    2. FSelectSearchStyle
    ) = FSelect.defaultContentLoadingBuilder,
  5. Widget contentErrorBuilder(
    1. BuildContext,
    2. Object?,
    3. StackTrace
    )?,
  6. FSelectController<T>? controller,
  7. FSelectStyle style(
    1. FSelectStyle
    )?,
  8. bool autofocus = false,
  9. FocusNode? focusNode,
  10. FFieldBuilder<FSelectStyle> builder = _fieldBuilder,
  11. FFieldIconBuilder<FSelectStyle>? prefixBuilder,
  12. FFieldIconBuilder<FSelectStyle>? suffixBuilder = defaultIconBuilder,
  13. Widget? label,
  14. Widget? description,
  15. bool enabled = true,
  16. ValueChanged<T?>? onChange,
  17. FormFieldSetter<T>? onSaved,
  18. AutovalidateMode autovalidateMode = AutovalidateMode.onUnfocus,
  19. String? forceErrorText,
  20. FormFieldValidator<T> validator = _defaultValidator,
  21. Widget errorBuilder(
    1. BuildContext,
    2. String
    ) = FFormFieldProperties.defaultErrorBuilder,
  22. String? hint,
  23. TextAlign textAlign = TextAlign.start,
  24. TextAlignVertical? textAlignVertical,
  25. TextDirection? textDirection,
  26. bool expands = false,
  27. MouseCursor mouseCursor = SystemMouseCursors.click,
  28. bool canRequestFocus = true,
  29. bool clearable = false,
  30. AlignmentGeometry anchor = AlignmentDirectional.topStart,
  31. AlignmentGeometry fieldAnchor = AlignmentDirectional.bottomStart,
  32. FPortalConstraints popoverConstraints = const FAutoWidthPortalConstraints(maxHeight: 300),
  33. FPortalSpacing spacing = const FPortalSpacing(4),
  34. Offset shift(
    1. Size,
    2. FPortalChildBox,
    3. FPortalBox
    ) = FPortalShift.flip,
  35. Offset offset = Offset.zero,
  36. FPopoverHideRegion hideRegion = FPopoverHideRegion.excludeChild,
  37. bool autoHide = true,
  38. Widget contentEmptyBuilder(
    1. BuildContext,
    2. FSelectStyle
    ) = defaultContentEmptyBuilder,
  39. ScrollController? contentScrollController,
  40. bool contentScrollHandles = false,
  41. ScrollPhysics contentPhysics = const ClampingScrollPhysics(),
  42. FItemDivider contentDivider = FItemDivider.none,
  43. T? initialValue,
  44. 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, FSelectSearchStyle) contentLoadingBuilder = FSelect.defaultContentLoadingBuilder,
  Widget Function(BuildContext, Object?, StackTrace)? contentErrorBuilder,
  FSelectController<T>? controller,
  FSelectStyle Function(FSelectStyle)? style,
  bool autofocus = false,
  FocusNode? focusNode,
  FFieldBuilder<FSelectStyle> builder = _fieldBuilder,
  FFieldIconBuilder<FSelectStyle>? prefixBuilder,
  FFieldIconBuilder<FSelectStyle>? suffixBuilder = defaultIconBuilder,
  Widget? label,
  Widget? description,
  bool enabled = true,
  ValueChanged<T?>? onChange,
  FormFieldSetter<T>? onSaved,
  AutovalidateMode autovalidateMode = AutovalidateMode.onUnfocus,
  String? forceErrorText,
  FormFieldValidator<T> validator = _defaultValidator,
  Widget Function(BuildContext, String) errorBuilder = FFormFieldProperties.defaultErrorBuilder,
  String? hint,
  TextAlign textAlign = TextAlign.start,
  TextAlignVertical? textAlignVertical,
  TextDirection? textDirection,
  bool expands = false,
  MouseCursor mouseCursor = SystemMouseCursors.click,
  bool canRequestFocus = true,
  bool clearable = false,
  AlignmentGeometry anchor = AlignmentDirectional.topStart,
  AlignmentGeometry fieldAnchor = AlignmentDirectional.bottomStart,
  FPortalConstraints popoverConstraints = const FAutoWidthPortalConstraints(maxHeight: 300),
  FPortalSpacing spacing = const FPortalSpacing(4),
  Offset Function(Size, FPortalChildBox, FPortalBox) shift = FPortalShift.flip,
  Offset offset = Offset.zero,
  FPopoverHideRegion hideRegion = FPopoverHideRegion.excludeChild,
  bool autoHide = true,
  Widget Function(BuildContext, FSelectStyle) contentEmptyBuilder = defaultContentEmptyBuilder,
  ScrollController? contentScrollController,
  bool contentScrollHandles = false,
  ScrollPhysics contentPhysics = const ClampingScrollPhysics(),
  FItemDivider contentDivider = FItemDivider.none,
  T? initialValue,
  Key? key,
}) {
  final inverse = {for (final MapEntry(:key, :value) in items.entries) value: key};
  return FSelect<T>.searchBuilder(
    format: (value) => 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) FSelectItem<T>(title: Text(inverse[value]!), value: value),
    ],
    searchFieldProperties: searchFieldProperties,
    contentLoadingBuilder: contentLoadingBuilder,
    contentErrorBuilder: contentErrorBuilder,
    controller: controller,
    style: style,
    autofocus: autofocus,
    focusNode: focusNode,
    builder: builder,
    prefixBuilder: prefixBuilder,
    suffixBuilder: suffixBuilder,
    label: label,
    description: description,
    enabled: enabled,
    onChange: onChange,
    onSaved: onSaved,
    autovalidateMode: autovalidateMode,
    forceErrorText: forceErrorText,
    validator: validator,
    errorBuilder: errorBuilder,
    hint: hint,
    textAlign: textAlign,
    textAlignVertical: textAlignVertical,
    textDirection: textDirection,
    expands: expands,
    mouseCursor: mouseCursor,
    canRequestFocus: canRequestFocus,
    clearable: clearable,
    anchor: anchor,
    fieldAnchor: fieldAnchor,
    popoverConstraints: popoverConstraints,
    spacing: spacing,
    shift: shift,
    offset: offset,
    hideRegion: hideRegion,
    autoHide: autoHide,
    contentEmptyBuilder: contentEmptyBuilder,
    contentScrollController: contentScrollController,
    contentScrollHandles: contentScrollHandles,
    contentPhysics: contentPhysics,
    contentDivider: contentDivider,
    initialValue: initialValue,
    key: key,
  );
}