ReactiveCupertinoTypeAhead<T, V> constructor

ReactiveCupertinoTypeAhead<T, V>({
  1. Key? key,
  2. String? formControlName,
  3. FormControl<T>? formControl,
  4. Map<String, ValidationMessageFunction>? validationMessages,
  5. ControlValueAccessor<T, V>? valueAccessor,
  6. ShowErrorsFunction<T>? showErrors,
  7. required String stringify(
    1. V value
    ),
  8. V viewDataTypeFromTextEditingValue(
    1. String
    )?,
  9. required SuggestionsCallback<V> suggestionsCallback,
  10. required ItemBuilder<V> itemBuilder,
  11. CupertinoSuggestionsBoxDecoration suggestionsBoxDecoration = const CupertinoSuggestionsBoxDecoration(),
  12. Duration debounceDuration = const Duration(milliseconds: 300),
  13. WidgetBuilder? loadingBuilder,
  14. WidgetBuilder? noItemsFoundBuilder,
  15. ErrorBuilder? errorBuilder,
  16. AnimationTransitionBuilder? transitionBuilder,
  17. double animationStart = 0.25,
  18. Duration animationDuration = const Duration(milliseconds: 500),
  19. bool getImmediateSuggestions = false,
  20. double suggestionsBoxVerticalOffset = 5.0,
  21. AxisDirection direction = AxisDirection.down,
  22. bool hideOnLoading = false,
  23. bool hideOnEmpty = false,
  24. bool hideOnError = false,
  25. bool hideSuggestionsOnKeyboardHide = true,
  26. bool keepSuggestionsOnLoading = true,
  27. bool keepSuggestionsOnSuggestionSelected = false,
  28. bool autoFlipDirection = false,
  29. bool hideKeyboard = false,
  30. CupertinoTextFieldConfiguration textFieldConfiguration = const CupertinoTextFieldConfiguration(),
  31. CupertinoSuggestionsBoxController? suggestionsBoxController,
  32. InputDecoration decoration = const InputDecoration(),
  33. TextInputType? keyboardType,
  34. TextCapitalization textCapitalization = TextCapitalization.none,
  35. TextInputAction? textInputAction,
  36. TextStyle? style,
  37. StrutStyle? strutStyle,
  38. TextDirection? textDirection,
  39. TextAlign textAlign = TextAlign.start,
  40. TextAlignVertical? textAlignVertical,
  41. bool autofocus = false,
  42. bool readOnly = false,
  43. bool? showCursor,
  44. bool obscureText = false,
  45. String obscuringCharacter = '•',
  46. bool autocorrect = true,
  47. bool enabled = true,
  48. SuggestionSelectionCallback<V>? onSuggestionSelected,
})

Creates a ReactiveCupertinoTypeAhead that contains a TextField.

Can optionally provide a formControl to bind this widget to a control.

Can optionally provide a formControlName to bind this ReactiveFormField to a FormControl.

Must provide one of the arguments formControl or a formControlName, but not both at the same time.

Can optionally provide a validationMessages argument to customize a message for different kinds of validation errors.

Can optionally provide a valueAccessor to set a custom value accessors. See ControlValueAccessor.

Can optionally provide a showErrors function to customize when to show validation messages. Reactive Widgets make validation messages visible when the control is INVALID and TOUCHED, this behavior can be customized in the showErrors function.

Example:

Binds a text field.

final form = fb.group({'email': Validators.required});

ReactiveCupertinoTypeAhead(
  formControlName: 'email',
),

Binds a text field directly with a FormControl.

final form = fb.group({'email': Validators.required});

ReactiveCupertinoTypeAhead(
  formControl: form.control('email'),
),

Customize validation messages

ReactiveCupertinoTypeAhead(
  formControlName: 'email',
  validationMessages: {
    ValidationMessage.required: 'The email must not be empty',
    ValidationMessage.email: 'The email must be a valid email',
  }
),

Customize when to show up validation messages.

ReactiveCupertinoTypeAhead(
  formControlName: 'email',
  showErrors: (control) => control.invalid && control.touched && control.dirty,
),

For documentation about the various parameters, see the TextField class and TextField, the constructor.

Implementation

