TTextField 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:
- TTextFieldTheme for customizing appearance
- Validations for built-in validation rules
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- TTextField
- Mixed-in types
Constructors
-
TTextField({Key? key, String? label, String? tag, String? helperText, String? placeholder, bool isRequired = false, bool disabled = false, bool autoFocus = false, bool readOnly = false, TTextFieldTheme? theme, VoidCallback? onTap, FocusNode? focusNode, TextEditingController? textController, String? value, ValueNotifier<
String?> ? valueNotifier, ValueChanged<String?> ? onValueChanged, List<String? Function(String?)> ? rules, Duration? validationDebounce, int rows = 1}) -
Creates a text input field.
const
Properties
- autoFocus → bool
-
Whether the field should auto-focus when the widget is built.
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
- isRequired → bool
-
Whether this field is required.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → String?
-
The label text displayed above the field.
final
- onTap → VoidCallback?
-
Callback fired when the field is tapped.
final
-
onValueChanged
→ ValueChanged<
String?> ? -
Callback fired when the field's value changes.
final
- placeholder → String?
-
Placeholder text shown when the field is empty.
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(String?)> ? -
Validation rules to apply to the field's value.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- 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 → String?
-
The initial value of the field.
final
-
valueNotifier
→ ValueNotifier<
String?> ? -
A ValueNotifier for two-way binding with the field's value.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< TTextField> -
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
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
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(
String? value) → List< String> -
Validates the given value against the rules.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited