ReactiveCupertinoTypeAhead<T, V> constructor
- Key? key,
- String? formControlName,
- FormControl<
T> ? formControl, - Map<
String, ValidationMessageFunction> ? validationMessages, - ControlValueAccessor<
T, V> ? valueAccessor, - ShowErrorsFunction<
T> ? showErrors, - required String stringify(
- V value
- V 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,
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,
);
},
);