AuthButton<T extends Auth<AuthKeys>> class

A stateful widget that wires an AuthButtonType to a builder-pattern UI.

Responsibilities:

  • Resolves the correct AuthAction via AuthActionFactory.
  • Manages loading state so callers can disable the button while busy.
  • Surfaces errors through the optional onError callback instead of swallowing or crashing.

Example:

AuthButton<AppUser>(
  type: AuthButtonType.signInWithGoogle,
  storeToken: true,
  onError: (e) => showSnackBar(context, e.toString()),
  builder: (context, callback) => ElevatedButton(
    onPressed: callback,
    child: const Text('Sign in with Google'),
  ),
)
Inheritance

Constructors

AuthButton({Key? key, Object? args, String? id, bool notifiable = true, required AuthButtonType type, required AuthButtonBuilder builder, Authenticator? authenticator, bool storeToken = false, Map<String, dynamic>? updates, SignByBiometricCallback<Auth<AuthKeys>>? onBiometric, void onError(Object error)?})
const

Properties

args → Object?
final
authenticator → Authenticator?
final
builder → AuthButtonBuilder
Builder receives a nullable VoidCallback:
final
hashCode → int
The hash code for this object.
no setterinherited
id → String?
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
notifiable → bool
final
onBiometric → SignByBiometricCallback<Auth<AuthKeys>>?
final
onError → void Function(Object error)?
Called with any error thrown during AuthAction.execute. If null, errors are rethrown.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storeToken → bool
final
type → AuthButtonType
final
updates → Map<String, dynamic>?
final

Methods

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