TextField constructor

const TextField({
  1. Key? key,
  2. Object groupId = EditableText,
  3. TextEditingController? controller,
  4. String? initialValue,
  5. FocusNode? focusNode,
  6. UndoHistoryController? undoController,
  7. BoxDecoration? decoration,
  8. EdgeInsetsGeometry? padding,
  9. Widget? placeholder,
  10. CrossAxisAlignment crossAxisAlignment = CrossAxisAlignment.center,
  11. String? clearButtonSemanticLabel,
  12. TextInputType? keyboardType,
  13. TextInputAction? textInputAction,
  14. TextCapitalization textCapitalization = TextCapitalization.none,
  15. TextStyle? style,
  16. StrutStyle? strutStyle,
  17. TextAlign textAlign = TextAlign.start,
  18. TextAlignVertical? textAlignVertical,
  19. TextDirection? textDirection,
  20. bool readOnly = false,
  21. bool? showCursor,
  22. bool autofocus = false,
  23. String obscuringCharacter = '•',
  24. bool obscureText = false,
  25. bool autocorrect = true,
  26. SmartDashesType smartDashesType = SmartDashesType.enabled,
  27. SmartQuotesType smartQuotesType = SmartQuotesType.enabled,
  28. bool enableSuggestions = true,
  29. int? maxLines = 1,
  30. int? minLines,
  31. bool expands = false,
  32. int? maxLength,
  33. MaxLengthEnforcement? maxLengthEnforcement,
  34. ValueChanged<String>? onChanged,
  35. VoidCallback? onEditingComplete,
  36. ValueChanged<String>? onSubmitted,
  37. TapRegionCallback? onTapOutside,
  38. TapRegionCallback? onTapUpOutside,
  39. List<TextInputFormatter>? inputFormatters,
  40. bool enabled = true,
  41. double cursorWidth = 2.0,
  42. double? cursorHeight,
  43. Radius cursorRadius = const Radius.circular(2.0),
  44. bool cursorOpacityAnimates = true,
  45. Color? cursorColor,
  46. BoxHeightStyle selectionHeightStyle = ui.BoxHeightStyle.tight,
  47. BoxWidthStyle selectionWidthStyle = ui.BoxWidthStyle.tight,
  48. Brightness? keyboardAppearance,
  49. EdgeInsets scrollPadding = const EdgeInsets.all(20.0),
  50. bool enableInteractiveSelection = true,
  51. TextSelectionControls? selectionControls,
  52. DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  53. ScrollController? scrollController,
  54. ScrollPhysics? scrollPhysics,
  55. GestureTapCallback? onTap,
  56. Iterable<String>? autofillHints = const [],
  57. Clip clipBehavior = Clip.hardEdge,
  58. String? restorationId,
  59. bool stylusHandwritingEnabled = EditableText.defaultStylusHandwritingEnabled,
  60. bool enableIMEPersonalizedLearning = true,
  61. ContentInsertionConfiguration? contentInsertionConfiguration,
  62. EditableTextContextMenuBuilder? contextMenuBuilder = defaultContextMenuBuilder,
  63. String? hintText,
  64. Border? border,
  65. BorderRadiusGeometry? borderRadius,
  66. bool? filled,
  67. WidgetStatesController? statesController,
  68. TextMagnifierConfiguration? magnifierConfiguration,
  69. SpellCheckConfiguration? spellCheckConfiguration,
  70. List<InputFeature> features = const [],
  71. List<TextInputFormatter>? submitFormatters = const [],
  72. bool skipInputFeatureFocusTraversal = false,
  73. ValueChanged<TapDragStartDetails>? onDragSelectionStart,
  74. ValueChanged<TapDragUpdateDetails>? onDragSelectionUpdate,
  75. ValueChanged<TapDragEndDetails>? onDragSelectionEnd,
})

Creates a text input field widget.

A comprehensive text field implementation with support for various input types, validation, formatting, and interactive features. All parameters are forwarded to the parent TextInputStatefulWidget constructor.

This constructor provides extensive customization options matching Flutter's EditableText while adding custom features like input decorations, features, and form integration.

Example:

TextField(
  controller: myController,
  hintText: 'Enter text',
  keyboardType: TextInputType.text,
  maxLines: 3,
  onChanged: (value) => print(value),
)

See TextInputStatefulWidget and TextInput for parameter details.

Implementation

const TextField({
  super.key,
  super.groupId,
  super.controller,
  super.initialValue,
  super.focusNode,
  super.undoController,
  super.decoration,
  super.padding,
  super.placeholder,
  super.crossAxisAlignment,
  super.clearButtonSemanticLabel,
  super.keyboardType,
  super.textInputAction,
  super.textCapitalization,
  super.style,
  super.strutStyle,
  super.textAlign,
  super.textAlignVertical,
  super.textDirection,
  super.readOnly,
  super.showCursor,
  super.autofocus,
  super.obscuringCharacter,
  super.obscureText,
  super.autocorrect,
  super.smartDashesType,
  super.smartQuotesType,
  super.enableSuggestions,
  super.maxLines,
  super.minLines,
  super.expands,
  super.maxLength,
  super.maxLengthEnforcement,
  super.onChanged,
  super.onEditingComplete,
  super.onSubmitted,
  super.onTapOutside,
  super.onTapUpOutside,
  super.inputFormatters,
  super.enabled,
  super.cursorWidth,
  super.cursorHeight,
  super.cursorRadius,
  super.cursorOpacityAnimates,
  super.cursorColor,
  super.selectionHeightStyle,
  super.selectionWidthStyle,
  super.keyboardAppearance,
  super.scrollPadding,
  super.enableInteractiveSelection,
  super.selectionControls,
  super.dragStartBehavior,
  super.scrollController,
  super.scrollPhysics,
  super.onTap,
  super.autofillHints,
  super.clipBehavior,
  super.restorationId,
  super.stylusHandwritingEnabled,
  super.enableIMEPersonalizedLearning,
  super.contentInsertionConfiguration,
  super.contextMenuBuilder = defaultContextMenuBuilder,
  super.hintText,
  super.border,
  super.borderRadius,
  super.filled,
  super.statesController,
  super.magnifierConfiguration,
  super.spellCheckConfiguration,
  super.features,
  super.submitFormatters,
  super.skipInputFeatureFocusTraversal,
  this.onDragSelectionStart,
  this.onDragSelectionUpdate,
  this.onDragSelectionEnd,
});