SupaEmailAuth class

UI component to create email and password signup/ signin form

SupaEmailAuth(
  onSignInComplete: (response) {
    // handle sign in complete here
  },
  onSignUpComplete: (response) {
    // handle sign up complete here
  },
),
Inheritance

Constructors

SupaEmailAuth({Key? key, String? redirectTo, required void onSignInComplete(AuthResponse response), required void onSignUpComplete(AuthResponse response), void onPasswordResetEmailSent()?, void onError(Object error)?, List<MetaDataField>? metadataFields, Map<String, dynamic>? extraMetadata, SupaEmailAuthLocalization localization = const SupaEmailAuthLocalization()})
UI component to create email and password signup/ signin form
const

Properties

extraMetadata Map<String, dynamic>?
Additional properties for user_metadata on signup
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
localization SupaEmailAuthLocalization
Localization for the form
final
metadataFields List<MetaDataField>?
Set of additional fields to the signup form that will become part of the user_metadata
final
onError → (void Function(Object error)?)
Callback for when the auth action threw an exception
final
onPasswordResetEmailSent → (void Function()?)
Callback for sending the password reset email
final
onSignInComplete → void Function(AuthResponse response)
Callback for the user to complete a sign in.
final
onSignUpComplete → void Function(AuthResponse response)
Callback for the user to complete a signUp.
final
redirectTo String?
The URL to redirect the user to when clicking on the link on the confirmation link after signing up.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

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