ZetaTextInput class Components

Text inputs allow the user to enter text.

To show error messages on the text input, use the validator. The string returned from this function will be displayed as the error message. Error messages can also be managed outside the text input by setting errorText.

Figma: https://www.figma.com/design/JesXQFLaPJLc1BdBM4sisI/%F0%9F%A6%93-ZDS---Components?node-id=229-38&node-type=canvas&m=dev

Widgetbook: https://zeta-ds.web.app/flutter/widgetbook/index.html#/?path=components/text-input

Inheritance
Available Extensions

Constructors

ZetaTextInput({Key? key, ValueChanged<String?>? onChange, bool disabled = false, ZetaFormFieldRequirement? requirementLevel = ZetaFormFieldRequirement.none, String? initialValue, AutovalidateMode? autovalidateMode, FormFieldValidator<String>? validator, FormFieldSetter<String>? onSaved, ValueChanged<String?>? onFieldSubmitted, bool? rounded, String? label, String? hintText, String? placeholder, String? errorText, TextEditingController? controller, Widget? suffix, Widget? prefix, ZetaWidgetSize size = ZetaWidgetSize.medium, List<TextInputFormatter>? inputFormatters, String? prefixText, TextStyle? prefixTextStyle, String? suffixText, TextStyle? suffixTextStyle, void onSubmit(String? val)?, bool obscureText = false, TextInputType? keyboardType, FocusNode? focusNode, String? semanticLabel})
Creates a new ZetaTextInput

Properties

autovalidateMode → AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
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.
finalinherited
controller → TextEditingController?
The controller for the text form field.
finalinherited
enabled → bool
Whether the form is able to receive user input.
finalinherited
errorText → String?
The error text shown beneath the input. Replaces hintText.
final
focusNode → FocusNode?
The focus node of the input.
final
forceErrorText → String?
An optional property that forces the FormFieldState into an error state by directly setting the FormFieldState.errorText property without running the validator function.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
hintText → String?
The hint text displayed below the input.
final
initialValue → String?
An optional value to initialize the form field to, or null otherwise.
finalinherited
inputFormatters → List<TextInputFormatter>?
The input formatters given to the text input.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardType → TextInputType?
The keyboard type of the input.
final
label → String?
The label displayed above the input.
final
obscureText → bool
Obscures the text within the input.
final
onChange → ValueChanged<String?>?
Called whenever the form field changes.
finalinherited
onFieldSubmitted → ValueChanged<String?>?
Called whenever the form field is submitted.
finalinherited
onSaved → FormFieldSetter<String>?
An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
onSubmit → (void Function(String? val)?)
Called when the input is submitted.
final
placeholder → String?
The placeholder text displayed in the input.
final
prefix → Widget?
The widget displayed at the start of the input. Cannot be given in addition to prefixText.
final
prefixText → String?
The text displayed at the end of the input. Cannot be given in addition to prefix.
final
prefixTextStyle → TextStyle?
The style applied to prefixText.
final
requirementLevel → ZetaFormFieldRequirement?
The requirement level of the form field.
finalinherited
restorationId → String?
Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticLabel → String?
Value passed to the wrapping Semantics widget.
final
size → ZetaWidgetSize
The size of the input.
final
suffix → Widget?
The widget displayed at the end of the input. Cannot be given in addition to suffixText.
final
suffixText → String?
The text displayed at the end of the input. Cannot be given in addition to suffix.
final
suffixTextStyle → TextStyle?
The style applied to suffixText.
final
validator → FormFieldValidator<String>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → FormFieldState<String>
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.
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}) → 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

Operators

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