CupertinoTextFormFieldRow class

Creates a CupertinoFormRow containing a FormField that wraps a CupertinoTextField.

A Form ancestor is not required. The Form allows one to save, reset, or validate multiple fields at once. To use without a Form, pass a GlobalKey to the constructor and use GlobalKey.currentState to save or reset the form field.

When a controller is specified, its TextEditingController.text defines the initialValue. If this FormField is part of a scrolling container that lazily constructs its children, like a ListView or a CustomScrollView, then a controller should be specified. The controller's lifetime should be managed by a stateful widget ancestor of the scrolling container.

The prefix parameter is displayed at the start of the row. Standard iOS guidelines encourage passing a Text widget to prefix to detail the nature of the input.

The padding parameter is used to pad the contents of the row. It is directly passed to CupertinoFormRow. If the padding parameter is null, CupertinoFormRow constructs its own default padding (which is the standard form row padding in iOS.) If no edge insets are intended, explicitly pass to padding.

If a controller is not specified, initialValue can be used to give the automatically generated controller an initial value.

Consider calling TextEditingController.dispose of the controller, if one is specified, when it is no longer needed. This will ensure we discard any resources used by the object.

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

Creates a CupertinoTextFormFieldRow with a leading text and validator function.

If the user enters valid text, the CupertinoTextField appears normally without any warnings to the user.

If the user enters invalid text, the error message returned from the validator function is displayed in dark red underneath the input.

  prefix: const Text('Username'),
  onSaved: (String? value) {
    // This optional block of code can be used to run
    // code when the user saves the form.
  validator: (String? value) {
    return (value != null && value.contains('@')) ? 'Do not use the @ char.' : null;

This example shows how to move the focus to the next field when the user presses the SPACE key.

To create a local project with this code sample, run:
flutter create --sample=cupertino.CupertinoTextFormFieldRow.2 mysample



CupertinoTextFormFieldRow({Key? key, Widget? prefix, EdgeInsetsGeometry? padding, TextEditingController? controller, String? initialValue, FocusNode? focusNode, BoxDecoration? decoration, 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, @Deprecated('Use `contextMenuBuilder` instead. ' 'This feature was deprecated after v3.3.0-0.5.pre.') ToolbarOptions? toolbarOptions, bool? showCursor, String obscuringCharacter = '•', bool obscureText = false, bool autocorrect = true, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions = true, int? maxLines = 1, int? minLines, bool expands = false, int? maxLength, ValueChanged<String>? onChanged, GestureTapCallback? onTap, VoidCallback? onEditingComplete, ValueChanged<String>? onFieldSubmitted, FormFieldSetter<String>? onSaved, FormFieldValidator<String>? validator, List<TextInputFormatter>? inputFormatters, bool? enabled, double cursorWidth = 2.0, double? cursorHeight, Color? cursorColor, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(20.0), bool enableInteractiveSelection = true, TextSelectionControls? selectionControls, ScrollPhysics? scrollPhysics, Iterable<String>? autofillHints, AutovalidateMode autovalidateMode = AutovalidateMode.disabled, String? placeholder, TextStyle? placeholderStyle = const TextStyle(fontWeight: FontWeight.w400, color: CupertinoColors.placeholderText), EditableTextContextMenuBuilder? contextMenuBuilder = _defaultContextMenuBuilder, String? restorationId})
Creates a CupertinoFormRow containing a FormField that wraps a CupertinoTextField.


autovalidateMode AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
builder FormFieldBuilder<String>
Function that returns the widget representing this form field. It is passed the form field state as input, containing the current value and validation state of this field.
controller TextEditingController?
Controls the text being edited.
enabled bool
Whether the form is able to receive user input.
hashCode int
The hash code for this object.
no setterinherited
initialValue String?
An optional value to initialize the form field to, or null otherwise.
key Key?
Controls how one widget replaces another widget in the tree.
onChanged ValueChanged<String>?
Called when the user initiates a change to the TextField's value: when they have inserted or deleted text or reset the form.
onSaved FormFieldSetter<String>?
An optional method to call with the final value when the form is saved via
padding EdgeInsetsGeometry?
Content padding for the row.
prefix Widget?
A widget that is displayed at the start of the row.
restorationId String?
Restoration ID to save and restore the state of the form field.
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
validator FormFieldValidator<String>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.


createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
createState() FormFieldState<String>
Creates the mutable state for this widget at a given location in the tree.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel =}) String
A string representation of this object.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
toStringShort() String
A short, textual description of this widget.


operator ==(Object other) bool
The equality operator.