AuthenticatorForm class

Base class for Authenticator forms and ancestor of all Authenticator form fields.

When building custom authenticator forms composed of prebuilt form field widgets, AuthenticatorForm should be an ancestor of all field widgets.

AuthenticatorForm(
  child: Column(
    children: [
      // prebuilt form field widget
      SignUpFormField.username(),
      SignUpFormField.email(required: true),
      SignUpFormField.password(),
      SignUpFormField.passwordConfirmation(),

      // custom field for a terms and conditions checkbox
      TermsAndConditionsCheckBox(),

      // prebuilt sign up button from amplify_authenticator package
      const SignUpButton(),
    ],
  ),
),

See also:

• SignUpForm
• SignInForm
• ConfirmSignUpForm
• ConfirmSignInMFAForm
• ConfirmSignInCustomAuthForm
• ConfirmSignInNewPasswordForm
• ResetPasswordForm
• ConfirmResetPasswordForm
• VerifyUserForm
• ConfirmVerifyUserForm

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• AuthenticatorForm

Implementers

• ConfirmResetPasswordForm
• ConfirmSignInCustomAuthForm
• ConfirmSignInMFAForm
• ConfirmSignInNewPasswordForm
• ConfirmSignUpForm
• ConfirmVerifyUserForm
• ContinueSignInWithMfaSelectionForm
• ContinueSignInWithTotpSetupForm
• ResetPasswordForm
• SignInForm
• SignUpForm
• VerifyUserForm

Constructors

AuthenticatorForm({Key? key, required Widget? child})

When building custom authenticator forms composed of prebuilt form field widgets, AuthenticatorForm should be an ancestor of all field widgets.

const

Properties

actions → List<Widget>

Buttons and checkboxes to show below the fields.

final

child → Widget?

A completely custom child widget

final

fields → List<AuthenticatorFormField<Enum, Object>>

The form fields which are independent of the Auth plugin configuration.

final

hashCode → int

The hash code for this object.

no setter, inherited

includeDefaultSocialProviders → bool

Whether to include buttons for the configured social providers.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → AuthenticatorFormState<AuthenticatorForm>

Creates the mutable state for this widget at a given location in the tree.

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.

override

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