SignInScreen class
A screen displaying a fully styled Sign In flow for Authentication.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- SignInScreen
Constructors
-
SignInScreen({Key? key, List<
AuthProvider< ? providers, FirebaseAuth? auth, double? headerMaxExtent, HeaderBuilder? headerBuilder, SideBuilder? sideBuilder, OAuthButtonVariant? oauthButtonVariant = OAuthButtonVariant.icon_and_text, TextDirection? desktopLayoutDirection, bool? resizeToAvoidBottomInset = true, bool? showAuthActionSwitch, String? email, AuthViewContentBuilder? subtitleBuilder, Key? loginViewKey, List<AuthListener, AuthCredential> >FirebaseUIAction> actions = const [], double breakpoint = 800, Set<FirebaseUIStyle> ? styles, bool showPasswordVisibilityToggle = false, double? maxWidth}) -
A screen displaying a fully styled Sign In flow for Authentication.
const
Properties
-
actions
→ List<
FirebaseUIAction> -
SignInScreen could invoke these actions:
final
- auth → FirebaseAuth
-
no setterinherited
- breakpoint → double
-
Min width of the viewport for desktop layout. If the available width is
less than this value, a mobile layout is used.
final
- desktopLayoutDirection → TextDirection?
-
A direction of the desktop layout.
TextDirection.ltr indicates that side content is built on the left, and
the child is placed on the right. The order is reversed when
TextDirection.rtl is used.
final
- email → String?
-
A email that EmailForm would be pre-filled with.
final
-
A returned widget would be placed up the authentication related widgets.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- headerBuilder → HeaderBuilder?
-
A builder that builds the contents of the header.
Used only on mobile platforms.
final
- headerMaxExtent → double?
-
The maximum height of the header.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loginViewKey → Key?
-
A Key that would be passed down to the LoginView.
final
- maxWidth → double?
-
A max width of the page on desktop. If the available width is greater than
this value, the content is centered and horizontal paddings are added.
final
- oauthButtonVariant → OAuthButtonVariant?
-
Indicates whether icon-only or icon and text OAuth buttons should be used.
Icon-only buttons are placed in a row.
final
-
providers
→ List<
AuthProvider< AuthListener, AuthCredential> > -
no setterinherited
- resizeToAvoidBottomInset → bool?
-
See Scaffold.resizeToAvoidBottomInset
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showAuthActionSwitch → bool?
-
Whether the "Login/Register" link should be displayed. The link changes
the type of the AuthAction from AuthAction.signIn
and AuthAction.signUp and vice versa.
final
- showPasswordVisibilityToggle → bool
-
final
- sideBuilder → SideBuilder?
-
A builder that builds a contents of a page displayed on a side of
of the main authentication related UI.
final
-
styles
→ Set<
FirebaseUIStyle> ? -
A set of styles that are provided to the descendant widgets.
final
- subtitleBuilder → AuthViewContentBuilder?
-
A returned widget would be placed up the authentication related widgets.
final
Methods
-
build(
BuildContext context) → Widget -
createElement(
) → ScreenElement -
Inflates this configuration to a concrete instance.
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}) → 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