SupaSocialsAuth class

UI Component to create social login form

Inheritance

Constructors

SupaSocialsAuth({Key? key, NativeGoogleAuthConfig? nativeGoogleAuthConfig, bool enableNativeAppleAuth = true, required List<OAuthProvider> socialProviders, bool colored = true, String? redirectUrl, required void onSuccess(Session session), void onError(Object error)?, SocialButtonVariant socialButtonVariant = SocialButtonVariant.iconAndText, bool showSuccessSnackBar = true, Map<OAuthProvider, String>? scopes, Map<OAuthProvider, Map<String, String>>? queryParams, SupaSocialsAuthLocalization localization = const SupaSocialsAuthLocalization()})
const

Properties

colored bool
Whether or not to color the social buttons in their respecful colors
final
enableNativeAppleAuth bool
Whether to use native Apple sign in on iOS and macOS
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 SupaSocialsAuthLocalization
Localization for the form
final
nativeGoogleAuthConfig NativeGoogleAuthConfig?
Defines native google provider to show in the form
final
onError → (void Function(Object error)?)
Method to be called when the auth action threw an excepction
final
onSuccess → void Function(Session session)
Method to be called when the auth action is success
final
queryParams Map<OAuthProvider, Map<String, String>>?
Parameters to include in provider authorization request (ex. {'prompt': 'consent'})
final
redirectUrl String?
redirectUrl to be passed to the .signIn() or signUp() methods
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scopes Map<OAuthProvider, String>?
OpenID scope(s) for provider authorization request (ex. '.default')
final
showSuccessSnackBar bool
Whether to show a SnackBar after a successful sign in
final
socialButtonVariant SocialButtonVariant
Whether or not to show the icon only or icon and text
final
socialProviders List<OAuthProvider>
List of social providers to show in the form
final

Methods

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