ReactiveCupertinoTypeAhead({
  super.key,
  super.formControlName,
  super.formControl,
  super.validationMessages,
  super.valueAccessor,
  super.showErrors,
  required this.stringify,
  V Function(String)? viewDataTypeFromTextEditingValue,

  ////////////////////////////////////////////////////////////////////////////
  required SuggestionsCallback<V> suggestionsCallback,
  required ItemBuilder<V> itemBuilder,
  CupertinoSuggestionsBoxDecoration suggestionsBoxDecoration =
      const CupertinoSuggestionsBoxDecoration(),
  Duration debounceDuration = const Duration(milliseconds: 300),
  WidgetBuilder? loadingBuilder,
  WidgetBuilder? noItemsFoundBuilder,
  ErrorBuilder? errorBuilder,
  AnimationTransitionBuilder? transitionBuilder,
  double animationStart = 0.25,
  Duration animationDuration = const Duration(milliseconds: 500),
  bool getImmediateSuggestions = false,
  double suggestionsBoxVerticalOffset = 5.0,
  AxisDirection direction = AxisDirection.down,
  bool hideOnLoading = false,
  bool hideOnEmpty = false,
  bool hideOnError = false,
  bool hideSuggestionsOnKeyboardHide = true,
  bool keepSuggestionsOnLoading = true,
  bool keepSuggestionsOnSuggestionSelected = false,
  bool autoFlipDirection = false,
  bool hideKeyboard = false,
  CupertinoTextFieldConfiguration textFieldConfiguration =
      const CupertinoTextFieldConfiguration(),
  CupertinoSuggestionsBoxController? suggestionsBoxController,
  InputDecoration decoration = const InputDecoration(),
  TextInputType? keyboardType,
  TextCapitalization textCapitalization = TextCapitalization.none,
  TextInputAction? textInputAction,
  TextStyle? style,
  StrutStyle? strutStyle,
  TextDirection? textDirection,
  TextAlign textAlign = TextAlign.start,
  TextAlignVertical? textAlignVertical,
  bool autofocus = false,
  bool readOnly = false,
  bool? showCursor,
  bool obscureText = false,
  String obscuringCharacter = '•',
  bool autocorrect = true,
  bool enabled = true,
  SuggestionSelectionCallback<V>? onSuggestionSelected,
}) : super(
        builder: (field) {
          final state = field as _ReactiveCupertinoTypeAheadState<T, V>;
          final effectiveDecoration = textFieldConfiguration.decoration;

          state._setFocusNode(textFieldConfiguration.focusNode);
          final controller =
              textFieldConfiguration.controller ?? state._textController;

          return CupertinoTypeAheadFormField<V>(
            // initialValue: field.value,
            enabled: enabled,
            suggestionsCallback: suggestionsCallback,
            itemBuilder: itemBuilder,
            onSuggestionSelected: (value) {
              controller.text = stringify(value);
              field.didChange(value);
              onSuggestionSelected?.call(value);
            },
            textFieldConfiguration: textFieldConfiguration.copyWith(
              focusNode: textFieldConfiguration.focusNode ?? state.focusNode,
              controller: controller,
              decoration: effectiveDecoration,
              onChanged: (value) {
                if (viewDataTypeFromTextEditingValue != null) {
                  field.didChange(
                      viewDataTypeFromTextEditingValue.call(value));
                }
              },
            ),
            suggestionsBoxDecoration: suggestionsBoxDecoration,
            debounceDuration: debounceDuration,
            suggestionsBoxController: suggestionsBoxController,
            loadingBuilder: loadingBuilder,
            noItemsFoundBuilder: noItemsFoundBuilder,
            errorBuilder: errorBuilder,
            transitionBuilder: transitionBuilder,
            animationStart: animationStart,
            animationDuration: animationDuration,
            getImmediateSuggestions: getImmediateSuggestions,
            suggestionsBoxVerticalOffset: suggestionsBoxVerticalOffset,
            direction: direction,
            hideOnLoading: hideOnLoading,
            hideOnEmpty: hideOnEmpty,
            hideOnError: hideOnError,
            hideSuggestionsOnKeyboardHide: hideSuggestionsOnKeyboardHide,
            keepSuggestionsOnLoading: keepSuggestionsOnLoading,
            keepSuggestionsOnSuggestionSelected:
                keepSuggestionsOnSuggestionSelected,
            autoFlipDirection: autoFlipDirection,
          );
        },
      );