AnimatedLogin class - animated_login library

Constructors

AnimatedLogin({LoginViewTheme? loginDesktopTheme, LoginViewTheme? loginMobileTheme, LoginTexts? loginTexts, List<SocialLogin>? socialLogins, LoginCallback? onLogin, SignupCallback? onSignup, ForgotPasswordCallback? onForgotPassword, GlobalKey<FormState>? formKey, bool checkError = true, @Deprecated('Instead prefer to use componentOrder to not show some parts.') bool showForgotPassword = true, @Deprecated('Instead prefer to use componentOrder to not show some parts.') bool showChangeActionTitle = true, bool showPasswordVisibility = true, ValidatorModel? nameValidator, ValidatorModel? emailValidator, ValidatorModel? passwordValidator, bool validateName = true, bool validateEmail = true, bool validatePassword = true, bool validateCheckbox = true, TextEditingController? nameController, TextEditingController? emailController, TextEditingController? passwordController, TextEditingController? confirmPasswordController, String? backgroundImage, Widget? logo, SignUpModes signUpMode = SignUpModes.both, List<LanguageOption> languageOptions = const <LanguageOption>[], ChangeLanguageCallback? changeLanguageCallback, LanguageOption? selectedLanguage, ChangeLangOnPressedCallback? changeLangOnPressed, AuthMode? initialMode, AuthModeChangeCallback? onAuthModeChange, VoidCallback? changeLangDefaultOnPressed, Widget? privacyPolicyChild, ValueChanged<bool?>? checkboxCallback, Key? key}): Default constructor for AnimatedLogin.
const

Properties

backgroundImage → String?: Full asset image path for background of the welcome part.
final
changeLangDefaultOnPressed → VoidCallback?: Optional function will be called on pressed to the change language button when the default button is preserved.
final
changeLangOnPressed → ChangeLangOnPressedCallback?: Optional function will be called on pressed to the change language button. It should prompt a dialog to select a language and return the selected.
final
changeLanguageCallback → ChangeLanguageCallback?: Callback that will be called when a language is selected.
final
checkboxCallback → ValueChanged<bool?>?: checkboxCallback is called when the checkbox is tapped.
final
checkError → bool: Indicates whether the login screen should handle errors, show the error messages returned from the callbacks in a dialog.
final
confirmPasswordController → TextEditingController?: Optional TextEditingController for confirm password input field.
final
emailController → TextEditingController?: Optional TextEditingController for email input field.
final
emailValidator → ValidatorModel?: Custom input validator for email field.
final
formKey → GlobalKey<FormState>?: The optional custom form key, if not provided will be created locally.
final
hashCode → int: The hash code for this object.
no setterinherited
initialMode → AuthMode?: If you update the state of parent widget of animated login, you should provide the last auth mode by using onAuthModeChange.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
languageOptions → List<LanguageOption>: List of languages that user can select.
final
loginDesktopTheme → LoginViewTheme?: Determines all of the theme related variables for DESKTOP view. Example: colors, text styles, button styles.
final
loginMobileTheme → LoginViewTheme?: Determines all of the theme related variables for MOBILE view. Example: colors, text styles, button styles.
final
loginTexts → LoginTexts?: Determines all of the texts on the screen.
final
logo → Widget?: Optional logo widget to display. Its size is constrained.
final
nameController → TextEditingController?: Optional TextEditingController for name input field.
final
nameValidator → ValidatorModel?: Custom input validator for name field.
final
onAuthModeChange → AuthModeChangeCallback?: It is called on auth mode changes, you can store the current mode.
final
onForgotPassword → ForgotPasswordCallback?: Callback that will be called after on tap of forgot password text. Commonly it navigates user to a screen to reset the password.
final
onLogin → LoginCallback?: Login callback that will be called after login button pressed.
final
onSignup → SignupCallback?: Signup callback that will be called after signup button pressed.
final
passwordController → TextEditingController?: Optional TextEditingController for password input field.
final
passwordValidator → ValidatorModel?: Custom input validator for password field.
final
privacyPolicyChild → Widget?: Custom privacy policy child.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selectedLanguage → LanguageOption?: Selected language that is stored in your side. It will be used as an initial language at first.
final
showChangeActionTitle → bool: Indicates whether the change action title should be displayed.
final
showForgotPassword → bool: Indicates whether the forgot password option will be enabled.
final
showPasswordVisibility → bool: Indicates whether the user can show the password text without obscuring.
final
signUpMode → SignUpModes: Enum to determine which text form fields should be displayed in addition to the email and password fields: Name / Confirm Password / Both
final
socialLogins → List<SocialLogin>?: List of social login options that will be provided.
final
validateCheckbox → bool: Indicates whether the checkbox should be validated.
final
validateEmail → bool: Indicates whether the email field should be validated.
final
validateName → bool: Indicates whether the name field should be validated.
final
validatePassword → bool: Indicates whether the password fields should be validated.
final

Methods

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