ZetaPhoneInput class Components
ZetaPhoneInput allows entering phone numbers.
Widgetbook: https://zeta-ds.web.app/flutter/widgetbook/index.html#/?path=components/phone-input
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FormField<
PhoneNumber> - ZetaPhoneInput
- Available Extensions
Constructors
-
ZetaPhoneInput({Key? key, bool? rounded, ValueChanged<
PhoneNumber?> ? onFieldSubmitted, FormFieldSetter<PhoneNumber> ? onSaved, PhoneNumber? initialValue, FormFieldValidator<PhoneNumber> ? validator, @Deprecated('Use onChange instead. ' 'Deprecated as of 0.15.0') ValueChanged<PhoneNumber?> ? onChanged, ValueChanged<PhoneNumber?> ? onChange, ZetaFormFieldRequirement? requirementLevel = ZetaFormFieldRequirement.none, String? label, @Deprecated('Use hintText instead. ' 'Deprecated as of 0.15.0') String? hint, String? hintText, @Deprecated('Use disabled instead. ' 'Deprecated as of 0.15.0') bool enabled = true, bool disabled = false, @Deprecated('Use errorText instead. ' 'Deprecated as of 0.15.0') bool hasError = false, String? errorText, @Deprecated('Use initialValue instead. ' 'Deprecated as of 0.15.0') String? initialCountry, List<String> ? countries, ZetaWidgetSize size = ZetaWidgetSize.medium, @Deprecated('Set this as part of the initial value instead. ' 'Deprecated as of 0.15.0') String? countryDialCode, @Deprecated('Set this as part of the initial value instead. ' 'enabled is deprecated as of 0.15.0') String? phoneNumber, @Deprecated('Country search hint is deprecated as of 0.15.0') String? countrySearchHint, String? selectCountrySemanticLabel, AutovalidateMode? autovalidateMode}) - Constructor for ZetaPhoneInput.
Properties
- autovalidateMode → AutovalidateMode
-
Used to enable/disable this form field auto validation and update its
error text.
finalinherited
-
builder
→ FormFieldBuilder<
PhoneNumber> -
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
-
countries
→ List<
String> ? -
List of countries ISO 3166-1 alpha-2 codes
final
- enabled → bool
-
Whether the form is able to receive user input.
finalinherited
- errorText → String?
-
In combination with
hasError: true, provides the error message to be displayed below the input field.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?
-
If provided, displays a hint below the input field.
final
- initialValue → PhoneNumber?
-
An optional value to initialize the form field to, or null otherwise.
finalinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → String?
-
If provided, displays a label above the input field.
final
-
onChange
→ ValueChanged<
PhoneNumber?> ? -
Called whenever the form field changes.
finalinherited
-
onFieldSubmitted
→ ValueChanged<
PhoneNumber?> ? -
Called whenever the form field is submitted.
finalinherited
-
onSaved
→ FormFieldSetter<
PhoneNumber> ? -
An optional method to call with the final value when the form is saved via
FormState.save.
finalinherited
- 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
- selectCountrySemanticLabel → String?
-
The semantic label for the country selection button.
final
- size → ZetaWidgetSize
-
The size of the input.
final
-
validator
→ FormFieldValidator<
PhoneNumber> ? -
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< PhoneNumber> -
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