ZetaTextInput class

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.

The input can be reset and validated by Creating a key of type ZetaTextInputState and calling either reset or validate. However, it is recommended that the input is used and validated as part of a form.

Inheritance
Available Extensions

Constructors

ZetaTextInput({Key? key, ValueChanged<String?>? onChange, bool disabled = false, ZetaFormFieldRequirement requirementLevel = ZetaFormFieldRequirement.none, String? initialValue, String? label, String? hintText, String? placeholder, String? errorText, TextEditingController? controller, String? validator(String?)?, Widget? suffix, Widget? prefix, ZetaWidgetSize size = ZetaWidgetSize.medium, bool rounded = true, List<TextInputFormatter>? inputFormatters, String? prefixText, TextStyle? prefixTextStyle, String? suffixText, TextStyle? suffixTextStyle, void onSubmit(String? val)?})
Creates a new ZetaTextInput
const

Properties

controller → TextEditingController?
The controller given to the input. Cannot be given in addition to initialValue.
final
disabled → bool
finalinherited
errorText → String?
The error text shown beneath the input. Replaces hintText.
final
hashCode → int
The hash code for this object.
no setterinherited
hintText → String?
The hint text displayed below the input.
final
initialValue → String?
The initial value of the form field.
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
label → String?
The label displayed above the input.
final
onChange → ValueChanged<String?>?
Called with the current value of the field whenever it is changed.
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, e.g. mandatory or optional.
finalinherited
rounded → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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 → (String? Function(String?)?)
The validator passed to the input. Should return the error message to be displayed below the input. Should return null if there is no error.
final

Methods

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