SignUpFormField<FieldValue extends Object> class abstract Prebuilt Widgets

A prebuilt form field widget for use on the Sign Up step.

Inheritance

Properties

authenticatorTextFieldController → AuthenticatorTextFieldController?
Optional text controller exposed by text-driven form fields.
no setterinherited
autofillHints → Iterable<String>?
Autocomplete hints to override the default value
finalinherited
displayPriority → int
The priority to show this field when ordering fields visually in a form. Larger numbers take higher precedence.
no setter
enabledOverride → AuthenticatorTextEnabledOverride?
Whether the field can receive manual input.
finalinherited
field → SignUpField
The field this form field controls.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
hintText → String?
Custom hint text
finalinherited
hintTextKey → InputResolverKey?
Resolver key for the hint text
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
required → bool
Whether the field is required in the form.
no setter
requiredOverride → bool?
User override of default required value.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
title → String?
Custom title
finalinherited
titleKey → InputResolverKey?
Resolver key for the title
finalinherited
usernameType → UsernameType?
The username attribute corresponding to this field, if any. This is used to properly address situations where custom fields are added which conflict with username fields.
no setter
validatorOverride → FormFieldValidator<FieldValue>?
Override of default validator.
finalinherited
visible → bool
Whether the field should be rendered.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → AuthenticatorComponentState<AuthenticatorFormField<SignUpField, FieldValue>>
Creates the mutable state for this widget at a given location in the tree.
inherited
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

Operators

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

Static Methods

address({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates an address component.
birthdate({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a birthdate component.
custom({Key? key, required String title, required CognitoUserAttributeKey attributeKey, String? hintText, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a custom attribute component.
email({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates an email component.
familyName({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a familyName component.
gender({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a gender component.
givenName({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a givenName component.
middleName({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a middleName component.
name({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a name component.
nickname({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a nickname component.
password({Key? key, FormFieldValidator<String>? validator, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a password component.
passwordConfirmation({Key? key, FormFieldValidator<String>? validator, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a passwordConfirmation component.
phoneNumber({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a phoneNumber component.
preferredUsername({Key? key, FormFieldValidator<String>? validator, bool? required, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<String>
Creates a preferredUsername component.
username({Key? key, FormFieldValidator<UsernameInput>? validator, Iterable<String>? autofillHints, AuthenticatorTextFieldController? authenticatorTextFieldController, AuthenticatorTextEnabledOverride? enabledOverride, bool visible = true}) → SignUpFormField<UsernameInput>
Creates a username component based on your app's configuration.