RegistrationOptions class
A set of options for configuring the registration process in a Flutter application.
Constructors
-
RegistrationOptions({RegistrationRepository? registrationRepository, List<
AuthStep> ? registrationSteps, required VoidCallback afterRegistration, int? titleFlex, int? formFlex, int? beforeTitleFlex, int? afterTitleFlex, RegistrationTranslations registrationTranslations = const RegistrationTranslations.empty(), int? onError(String error)?, AppBar customAppbarBuilder(String title)? = _createCustomAppBar, Widget nextButtonBuilder(Future<void> onPressed()?, String label, int step, bool enabled)?, Widget? previousButtonBuilder(VoidCallback onPressed, String label, int step)?, MainAxisAlignment? buttonMainAxisAlignment, Color? backgroundColor, Widget? titleWidget, Widget? loginButton, double? maxFormWidth})
Properties
- afterRegistration → VoidCallback
-
A callback function executed after successful registration.
final
- afterTitleFlex → int?
-
The number of flex units for the buttons.
final
- backgroundColor → Color?
-
The background color of the registration screen.
final
- beforeTitleFlex → int?
-
The number of flex units for the buttons.
final
-
Specifies the alignment of buttons.
final
- customAppbarBuilder → (AppBar Function(String title)?)
-
A function for customizing the app bar displayed during registration.
final
- formFlex → int?
-
The number of flex units for the form.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- loginButton → Widget?
-
A custom widget for displaying a login button.
final
- maxFormWidth → double?
-
The maximum width of the form. Defaults to 300.
final
-
nextButtonBuilder
→ (Widget Function(Future<
void> onPressed()?, String label, int step, bool enabled)?) -
A function for customizing the "Next" button.
final
- onError → (int? Function(String error)?)
-
A function that handles errors during registration.
final
- previousButtonBuilder → (Widget? Function(VoidCallback onPressed, String label, int step)?)
-
A function for customizing the "Previous" button.
final
- registrationRepository ↔ RegistrationRepository?
-
The repository responsible for registration.
getter/setter pair
-
registrationSteps
→ List<
AuthStep> ? -
The steps involved in the registration process.
final
- registrationTranslations → RegistrationTranslations
-
Translations for registration-related messages and prompts.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
steps
↔ List<
AuthStep> -
getter/setter pair
- titleFlex → int?
-
The number of flex units for the title.
final
- titleWidget → Widget?
-
A custom widget for displaying the registration title.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
getDefaultSteps(
{TextEditingController? emailController, TextEditingController? passController, bool passHidden = true, dynamic passHideOnChange(bool mainPass, bool value)?, RegistrationTranslations translations = const RegistrationTranslations.empty(), dynamic titleBuilder(String title)?, dynamic labelBuilder(String label)?, TextStyle? textStyle, String? initialEmail}) → List< AuthStep> - Generates default registration steps.