flutter_user library

Classes

AuthBoolField
A field for capturing boolean values in a Flutter form.
AuthDropdownField
A field for capturing dropdown selections in a Flutter form.
AuthField<T>
An abstract class representing a field in a Flutter form.
AuthPassField
A field for capturing password inputs in a Flutter form.
AuthStep
AuthTextField
A field for capturing text inputs in a Flutter form.
AuthUserStoryConfiguration
Avatar
AvatarWrapper
ChangePasswordConfig
Configuration to enable to user to change his password in the profilescreen.
CheckPage
CheckPage is used to set a check page at the end of a FlutterForm. A CheckPage is a page where the user can check all input values before commiting.
EmailPasswordLogin
EmailPasswordLoginForm
Error
A Error object contains the title and message of an error.
FlutterForm
A wrapper for flutters Form that can be controlled by a controller and provides multiple pre-defined input types/fields FlutterForm also provides multi page forms and a check page for validation.
FlutterFormController
FlutterFormInputCarousel
Input for a carousel of items used in a FlutterForm.
FlutterFormInputCarouselController
Controller for the carousel used by a FlutterFormInputWidget used in a FlutterForm.
FlutterFormInputController<T>
Abstract class for the controller for inputs used in a FlutterForm.
FlutterFormInputDateTime
Input for a dateTime used in a FlutterForm.
FlutterFormInputDateTimeController
Controller for dates used by a FlutterFormInputWidget used in a FlutterForm.
FlutterFormInputEmail
Input for an email used in a FlutterForm.
FlutterFormInputEmailController
Controller for emails used by a FlutterFormInputWidget used in a FlutterForm.
FlutterFormInputMultiLine
Input for a multi line plain text field FlutterForm.
FlutterFormInputNumberPicker
Input for a number used in a FlutterForm.
FlutterFormInputNumberPickerController
FlutterFormInputPassword
Input for a password used in a FlutterForm.
FlutterFormInputPasswordController
Controller for passwords used by a FlutterFormInputWidget used in a ShellFrom.
FlutterFormInputPlainText
Input for plain text input used in a FlutterForm.
FlutterFormInputPlainTextController
Controller for plain text used by a FlutterFormInputWidget used in a FlutterForm.
FlutterFormInputSlider
Input for a number value between two values via a slider. Used in a FlutterForm.
FlutterFormInputSliderController
Controller for slider used by a FlutterFormInputWidget used in a FlutterForm.
FlutterFormInputSwitch
Input for a boolean switch. Used in a FlutterForm.
FlutterFormInputSwitchController
Controller for the switch used by a FlutterFormInputWidget used in a FlutterForm.
FlutterFormInputWidget<T>
Abstract class for the input widgets used in a FlutterForm.
FlutterFormOptions
The options used to set parameters to a FlutterForm.
FlutterFormPage
The defines every page in a FlutterForm.
ForgotPasswordForm
ForgotPasswordSpacerOptions
Options for configuring the spacer values for the forgot password form. Use this to adjust the spacing between the title, description, textfield, and button.
ItemBuilder
ItemBuilder is used to set the standard textfield for each undefined users data item.
ItemBuilderOptions
ItemBuilderOptions is a class to store all settings for a field in the profile page.
LocalLoginService
A local login service for testing purposes.
LoginOptions
LoginResponse<T>
A LoginResponse object is returned from a login attempt. If the login was successful, loginSuccessful will be true and userObject will contain the user object. If the login was not successful, loginSuccessful will be false and loginError will contain an Error object with the error title and message.
LoginServiceInterface
A service to handle authentication. Implement this class to create a custom login service.
LoginServiceTranslations
LoginServiceTranslations is used to provide custom error messages for the LoginService implementations.
LoginSpacerOptions
LoginTranslations
LoginValidationService
MFAWidget
OnboardingConfiguration
ProfileData
ProfileData is used to store custom/addintional data for a user.
ProfilePage
The ProfilePage widget is able to show the data of a user. By default the user is able to change this data. The widget has a couple of parameters listed below:
ProfileService
ProfileService can be extended and set for the profilePage. The following method can be overriden.
ProfileStyle
ProfielStyle is used to set a couple of style paramaters for the whole profile page.
RegistrationOptions
A set of options for configuring the registration process in a Flutter application.
RegistrationScreen
A screen for user registration.
RegistrationScreenState
The state for RegistrationScreen.
RegistrationTranslations
Holds all the translations for the standard elements on the registration screen.
RequestPasswordResponse<T>
A RequestPasswordResponse object is returned from a password reset request. If the request was successful, requestSuccesfull will be true. If the request was not successful, requestSuccesfull will be false and requestPasswordError will contain an Error object with the error title and message.
ShellTranslationService
TranslationService
User
User is used to contain all user data. It consists of three standard fields: firstName, lastName and image/imageUrl.
ValidationService
WrapViewOptions

Enums

BoolWidgetType
FlutterFormDateTimeType

Mixins

AuthUserStoryRoutes
OnboardedUserMixin
RegistrationRepository

Functions

authNavigatorUserstory(AuthUserStoryConfiguration configuration, BuildContext context) Widget
getAuthStoryRoutes(AuthUserStoryConfiguration configuration) List<GoRoute>
getFirstRoute(AuthUserStoryConfiguration configuration, BuildContext context) Future<String>
getTranslator(BuildContext context) Translator
wrapWithDefaultStyle(Widget? widget, TextStyle? style) Widget?

Typedefs

ButtonBuilder = Widget Function(BuildContext context, OptionalAsyncCallback onPressed, bool isDisabled, OptionalAsyncCallback onDisabledPress, LoginOptions options)
InputContainerBuilder = Widget Function(Widget child)
OptionalAsyncCallback = FutureOr<void> Function()
Translator = String Function(String, {List<String>? params})

Exceptions / Errors

AuthException