TTextField<T extends String?> class

A text input field with validation, theming, and advanced features.

TTextField provides a fully-featured text input with support for:

  • Single-line and multi-line input
  • Validation rules with debouncing
  • Required field indicators
  • Helper text and placeholders
  • Disabled and read-only states
  • Custom theming
  • Value binding with ValueNotifier

Basic Usage

TTextField(
  label: 'Email',
  placeholder: 'Enter your email',
  isRequired: true,
  rules: [
    Validations.required('Email is required'),
    Validations.email('Invalid email format'),
  ],
  onValueChanged: (value) => print('Email: $value'),
)

Multi-line Text Area

TTextField(
  label: 'Description',
  rows: 5,
  placeholder: 'Enter description...',
)

With Value Notifier

final emailNotifier = ValueNotifier<String?>('');

TTextField(
  label: 'Email',
  valueNotifier: emailNotifier,
)

See also:

Inheritance
Mixed-in types
Available extensions

Constructors

TTextField({Key? key, String? label, String? tag, String? helperText, String? info, String? placeholder, bool isRequired = false, bool disabled = false, bool autoFocus = false, bool readOnly = false, bool clearable = false, bool obscureText = false, TTextFieldTheme? theme, Widget? preWidget, Widget? postWidget, TInputSize? size, TInputDecorationType? decorationType, VoidCallback? onTap, FocusNode? focusNode, TextEditingController? textController, T? value, ValueNotifier<T?>? valueNotifier, ValueChanged<T?>? onValueChanged, List<String? Function(T?)>? rules, Duration? validationDebounce, int rows = 1, TLabelPosition? labelPosition, TextInputType? keyboardType, List<TextInputFormatter>? inputFormatters})
Creates a text input field.
const

Properties

autoFocus → bool
Whether the field should auto-focus when the widget is built.
final
clearable → bool
Whether to show a clear button when the field has a value.
final
decorationType → TInputDecorationType?
The decoration type of the text field.
final
disabled → bool
Whether the field is disabled.
final
focusNode → FocusNode?
Custom focus node for managing focus state.
final
hashCode → int
The hash code for this object.
no setterinherited
helperText → String?
Helper text displayed below the field.
final
info → String?
The info text (optional).
final
inputFormatters → List<TextInputFormatter>?
Optional input formatters to apply.
final
isRequired → bool
Whether this field is required.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardType → TextInputType?
The type of keyboard to display.
final
label → String?
The label text displayed above the field.
final
labelPosition → TLabelPosition?
final
obscureText → bool
Whether to obscure the text (e.g. for passwords).
final
onTap → VoidCallback?
Callback fired when the field is tapped.
final
onValueChanged → ValueChanged<T?>?
Callback fired when the field's value changes.
final
placeholder → String?
Placeholder text shown when the field is empty.
final
postWidget → Widget?
Custom post-widget.
final
preWidget → Widget?
Custom pre-widget.
final
readOnly → bool
Whether the field is read-only.
final
rows → int
The number of rows for multi-line input.
final
rules → List<String? Function(T?)>?
Validation rules to apply to the field's value.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → TInputSize?
The size of the text field.
final
tag → String?
An optional tag displayed next to the label.
final
textController → TextEditingController?
Custom text editing controller.
final
theme → TTextFieldTheme?
Custom theme for this text field.
final
validationDebounce → Duration?
Debounce duration for validation.
final
value → T?
The initial value of the field.
final
valueNotifier → ValueNotifier<T?>?
A ValueNotifier for two-way binding with the field's value.
final

Methods

box({double minW = 0.0, double minH = 0.0, double maxW = double.infinity, double maxH = double.infinity}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a ConstrainedBox to apply layout constraints.
center({bool when = true}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Center widget.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<TTextField<T>>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
estimateWidth(BuildContext context) → double

Available on TTextField<String?>, provided by the TTextFieldWidthX extension

expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in an Expanded widget.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
padding([double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0]) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with flexible edge control.
paddingSymmetric({double h = 0.0, double v = 0.0}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with symmetric horizontal and vertical spacing.
size({double? w, double? h}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a SizedBox to apply fixed width and/or height.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited
validateValue(T? value) → List<String>
Validates the given value against the rules.
inherited
visible(bool visible, {bool maintainState = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Visibility widget.
when(bool condition) → Widget

Available on Widget, provided by the WidgetX extension

Returns this widget if condition is true, otherwise returns SizedBox.shrink(). Usage: Text('Hello').when(isVisible)

Operators

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