Merge pull request #31 from Iconica-Development/feature/default_style

feat: default styling

.gitignore

@@ -35,3 +35,7 @@ build/
 .flutter-plugins
 .flutter-plugins-dependencies
 .metadata
+
+# FVM Version Cache
+.fvm/
+.fvmrc

CHANGELOG.md

@@ -3,6 +3,18 @@ SPDX-FileCopyrightText: 2022 Iconica
 
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
+# 3.0.0
+- fix: fixed the issue with the scrollController when the `pageToReturnTo` is null.
+- feat: Added default styling and theme.
+- feat: Added Iconica linter.
+# 2.0.4
+- feat: added maxFormWidth to AuthScreen
+
+# 2.0.3
+- feat: added default registrationOptions
+
+# 2.0.2
+- fix: fixed the issue with values not being saved when calling nextStep.
 
 # 2.0.1
 - feat: added circular progress indicator while awaiting registration of user

analysis_options.yaml

@@ -1,4 +1,9 @@
-include: package:flutter_lints/flutter.yaml
+include: package:flutter_iconica_analysis/components_options.yaml
 
-# Additional information about this file can be found at
-# https://dart.dev/guides/language/analysis-options
+# Possible to overwrite the rules from the package
+
+analyzer:
+  exclude:
+
+linter:
+  rules:

example/lib/main.dart

@@ -21,7 +21,7 @@ void main() {
 }
 
 class FlutterRegistrationDemo extends StatefulWidget {
-  const FlutterRegistrationDemo({Key? key}) : super(key: key);
+  const FlutterRegistrationDemo({super.key});
 
   @override
   State<FlutterRegistrationDemo> createState() =>
@@ -86,8 +86,7 @@ class _FlutterRegistrationDemoState extends State<FlutterRegistrationDemo> {
 }
 
 class ProtectedScreen extends StatelessWidget {
-  const ProtectedScreen({Key? key}) : super(key: key);
-
+  const ProtectedScreen({super.key});
   @override
   Widget build(BuildContext context) {
     return const Scaffold(

example/pubspec.lock

@@ -65,12 +65,11 @@ packages:
   flutter_input_library:
     dependency: transitive
     description:
-      path: "."
-      ref: "3.0.0"
-      resolved-ref: "7d1880b8e348435fc8dc2d3a11f936b224cbd5b7"
-      url: "https://github.com/Iconica-Development/flutter_input_library"
-    source: git
-    version: "3.0.0"
+      name: flutter_input_library
+      sha256: db8d9d57c31f166ed7c4ec3d060d18891533c57877a30c6c2668231efa1a44f8
+      url: "https://forgejo.internal.iconica.nl/api/packages/internal/pub/"
+    source: hosted
+    version: "3.6.0"
   flutter_lints:
     dependency: "direct dev"
     description:
@@ -90,7 +89,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.2.0"
+    version: "2.0.4"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -100,10 +99,34 @@ packages:
     dependency: transitive
     description:
       name: intl
-      sha256: "3bc132a9dbce73a7e4a21a17d06e1878839ffbf975568bc875c60537824b0c4d"
+      sha256: d6f56758b7d3014a48af9701c085700aac781a92a87a62b1333b46d8879661cf
       url: "https://pub.dev"
     source: hosted
-    version: "0.18.1"
+    version: "0.19.0"
+  leak_tracker:
+    dependency: transitive
+    description:
+      name: leak_tracker
+      sha256: "7f0df31977cb2c0b88585095d168e689669a2cc9b97c309665e3386f3e9d341a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "10.0.4"
+  leak_tracker_flutter_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_flutter_testing
+      sha256: "06e98f569d004c1315b991ded39924b21af84cf14cc94791b8aea337d25b57f8"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.3"
+  leak_tracker_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_testing
+      sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.1"
   lints:
     dependency: transitive
     description:
@@ -116,34 +139,34 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
+      sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.16"
+    version: "0.12.16+1"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
+      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.8.0"
   meta:
     dependency: transitive
     description:
       name: meta
-      sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
+      sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136"
       url: "https://pub.dev"
     source: hosted
-    version: "1.10.0"
+    version: "1.12.0"
   path:
     dependency: transitive
     description:
       name: path
-      sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
+      sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
       url: "https://pub.dev"
     source: hosted
-    version: "1.8.3"
+    version: "1.9.0"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -193,10 +216,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b"
+      sha256: "9955ae474176f7ac8ee4e989dadfb411a58c30415bcfb648fa04b2b8a03afa7f"
       url: "https://pub.dev"
     source: hosted
-    version: "0.6.1"
+    version: "0.7.0"
   vector_math:
     dependency: transitive
     description:
@@ -205,14 +228,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.4"
-  web:
+  vm_service:
     dependency: transitive
     description:
-      name: web
-      sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
+      name: vm_service
+      sha256: "3923c89304b715fb1eb6423f017651664a03bf5f4b29983627c4da791f74a4ec"
       url: "https://pub.dev"
     source: hosted
-    version: "0.3.0"
+    version: "14.2.1"
 sdks:
-  dart: ">=3.2.0-194.0.dev <4.0.0"
-  flutter: ">=1.17.0"
+  dart: ">=3.3.0 <4.0.0"
+  flutter: ">=3.18.0-18.0.pre.54"

lib/flutter_registration.dart

@@ -1,19 +1,21 @@
 // SPDX-FileCopyrightText: 2022 Iconica
 //
 // SPDX-License-Identifier: BSD-3-Clause
-/// Flutter registration component that provides a registration screen with multiple registration steps.
+/// Flutter registration component that provides a registration
+/// screen with multiple registration steps.
 library flutter_registration;
 
-export 'src/config/registration_options.dart';
-export 'src/config/registration_translations.dart';
-export 'src/model/auth_exception.dart';
-export 'src/model/auth_field.dart';
-export 'src/model/auth_step.dart';
-export 'src/model/auth_text_field.dart';
-export 'src/model/auth_bool_field.dart';
-export 'src/model/auth_drop_down.dart';
-export 'src/model/auth_pass_field.dart';
-export 'src/registration_screen.dart';
-export 'src/service/registration_repository.dart';
-export 'package:flutter_input_library/flutter_input_library.dart'
+export "package:flutter_input_library/flutter_input_library.dart"
     show BoolWidgetType;
+
+export "src/config/registration_options.dart";
+export "src/config/registration_translations.dart";
+export "src/model/auth_bool_field.dart";
+export "src/model/auth_drop_down.dart";
+export "src/model/auth_exception.dart";
+export "src/model/auth_field.dart";
+export "src/model/auth_pass_field.dart";
+export "src/model/auth_step.dart";
+export "src/model/auth_text_field.dart";
+export "src/registration_screen.dart";
+export "src/service/registration_repository.dart";

lib/src/auth_screen.dart

@@ -2,12 +2,51 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'dart:async';
-import 'dart:collection';
-import 'package:flutter/material.dart';
-import 'package:flutter_registration/flutter_registration.dart';
+import "dart:async";
+import "dart:collection";
+import "package:flutter/material.dart";
+import "package:flutter_registration/flutter_registration.dart";
 
+/// A widget for handling multi-step authentication processes.
 class AuthScreen extends StatefulWidget {
+  /// Constructs an [AuthScreen] object.
+  ///
+  /// [appBarTitle] specifies the title of the app bar.
+  ///
+  /// [onFinish] is a function called upon
+  /// completion of the authentication process.
+  ///
+  /// [steps] is a list of authentication steps to be completed.
+  ///
+  /// [submitBtnTitle] specifies the title of the submit button.
+  ///
+  /// [nextBtnTitle] specifies the title of the next button.
+  ///
+  /// [previousBtnTitle] specifies the title of the previous button.
+  ///
+  /// [customAppBar] allows customization of the app bar.
+  ///
+  /// [buttonMainAxisAlignment] specifies the alignment of the buttons.
+  ///
+  /// [customBackgroundColor] allows customization of the background color.
+  ///
+  /// [nextButtonBuilder] allows customization of the next button.
+  ///
+  /// [previousButtonBuilder] allows customization of the previous button.
+  ///
+  /// [titleWidget] specifies a custom widget
+  /// to be displayed at the top of the screen.
+  ///
+  /// [loginButton] specifies a custom login button widget.
+  ///
+  /// [titleFlex] specifies the flex value for the title widget.
+  ///
+  /// [formFlex] specifies the flex value for the form widget.
+  ///
+  /// [beforeTitleFlex] specifies the flex value before the title widget.
+  ///
+  /// [afterTitleFlex] specifies the flex value after the title widget.
+
   const AuthScreen({
     required this.appBarTitle,
     required this.steps,
@@ -26,38 +65,79 @@ class AuthScreen extends StatefulWidget {
     this.formFlex,
     this.beforeTitleFlex,
     this.afterTitleFlex,
-    this.isLoading = false,
+    this.maxFormWidth,
     super.key,
-  }) : assert(steps.length > 0, 'At least one step is required');
+  }) : assert(steps.length > 0, "At least one step is required");
 
+  /// The title of the app bar.
   final String appBarTitle;
+
+  /// A function called upon completion of the authentication process.
   final Future<void> Function({
     required HashMap<String, dynamic> values,
     required void Function(int? pageToReturn) onError,
   }) onFinish;
+
+  /// The authentication steps to be completed.
   final List<AuthStep> steps;
+
+  /// The title of the submit button.
   final String submitBtnTitle;
+
+  /// The title of the next button.
   final String nextBtnTitle;
+
+  /// The title of the previous button.
   final String previousBtnTitle;
+
+  /// A custom app bar widget.
   final AppBar? customAppBar;
+
+  /// The alignment of the buttons.
   final MainAxisAlignment? buttonMainAxisAlignment;
+
+  /// The background color of the screen.
   final Color? customBackgroundColor;
-  final Widget Function(Future<void> Function()? onPressed, String label,
-      int step, bool enabled)? nextButtonBuilder;
+
+  /// A custom widget for the button.
+  final Widget Function(
+    Future<void> Function()? onPressed,
+    String label,
+    int step,
+    // ignore: avoid_positional_boolean_parameters
+    bool enabled,
+  )? nextButtonBuilder;
+
+  /// A custom widget for the button.
   final Widget? Function(VoidCallback onPressed, String label, int step)?
       previousButtonBuilder;
+
+  /// A custom widget for the title.
   final Widget? titleWidget;
+
+  /// A custom widget for the login button.
   final Widget? loginButton;
+
+  /// The flex value for the title widget.
   final int? titleFlex;
+
+  /// The flex value for the form widget.
   final int? formFlex;
+
+  /// The flex value before the title widget.
   final int? beforeTitleFlex;
+
+  /// The flex value after the title widget.
   final int? afterTitleFlex;
-  final bool isLoading;
+
+  /// The maximum width of the form.
+  final double? maxFormWidth;
 
   @override
   State<AuthScreen> createState() => _AuthScreenState();
 }
 
+/// The state for [AuthScreen].
 class _AuthScreenState extends State<AuthScreen> {
   final _formKey = GlobalKey<FormState>();
   final _pageController = PageController();
@@ -65,21 +145,27 @@ class _AuthScreenState extends State<AuthScreen> {
   final _animationCurve = Curves.ease;
   bool _formValid = false;
 
+  /// Gets the app bar.
   AppBar get _appBar =>
       widget.customAppBar ??
       AppBar(
+        backgroundColor: const Color(0xffFAF9F6),
         title: Text(widget.appBarTitle),
       );
 
+  /// Handles previous button press.
   void onPrevious() {
     FocusScope.of(context).unfocus();
     _validate(_pageController.page!.toInt() - 1);
+    unawaited(
       _pageController.previousPage(
         duration: _animationDuration,
         curve: _animationCurve,
+      ),
     );
   }
 
+  /// Handles next button press.
   Future<void> onNext(AuthStep step) async {
     if (!_formKey.currentState!.validate()) {
       return;
@@ -100,30 +186,38 @@ class _AuthScreenState extends State<AuthScreen> {
 
       await widget.onFinish(
         values: values,
-        onError: (int? pageToReturn) => _pageController.animateToPage(
-          pageToReturn ?? 0,
+        onError: (int? pageToReturn) {
+          if (pageToReturn == null) {
+            return;
+          }
+          _pageController.animateToPage(
+            pageToReturn,
             duration: _animationDuration,
             curve: _animationCurve,
-        ),
+          );
+        },
       );
 
       return;
     } else {
       _validate(_pageController.page!.toInt() + 1);
+      unawaited(
         _pageController.nextPage(
           duration: _animationDuration,
           curve: _animationCurve,
+        ),
       );
     }
   }
 
+  /// Validates the current step.
   void _validate(int currentPage) {
-    bool isStepValid = true;
+    var isStepValid = true;
 
     // Loop through each field in the current step
     for (var field in widget.steps[currentPage].fields) {
       for (var validator in field.validators) {
-        String? validationResult = validator(field.value);
+        var validationResult = validator(field.value);
         if (validationResult != null) {
           // If any validator returns an error, mark step as invalid and break
           isStepValid = false;
@@ -142,24 +236,20 @@ class _AuthScreenState extends State<AuthScreen> {
 
   @override
   Widget build(BuildContext context) {
-    return widget.isLoading
-        ? const Center(
-            child: SizedBox(
-              height: 120,
-              width: 120,
-              child: CircularProgressIndicator(),
-            ),
-          )
-        : Scaffold(
-            backgroundColor: widget.customBackgroundColor ?? Colors.white,
+    var theme = Theme.of(context);
+    return Scaffold(
+      backgroundColor: widget.customBackgroundColor ?? const Color(0xffFAF9F6),
       appBar: _appBar,
-            body: Form(
+      body: SafeArea(
+        child: Form(
           key: _formKey,
           child: PageView(
             physics: const NeverScrollableScrollPhysics(),
             controller: _pageController,
             children: <Widget>[
-                    for (var i = 0; i < widget.steps.length; i++)
+              for (var currentStep = 0;
+                  currentStep < widget.steps.length;
+                  currentStep++)
                 Column(
                   mainAxisSize: MainAxisSize.min,
                   mainAxisAlignment: MainAxisAlignment.spaceBetween,
@@ -172,7 +262,7 @@ class _AuthScreenState extends State<AuthScreen> {
                           mainAxisSize: MainAxisSize.min,
                           children: [
                             Expanded(
-                                      flex: widget.beforeTitleFlex ?? 3,
+                              flex: widget.beforeTitleFlex ?? 2,
                               child: Container(),
                             ),
                             widget.titleWidget!,
@@ -183,110 +273,149 @@ class _AuthScreenState extends State<AuthScreen> {
                           ],
                         ),
                       ),
-                              Column(
-                                children: [
-                                  Row(
-                                    mainAxisAlignment:
-                                        widget.buttonMainAxisAlignment != null
-                                            ? widget.buttonMainAxisAlignment!
-                                            : (widget.previousButtonBuilder !=
-                                                        null &&
-                                                    widget.previousButtonBuilder
-                                                            ?.call(
-                                                          onPrevious,
-                                                          widget
-                                                              .previousBtnTitle,
-                                                          i,
-                                                        ) ==
-                                                        null)
-                                                ? MainAxisAlignment.start
-                                                : widget.steps.first !=
-                                                        widget.steps[i]
-                                                    ? MainAxisAlignment.center
-                                                    : MainAxisAlignment.end,
-                                    children: [
-                                      if (widget.previousButtonBuilder ==
-                                          null) ...[
-                                        if (widget.steps.first !=
-                                            widget.steps[i])
-                                          ElevatedButton(
-                                            onPressed: onPrevious,
-                                            child: Row(
-                                              children: [
-                                                const Icon(
-                                                  Icons.arrow_back,
-                                                  size: 18,
+                    ],
+                    Expanded(
+                      flex: widget.formFlex ?? 3,
+                      child: Align(
+                        alignment: Alignment.topCenter,
+                        child: ConstrainedBox(
+                          constraints: BoxConstraints(
+                            maxWidth: widget.maxFormWidth ?? 300,
                           ),
-                                                Padding(
-                                                  padding:
-                                                      const EdgeInsets.only(
-                                                          left: 4.0),
-                                                  child: Text(
-                                                      widget.previousBtnTitle),
+                          child: Column(
+                            children: [
+                              for (AuthField field
+                                  in widget.steps[currentStep].fields) ...[
+                                if (field.title != null) ...[
+                                  wrapWithDefaultStyle(
+                                    style: theme.textTheme.headlineLarge!,
+                                    widget: field.title!,
                                   ),
                                 ],
+                                field.build(context, () {
+                                  _validate(currentStep);
+                                }),
+                              ],
+                            ],
                           ),
                         ),
-                                      ] else if (widget.previousButtonBuilder
-                                              ?.call(onPrevious,
-                                                  widget.previousBtnTitle, i) !=
-                                          null) ...[
-                                        widget.previousButtonBuilder!.call(
+                      ),
+                    ),
+                    Column(
+                      children: [
+                        SizedBox(
+                          width: MediaQuery.of(context).size.width,
+                          child: Padding(
+                            padding: const EdgeInsets.symmetric(
+                              horizontal: 20,
+                            ),
+                            child: Row(
+                              mainAxisAlignment: widget.steps.first !=
+                                      widget.steps[currentStep]
+                                  ? MainAxisAlignment.spaceBetween
+                                  : MainAxisAlignment.end,
+                              children: [
+                                if (widget.steps.first !=
+                                    widget.steps[currentStep]) ...[
+                                  widget.previousButtonBuilder?.call(
                                         onPrevious,
                                         widget.previousBtnTitle,
-                                            i)!
+                                        currentStep,
+                                      ) ??
+                                      _stepButton(
+                                        buttonText: widget.previousBtnTitle,
+                                        onTap: () async => onPrevious(),
+                                      ),
+                                  const SizedBox(
+                                    width: 8,
+                                  ),
                                 ],
                                 widget.nextButtonBuilder?.call(
                                       !_formValid
                                           ? null
                                           : () async {
                                               await onNext(
-                                                        widget.steps[i]);
+                                                widget.steps[currentStep],
+                                              );
                                             },
-                                            widget.steps.last == widget.steps[i]
+                                      widget.steps.last ==
+                                              widget.steps[currentStep]
                                           ? widget.submitBtnTitle
                                           : widget.nextBtnTitle,
-                                            i,
+                                      currentStep,
                                       _formValid,
                                     ) ??
-                                          ElevatedButton(
-                                            onPressed: !_formValid
-                                                ? null
-                                                : () async {
-                                                    await onNext(
-                                                        widget.steps[i]);
-                                                  },
-                                            child: Row(
-                                              children: [
-                                                Text(
-                                                  widget.steps.last ==
-                                                          widget.steps[i]
+                                    _stepButton(
+                                      buttonText: widget.steps.last ==
+                                              widget.steps[currentStep]
                                           ? widget.submitBtnTitle
                                           : widget.nextBtnTitle,
-                                                ),
-                                                const Padding(
-                                                  padding: EdgeInsets.only(
-                                                      left: 4.0),
-                                                  child: Icon(
-                                                    Icons.arrow_forward,
-                                                    size: 18,
-                                                  ),
+                                      onTap: () async {
+                                        await onNext(
+                                          widget.steps[currentStep],
+                                        );
+                                      },
                                     ),
                               ],
                             ),
                           ),
-                                    ],
+                        ),
+                        const SizedBox(
+                          height: 8,
                         ),
                         if (widget.loginButton != null)
                           Padding(
                             padding: const EdgeInsets.only(top: 20.0),
-                                      child: widget.loginButton!,
+                            child: widget.loginButton,
                           ),
                       ],
                     ),
                   ],
-                          ]),
-                  ]),
-            ));
+                ),
+            ],
+          ),
+        ),
+      ),
+    );
   }
+
+  Widget _stepButton({
+    required String buttonText,
+    required Future Function()? onTap,
+  }) {
+    var theme = Theme.of(context);
+    return Flexible(
+      child: InkWell(
+        onTap: onTap,
+        child: Container(
+          width: double.infinity,
+          constraints: const BoxConstraints(
+            maxWidth: 180,
+          ),
+          decoration: BoxDecoration(
+            borderRadius: BorderRadius.circular(20),
+            border: Border.all(
+              color: const Color(
+                0xff979797,
+              ),
+            ),
+          ),
+          child: Padding(
+            padding: const EdgeInsets.all(4),
+            child: Text(
+              buttonText,
+              style: theme.textTheme.bodyMedium,
+              textAlign: TextAlign.center,
+            ),
+          ),
+        ),
+      ),
+    );
+  }
+
+  Widget wrapWithDefaultStyle({
+    required Widget widget,
+    required TextStyle style,
+  }) =>
+      DefaultTextStyle(style: style, child: widget);
 }

lib/src/config/example_registration_repository.dart

@@ -0,0 +1,12 @@
+import "dart:collection";
+import "package:flutter/material.dart";
+import "package:flutter_registration/flutter_registration.dart";
+
+/// A registration repository that does nothing.
+class ExampleRegistrationRepository with RegistrationRepository {
+  @override
+  Future<String?> register(HashMap values) {
+    debugPrint("register $values");
+    return Future.value(null);
+  }
+}

lib/src/config/registration_options.dart

@@ -2,86 +2,172 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'dart:async';
+import "dart:async";
 
-import 'package:flutter/material.dart';
-import 'package:flutter_registration/flutter_registration.dart';
+import "package:flutter/material.dart";
+import "package:flutter_registration/flutter_registration.dart";
+import "package:flutter_registration/src/config/example_registration_repository.dart";
 
+/// A set of options for configuring the
+/// registration process in a Flutter application.
 class RegistrationOptions {
+  /// Registration options Constructor
   RegistrationOptions({
-    required this.registrationRepository,
-    required this.registrationSteps,
     required this.afterRegistration,
+    this.registrationRepository,
+    this.registrationSteps,
+    this.titleFlex,
+    this.formFlex,
+    this.beforeTitleFlex,
+    this.afterTitleFlex,
     this.registrationTranslations = const RegistrationTranslations.empty(),
     this.onError,
-    this.customAppbarBuilder,
+    this.customAppbarBuilder = _createCustomAppBar,
     this.nextButtonBuilder,
     this.previousButtonBuilder,
     this.buttonMainAxisAlignment,
     this.backgroundColor,
     this.titleWidget,
     this.loginButton,
-  });
+    this.maxFormWidth,
+    this.beforeRegistration,
+  }) {
+    if (registrationSteps == null || registrationSteps!.isEmpty) {
+      steps = RegistrationOptions.getDefaultSteps();
+    } else {
+      steps = registrationSteps!;
+    }
+    registrationRepository ??= ExampleRegistrationRepository();
+  }
 
+  /// Translations for registration-related messages and prompts.
   final RegistrationTranslations registrationTranslations;
-  final List<AuthStep> registrationSteps;
+
+  /// The steps involved in the registration process.
+  final List<AuthStep>? registrationSteps;
+
+  /// The steps involved in the registration process.
+  List<AuthStep> steps = [];
+
+  /// A function that handles errors during registration.
   final int? Function(String error)? onError;
+
+  /// A callback function executed after successful registration.
   final VoidCallback afterRegistration;
-  final RegistrationRepository registrationRepository;
+
+  /// The repository responsible for registration.
+  RegistrationRepository? registrationRepository;
+
+  /// A function for customizing the app bar displayed during registration.
   final AppBar Function(String title)? customAppbarBuilder;
-  final Widget Function(Future<void> Function()? onPressed, String label,
-      int step, bool enabled)? nextButtonBuilder;
+
+  /// A function for customizing the "Next" button.
+  final Widget Function(
+    Future<void> Function()? onPressed,
+    String label,
+    int step,
+    // ignore: avoid_positional_boolean_parameters
+    bool enabled,
+  )? nextButtonBuilder;
+
+  /// A function for customizing the "Previous" button.
   final Widget? Function(VoidCallback onPressed, String label, int step)?
       previousButtonBuilder;
-  final MainAxisAlignment? buttonMainAxisAlignment;
-  final Color? backgroundColor;
-  Widget? titleWidget;
-  Widget? loginButton;
 
+  /// Specifies the alignment of buttons.
+  final MainAxisAlignment? buttonMainAxisAlignment;
+
+  /// The background color of the registration screen.
+  final Color? backgroundColor;
+
+  /// A custom widget for displaying the registration title.
+  final Widget? titleWidget;
+
+  /// A custom widget for displaying a login button.
+  final Widget? loginButton;
+
+  /// The number of flex units for the title.
+  final int? titleFlex;
+
+  /// The number of flex units for the form.
+  final int? formFlex;
+
+  /// The number of flex units for the buttons.
+  final int? beforeTitleFlex;
+
+  /// The number of flex units for the buttons.
+  final int? afterTitleFlex;
+
+  /// The maximum width of the form. Defaults to 300.
+  final double? maxFormWidth;
+
+  /// This function gets called before the user gets registered.
+  final Future<void> Function()? beforeRegistration;
+
+  /// Generates default registration steps.
+  ///
+  /// [emailController] controller for email input.
+  ///
+  /// [pass1Controller] controller for first password input.
+  ///
+  /// [pass1Hidden] whether the first password field is initially hidden.
+  ///
+  /// [pass2Controller] controller for second password input.
+  ///
+  /// [pass2Hidden] whether the second password field is initially hidden.
+  ///
+  /// [passHideOnChange] function triggered when password visibility changes.
+  ///
+  /// [translations] translations for default registration messages and prompts.
+  ///
+  /// [titleBuilder] function for customizing step titles.
+  ///
+  /// [labelBuilder] function for customizing field labels.
+  ///
+  /// [textStyle] text style for input fields.
+  ///
+  /// [initialEmail] initial value for email input.
   static List<AuthStep> getDefaultSteps({
     TextEditingController? emailController,
-    TextEditingController? pass1Controller,
-    bool pass1Hidden = true,
-    TextEditingController? pass2Controller,
-    bool pass2Hidden = true,
+    TextEditingController? passController,
+    bool passHidden = true,
+    // ignore: avoid_positional_boolean_parameters
     Function(bool mainPass, bool value)? passHideOnChange,
     RegistrationTranslations translations =
         const RegistrationTranslations.empty(),
     Function(String title)? titleBuilder,
     Function(String label)? labelBuilder,
     TextStyle? textStyle,
+    TextStyle? hintStyle,
     String? initialEmail,
-  }) {
-    var password1 = '';
-
-    return [
+  }) =>
+      [
         AuthStep(
           fields: [
             AuthTextField(
-            name: 'email',
+              name: "email",
               textEditingController: emailController,
-            value: initialEmail ?? '',
-            title: titleBuilder?.call(
-                  translations.defaultEmailTitle,
-                ) ??
+              value: initialEmail ?? "",
+              title: titleBuilder?.call(translations.defaultEmailTitle) ??
                   Padding(
-                  padding: const EdgeInsets.only(
-                    top: 24.0,
-                    bottom: 12.0,
-                  ),
+                    padding: const EdgeInsets.only(top: 180),
                     child: Text(
                       translations.defaultEmailTitle,
-                    style: const TextStyle(
-                      fontWeight: FontWeight.bold,
-                    ),
                     ),
                   ),
+              textInputType: TextInputType.emailAddress,
               textFieldDecoration: InputDecoration(
+                hintStyle: hintStyle,
+                contentPadding: const EdgeInsets.symmetric(horizontal: 8),
                 label: labelBuilder?.call(translations.defaultEmailLabel),
                 hintText: translations.defaultEmailHint,
+                border: const OutlineInputBorder(),
+                focusedBorder: const OutlineInputBorder(),
               ),
               textStyle: textStyle,
+              padding: const EdgeInsets.symmetric(vertical: 20),
               validators: [
+                // ignore: avoid_dynamic_calls
                 (email) => (email == null || email.isEmpty)
                     ? translations.defaultEmailEmpty
                     : null,
@@ -91,83 +177,52 @@ class RegistrationOptions {
                         ? null
                         : translations.defaultEmailValidatorMessage,
               ],
-          )
+            ),
           ],
         ),
         AuthStep(
           fields: [
             AuthPassField(
-            name: 'password1',
-            textEditingController: pass1Controller,
-            title: titleBuilder?.call(
-                  translations.defaultPassword1Title,
-                ) ??
+              name: "password",
+              textEditingController: passController,
+              title: titleBuilder?.call(translations.defaultPasswordTitle) ??
                   Padding(
-                  padding: const EdgeInsets.only(
-                    top: 24.0,
-                    bottom: 12.0,
-                  ),
+                    padding: const EdgeInsets.only(top: 180),
                     child: Text(
-                    translations.defaultPassword1Title,
-                    style: const TextStyle(
-                      fontWeight: FontWeight.bold,
-                    ),
+                      translations.defaultPasswordTitle,
                     ),
                   ),
               textFieldDecoration: InputDecoration(
-              label: labelBuilder?.call(translations.defaultPassword1Label),
-              hintText: translations.defaultPassword1Hint,
-            ),
-            textStyle: textStyle,
-            validators: [
-              (value) => (value == null || value.isEmpty)
-                  ? translations.defaultPassword1ValidatorMessage
-                  : null,
-            ],
-            onChange: (value) {
-              password1 = value;
-            },
-          ),
-          AuthPassField(
-            name: 'password2',
-            textEditingController: pass2Controller,
-            title: titleBuilder?.call(
-                  translations.defaultPassword2Title,
-                ) ??
-                Padding(
-                  padding: const EdgeInsets.only(
-                    top: 24.0,
-                    bottom: 12.0,
-                  ),
-                  child: Text(
-                    translations.defaultPassword2Title,
-                    style: const TextStyle(
-                      fontWeight: FontWeight.bold,
-                    ),
-                  ),
-                ),
-            textFieldDecoration: InputDecoration(
-              label: labelBuilder?.call(translations.defaultPassword2Label),
-              hintText: translations.defaultPassword2Hint,
+                hintStyle: hintStyle,
+                contentPadding: const EdgeInsets.symmetric(horizontal: 8),
+                label: labelBuilder?.call(translations.defaultPasswordLabel),
+                hintText: translations.defaultPasswordHint,
+                border: const OutlineInputBorder(),
+                focusedBorder: const OutlineInputBorder(),
               ),
+              padding: const EdgeInsets.symmetric(vertical: 20),
               textStyle: textStyle,
               validators: [
                 (value) {
-                if (pass1Controller != null) {
-                  if (value != pass1Controller.value.text) {
-                    return translations.defaultPassword2ValidatorMessage;
-                  }
-                } else {
-                  if (value != password1) {
-                    return translations.defaultPassword2ValidatorMessage;
+                  // ignore: avoid_dynamic_calls
+                  if (value == null || value.isEmpty) {
+                    return translations.defaultPasswordValidatorMessage;
                   }
+                  // ignore: avoid_dynamic_calls
+                  if (value.length < 6) {
+                    return translations.defaultPasswordToShortValidatorMessage;
                   }
                   return null;
-              }
+                },
               ],
             ),
           ],
         ),
       ];
 }
-}
+
+AppBar _createCustomAppBar(String title) => AppBar(
+      iconTheme: const IconThemeData(color: Colors.black, size: 16),
+      title: Text(title),
+      backgroundColor: Colors.transparent,
+    );

lib/src/config/registration_translations.dart

@@ -2,8 +2,10 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-/// Holds all the translations for the standard elements on the registration screen.
+/// Holds all the translations for the standard elements
+/// on the registration screen.
 class RegistrationTranslations {
+  /// Constructs a [RegistrationTranslations] object.
   const RegistrationTranslations({
     required this.title,
     required this.registerBtn,
@@ -15,56 +17,78 @@ class RegistrationTranslations {
     required this.defaultEmailHint,
     required this.defaultEmailEmpty,
     required this.defaultEmailValidatorMessage,
-    required this.defaultPassword1Title,
-    required this.defaultPassword1Label,
-    required this.defaultPassword1Hint,
-    required this.defaultPassword1ValidatorMessage,
-    required this.defaultPassword2Title,
-    required this.defaultPassword2Label,
-    required this.defaultPassword2Hint,
-    required this.defaultPassword2ValidatorMessage,
+    required this.defaultPasswordTitle,
+    required this.defaultPasswordLabel,
+    required this.defaultPasswordHint,
+    required this.defaultPasswordValidatorMessage,
+    required this.defaultPasswordToShortValidatorMessage,
   });
 
+  /// Constructs a [RegistrationTranslations] object with empty strings.
   const RegistrationTranslations.empty()
-      : title = 'Register',
-        registerBtn = 'Register',
-        previousStepBtn = 'Previous',
-        nextStepBtn = 'Next',
-        closeBtn = 'Close',
-        defaultEmailTitle = 'What is your email?',
-        defaultEmailLabel = '',
-        defaultEmailHint = 'john.doe@domain.com',
-        defaultEmailEmpty = 'Enter your email',
-        defaultEmailValidatorMessage = 'Enter a valid email address',
-        defaultPassword1Title = 'Enter a password',
-        defaultPassword1Label = '',
-        defaultPassword1Hint = '',
-        defaultPassword1ValidatorMessage = 'Enter a valid password',
-        defaultPassword2Title = 'Re-enter password',
-        defaultPassword2Label = '',
-        defaultPassword2Hint = '',
-        defaultPassword2ValidatorMessage = 'Passwords have to be equal';
+      : title = "",
+        registerBtn = "Register",
+        previousStepBtn = "Previous",
+        nextStepBtn = "Next",
+        closeBtn = "Close",
+        defaultEmailTitle = "enter your email address",
+        defaultEmailLabel = "",
+        defaultEmailHint = "Email address",
+        defaultEmailEmpty = "Please enter your email address.",
+        defaultEmailValidatorMessage = "Please enter a valid email address.",
+        defaultPasswordTitle = "choose a password",
+        defaultPasswordLabel = "",
+        defaultPasswordHint = "Password",
+        defaultPasswordValidatorMessage = "Enter a valid password",
+        defaultPasswordToShortValidatorMessage =
+            "Password needs to be at least 6 characters long";
 
+  /// The title of the registration screen.
   final String title;
-  final String registerBtn;
-  final String previousStepBtn;
-  final String nextStepBtn;
-  final String closeBtn;
-  final String defaultEmailTitle;
-  final String defaultEmailLabel;
-  final String defaultEmailHint;
-  final String defaultEmailEmpty;
-  final String defaultEmailValidatorMessage;
-  final String defaultPassword1Title;
-  final String defaultPassword1Label;
-  final String defaultPassword1Hint;
-  final String defaultPassword1ValidatorMessage;
-  final String defaultPassword2Title;
-  final String defaultPassword2Label;
-  final String defaultPassword2Hint;
-  final String defaultPassword2ValidatorMessage;
 
-  // create a copywith
+  /// The text for the registration button.
+  final String registerBtn;
+
+  /// The text for the previous step button.
+  final String previousStepBtn;
+
+  /// The text for the next step button.
+  final String nextStepBtn;
+
+  /// The text for the close button.
+  final String closeBtn;
+
+  /// The title for the default email field.
+  final String defaultEmailTitle;
+
+  /// The label for the default email field.
+  final String defaultEmailLabel;
+
+  /// The hint for the default email field.
+  final String defaultEmailHint;
+
+  /// The message for an empty default email field.
+  final String defaultEmailEmpty;
+
+  /// The message for an invalid default email field.
+  final String defaultEmailValidatorMessage;
+
+  /// The title for the default password field.
+  final String defaultPasswordTitle;
+
+  /// The label for the default password field.
+  final String defaultPasswordLabel;
+
+  /// The hint for the default password field.
+  final String defaultPasswordHint;
+
+  /// The message for an invalid default password field.
+  final String defaultPasswordValidatorMessage;
+
+  /// The message for a default password that is too short.
+  final String defaultPasswordToShortValidatorMessage;
+
+  /// create a copywith
   RegistrationTranslations copyWith({
     String? title,
     String? registerBtn,
@@ -76,16 +100,13 @@ class RegistrationTranslations {
     String? defaultEmailHint,
     String? defaultEmailEmpty,
     String? defaultEmailValidatorMessage,
-    String? defaultPassword1Title,
-    String? defaultPassword1Label,
-    String? defaultPassword1Hint,
-    String? defaultPassword1ValidatorMessage,
-    String? defaultPassword2Title,
-    String? defaultPassword2Label,
-    String? defaultPassword2Hint,
-    String? defaultPassword2ValidatorMessage,
-  }) {
-    return RegistrationTranslations(
+    String? defaultPasswordTitle,
+    String? defaultPasswordLabel,
+    String? defaultPasswordHint,
+    String? defaultPasswordValidatorMessage,
+    String? defaultPasswordToShortValidatorMessage,
+  }) =>
+      RegistrationTranslations(
         title: title ?? this.title,
         registerBtn: registerBtn ?? this.registerBtn,
         previousStepBtn: previousStepBtn ?? this.previousStepBtn,
@@ -97,20 +118,13 @@ class RegistrationTranslations {
         defaultEmailEmpty: defaultEmailEmpty ?? this.defaultEmailEmpty,
         defaultEmailValidatorMessage:
             defaultEmailValidatorMessage ?? this.defaultEmailValidatorMessage,
-      defaultPassword1Title:
-          defaultPassword1Title ?? this.defaultPassword1Title,
-      defaultPassword1Label:
-          defaultPassword1Label ?? this.defaultPassword1Label,
-      defaultPassword1Hint: defaultPassword1Hint ?? this.defaultPassword1Hint,
-      defaultPassword1ValidatorMessage: defaultPassword1ValidatorMessage ??
-          this.defaultPassword1ValidatorMessage,
-      defaultPassword2Title:
-          defaultPassword2Title ?? this.defaultPassword2Title,
-      defaultPassword2Label:
-          defaultPassword2Label ?? this.defaultPassword2Label,
-      defaultPassword2Hint: defaultPassword2Hint ?? this.defaultPassword2Hint,
-      defaultPassword2ValidatorMessage: defaultPassword2ValidatorMessage ??
-          this.defaultPassword2ValidatorMessage,
+        defaultPasswordTitle: defaultPasswordTitle ?? this.defaultPasswordTitle,
+        defaultPasswordLabel: defaultPasswordLabel ?? this.defaultPasswordLabel,
+        defaultPasswordHint: defaultPasswordHint ?? this.defaultPasswordHint,
+        defaultPasswordValidatorMessage: defaultPasswordValidatorMessage ??
+            this.defaultPasswordValidatorMessage,
+        defaultPasswordToShortValidatorMessage:
+            defaultPasswordToShortValidatorMessage ??
+                this.defaultPasswordToShortValidatorMessage,
       );
 }
-}

lib/src/model/auth_action.dart

@@ -2,14 +2,19 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter/material.dart';
+import "package:flutter/material.dart";
 
+/// An action that can be performed during authentication.
 class AuthAction {
+  /// Constructs an [AuthAction] object.
   AuthAction({
     required this.title,
     required this.onPress,
   });
 
+  /// The title of the action.
   final String title;
+
+  /// A callback function triggered when the action is pressed.
   final VoidCallback onPress;
 }

lib/src/model/auth_bool_field.dart

@@ -2,11 +2,34 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter/material.dart';
-import 'package:flutter_input_library/flutter_input_library.dart';
-import 'package:flutter_registration/flutter_registration.dart';
+import "package:flutter/material.dart";
+import "package:flutter_input_library/flutter_input_library.dart";
+import "package:flutter_registration/flutter_registration.dart";
 
+/// A field for capturing boolean values in a Flutter form.
+///
+/// Extends [AuthField].
 class AuthBoolField extends AuthField {
+  /// Constructs an [AuthBoolField] object.
+  ///
+  /// [name] specifies the name of the field.
+  ///
+  /// [widgetType] defines the type of boolean widget to use.
+  ///
+  /// [title] specifies the title of the field (optional).
+  ///
+  /// [validators] defines a list of validation functions for the field.
+  ///
+  /// [value] specifies the initial value of the field (default is false).
+  ///
+  /// [leftWidget] is a widget to be displayed on the
+  /// left side of the boolean widget.
+  ///
+  /// [rightWidget] is a widget to be displayed on the
+  /// right side of the boolean widget.
+  ///
+  /// [onChange] is a callback function triggered when
+  /// the value of the field changes.
   AuthBoolField({
     required super.name,
     required this.widgetType,
@@ -18,18 +41,26 @@ class AuthBoolField extends AuthField {
     this.onChange,
   });
 
+  /// A widget to be displayed on the left side of the boolean widget.
   final Widget? leftWidget;
+
+  /// A widget to be displayed on the right side of the boolean widget.
   final Widget? rightWidget;
+
+  /// The type of boolean widget to use.
   final BoolWidgetType widgetType;
+
+  /// A callback function triggered when the value of the field changes.
   final Function(String value)? onChange;
 
   @override
-  Widget build(BuildContext context, Function onValueChanged) {
-    return FlutterFormInputBool(
+  Widget build(BuildContext context, Function onValueChanged) =>
+      FlutterFormInputBool(
         widgetType: widgetType,
         onChanged: (v) {
           value = v;
           onChange?.call(value);
+          // ignore: avoid_dynamic_calls
           onValueChanged();
         },
         validator: (value) {
@@ -45,4 +76,3 @@ class AuthBoolField extends AuthField {
         rightWidget: rightWidget,
       );
 }
-}

lib/src/model/auth_drop_down.dart

@@ -1,46 +1,65 @@
-import 'package:flutter/material.dart';
-import 'package:flutter_registration/flutter_registration.dart';
+import "package:flutter/material.dart";
+import "package:flutter_registration/flutter_registration.dart";
 
+/// A field for capturing dropdown selections in a Flutter form.
+///
+/// Extends [AuthField].
 class AuthDropdownField extends AuthField {
+  /// Constructs an [AuthDropdownField] object.
   AuthDropdownField({
     required super.name,
     required this.items,
     required this.onChanged,
+    required super.value,
     this.dropdownDecoration,
     this.padding = const EdgeInsets.all(8.0),
     this.textStyle,
     this.icon = const Icon(Icons.keyboard_arrow_down),
-    required super.value,
   }) {
     selectedValue = value ?? items.first;
   }
 
+  /// The list of items for the dropdown.
   final List<String> items;
+
+  /// A callback function triggered when the dropdown value changes.
   final Function(String?) onChanged;
+
+  /// The currently selected value in the dropdown.
   String? selectedValue;
+
+  /// The decoration for the dropdown.
   final InputDecoration? dropdownDecoration;
+
+  /// The padding around the dropdown.
   final EdgeInsets padding;
+
+  /// The text style for the dropdown.
   final TextStyle? textStyle;
+
+  /// The icon to be displayed with the dropdown.
   final Icon icon;
 
   @override
-  Widget build(BuildContext context, Function onValueChanged) {
-    return Padding(
+  Widget build(BuildContext context, Function onValueChanged) => Padding(
         padding: padding,
         child: DropdownButtonFormField<String>(
           icon: icon,
           style: textStyle,
           value: selectedValue,
           decoration: dropdownDecoration,
-        items: items.map((String value) {
-          return DropdownMenuItem<String>(
+          items: items
+              .map(
+                (String value) => DropdownMenuItem<String>(
                   value: value,
                   child: Text(value),
-          );
-        }).toList(),
+                ),
+              )
+              .toList(),
           onChanged: (newValue) {
             selectedValue = newValue;
             onChanged(newValue);
+            // ignore: avoid_dynamic_calls
             onValueChanged();
           },
           validator: (value) {
@@ -57,4 +76,3 @@ class AuthDropdownField extends AuthField {
         ),
       );
 }
-}

lib/src/model/auth_exception.dart

@@ -2,12 +2,14 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
+/// An exception thrown when an authentication error occurs.
 class AuthException implements Exception {
+  /// Constructs an [AuthException] object.
   AuthException(this.message);
+
+  /// The error message.
   final String message;
 
   @override
-  String toString() {
-    return message;
-  }
+  String toString() => message;
 }

lib/src/model/auth_field.dart

@@ -2,9 +2,25 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter/material.dart';
+import "package:flutter/material.dart";
 
+/// An abstract class representing a field in a Flutter form.
+///
+/// [T] represents the type of value stored in the field.
 abstract class AuthField<T> {
+  /// Constructs an [AuthField] object.
+  ///
+  /// [name] specifies the name of the field.
+  ///
+  /// [value] specifies the initial value of the field.
+  ///
+  /// [onValueChanged] is a callback function triggered when the
+  /// value of the field changes (optional).
+  ///
+  /// [title] specifies the title widget of the field (optional).
+  ///
+  /// [validators] defines a list of validation
+  /// functions for the field (optional).
   AuthField({
     required this.name,
     required this.value,
@@ -13,12 +29,26 @@ abstract class AuthField<T> {
     this.validators = const [],
   });
 
+  /// The name of the field.
   final String name;
-  final Widget? title;
-  List<String? Function(T?)> validators;
+
+  /// The initial value of the field.
   T value;
 
-  final Function(T)? onValueChanged; // Callback for value changes
+  /// A callback function triggered when the value of the field changes.
+  final Function(T)? onValueChanged;
 
+  /// The title widget of the field.
+  final Widget? title;
+
+  /// A list of validation functions for the field.
+  List<String? Function(T?)> validators;
+
+  /// Builds the widget representing the field.
+  ///
+  /// [context] The build context.
+  ///
+  /// [onValueChanged] A function to be called when
+  /// the value of the field changes.
   Widget build(BuildContext context, Function onValueChanged);
 }

lib/src/model/auth_pass_field.dart

@@ -2,17 +2,47 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter/material.dart';
-import 'package:flutter_input_library/flutter_input_library.dart';
-import 'package:flutter_registration/flutter_registration.dart';
+import "package:flutter/material.dart";
+import "package:flutter_input_library/flutter_input_library.dart";
+import "package:flutter_registration/flutter_registration.dart";
 
+/// A field for capturing password inputs in a Flutter form.
+///
+/// Extends [AuthField].
 class AuthPassField extends AuthField {
+  /// Constructs an [AuthPassField] object.
+  ///
+  /// [name] specifies the name of the field.
+  ///
+  /// [textEditingController] controller for the password input (optional).
+  ///
+  /// [title] specifies the title widget of the field (optional).
+  ///
+  /// [validators] defines a list of validation
+  /// functions for the field (optional).
+  ///
+  /// [value] specifies the initial value of the
+  /// field (default is an empty string).
+  ///
+  /// [textStyle] defines the text style for the password input.
+  ///
+  /// [onChange] is a callback function triggered when
+  /// the value of the field changes.
+  ///
+  /// [iconSize] specifies the size of the icon displayed
+  /// with the password input (optional).
+  ///
+  /// [textFieldDecoration] defines the decoration for the
+  /// password input field (optional).
+  ///
+  /// [padding] defines the padding around the password input
+  /// field (default is EdgeInsets.all(8.0)).
   AuthPassField({
     required super.name,
-    TextEditingController? textEditingController,
+    this.textEditingController,
     super.title,
     super.validators = const [],
-    super.value = '',
+    super.value = "",
     this.textStyle,
     this.onChange,
     this.iconSize,
@@ -20,15 +50,26 @@ class AuthPassField extends AuthField {
     this.padding = const EdgeInsets.all(8.0),
   });
 
+  /// The text style for the password input.
   final TextStyle? textStyle;
+
+  /// The size of the icon displayed with the password input.
   final double? iconSize;
+
+  /// A callback function triggered when the value of the field changes.
   final Function(String value)? onChange;
+
+  /// The decoration for the password input field.
   final InputDecoration? textFieldDecoration;
+
+  /// The padding around the password input field.
   final EdgeInsets padding;
 
+  /// The controller for the password input.
+  final TextEditingController? textEditingController;
+
   @override
-  Widget build(BuildContext context, Function onValueChanged) {
-    return Padding(
+  Widget build(BuildContext context, Function onValueChanged) => Padding(
         padding: padding,
         child: FlutterFormInputPassword(
           style: textStyle,
@@ -37,6 +78,7 @@ class AuthPassField extends AuthField {
           onChanged: (v) {
             value = v;
             onChange?.call(value);
+            // ignore: avoid_dynamic_calls
             onValueChanged();
           },
           validator: (value) {
@@ -52,4 +94,3 @@ class AuthPassField extends AuthField {
         ),
       );
 }
-}

lib/src/model/auth_step.dart

@@ -2,12 +2,15 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter_registration/src/model/auth_field.dart';
+import "package:flutter_registration/src/model/auth_field.dart";
 
+/// A step in the authentication process.
 class AuthStep {
+  /// Constructs an [AuthStep] object.
   AuthStep({
     required this.fields,
   });
 
+  /// The fields in the step.
   List<AuthField> fields;
 }

lib/src/model/auth_text_field.dart

@@ -2,42 +2,83 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'package:flutter/material.dart';
-import 'package:flutter_registration/flutter_registration.dart';
+import "package:flutter/material.dart";
+import "package:flutter_registration/flutter_registration.dart";
 
+/// A field for capturing text inputs in a Flutter form.
+///
+/// Extends [AuthField].
 class AuthTextField extends AuthField {
+  /// Constructs an [AuthTextField] object.
+  ///
+  /// [name] specifies the name of the field.
+  ///
+  /// [textEditingController] controller for the text input (optional).
+  ///
+  /// [title] specifies the title widget of the field (optional).
+  ///
+  /// [validators] defines a list of validation
+  /// functions for the field (optional).
+  ///
+  /// [value] specifies the initial value of the
+  /// field (default is an empty string).
+  ///
+  /// [textStyle] defines the text style for the text input.
+  ///
+  /// [onChange] is a callback function triggered
+  /// when the value of the field changes.
+  ///
+  /// [textFieldDecoration] defines the decoration
+  /// for the text input field (optional).
+  ///
+  /// [padding] defines the padding around the text
+  /// input field (default is EdgeInsets.all(8.0)).
   AuthTextField({
     required super.name,
     TextEditingController? textEditingController,
     super.title,
     super.validators = const [],
-    super.value = '',
+    super.value = "",
     this.textStyle,
     this.onChange,
     this.textFieldDecoration,
     this.padding = const EdgeInsets.all(8.0),
+    this.textInputType,
   }) {
     textController =
         textEditingController ?? TextEditingController(text: value);
   }
 
+  /// The controller for the text input.
   late TextEditingController textController;
+
+  /// The text style for the text input.
   final TextStyle? textStyle;
+
+  /// A callback function triggered when the value of the field changes.
   final Function(String value)? onChange;
+
+  /// The decoration for the text input field.
   final InputDecoration? textFieldDecoration;
+
+  /// The padding around the text input field.
   final EdgeInsets padding;
 
+  /// The type of text input.
+  final TextInputType? textInputType;
+
   @override
-  Widget build(BuildContext context, Function onValueChanged) {
-    return Padding(
+  Widget build(BuildContext context, Function onValueChanged) => Padding(
         padding: padding,
         child: TextFormField(
+          keyboardType: textInputType,
           style: textStyle,
           decoration: textFieldDecoration,
           controller: textController,
           onChanged: (v) {
             value = v;
             onChange?.call(value);
+            // ignore: avoid_dynamic_calls
             onValueChanged();
           },
           validator: (value) {
@@ -53,4 +94,3 @@ class AuthTextField extends AuthField {
         ),
       );
 }
-}

lib/src/registration_screen.dart

@@ -1,34 +1,37 @@
-import 'dart:collection';
+import "dart:collection";
 
-import 'package:flutter/material.dart';
-import 'package:flutter_registration/flutter_registration.dart';
-import 'package:flutter_registration/src/auth_screen.dart';
+import "package:flutter/material.dart";
+import "package:flutter_registration/flutter_registration.dart";
+import "package:flutter_registration/src/auth_screen.dart";
 
+/// A screen for user registration.
 class RegistrationScreen extends StatefulWidget {
+  /// Constructs a [RegistrationScreen] object.
+  ///
+  /// [registrationOptions] specifies the registration options.
   const RegistrationScreen({
     required this.registrationOptions,
-    Key? key,
-  }) : super(key: key);
+    super.key,
+  });
 
+  /// The registration options.
   final RegistrationOptions registrationOptions;
 
   @override
   RegistrationScreenState createState() => RegistrationScreenState();
 }
 
+/// The state for [RegistrationScreen].
 class RegistrationScreenState extends State<RegistrationScreen> {
-  bool _isLoading = false;
-
+  /// Registers the user.
   Future<void> _register({
     required HashMap<String, dynamic> values,
     required void Function(int? pageToReturn) onError,
   }) async {
     try {
-      setState(() {
-        _isLoading = true;
-      });
+      await widget.registrationOptions.beforeRegistration?.call();
 
-      var registered = await widget.registrationOptions.registrationRepository
+      var registered = await widget.registrationOptions.registrationRepository!
           .register(values);
 
       if (registered == null) {
@@ -38,12 +41,8 @@ class RegistrationScreenState extends State<RegistrationScreen> {
 
         onError(pageToReturn);
       }
-    } catch (e) {
-      onError(0);
-    } finally {
-      setState(() {
-        _isLoading = false;
-      });
+    } on Exception catch (_) {
+      onError(null);
     }
   }
 
@@ -52,7 +51,7 @@ class RegistrationScreenState extends State<RegistrationScreen> {
     var translations = widget.registrationOptions.registrationTranslations;
 
     return AuthScreen(
-      steps: widget.registrationOptions.registrationSteps,
+      steps: widget.registrationOptions.steps,
       customAppBar: widget.registrationOptions.customAppbarBuilder?.call(
         translations.title,
       ),
@@ -68,7 +67,11 @@ class RegistrationScreenState extends State<RegistrationScreen> {
       customBackgroundColor: widget.registrationOptions.backgroundColor,
       titleWidget: widget.registrationOptions.titleWidget,
       loginButton: widget.registrationOptions.loginButton,
-      isLoading: _isLoading,
+      titleFlex: widget.registrationOptions.titleFlex,
+      formFlex: widget.registrationOptions.formFlex,
+      beforeTitleFlex: widget.registrationOptions.beforeTitleFlex,
+      afterTitleFlex: widget.registrationOptions.afterTitleFlex,
+      maxFormWidth: widget.registrationOptions.maxFormWidth,
     );
   }
 }

lib/src/service/registration_repository.dart

@@ -2,8 +2,10 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import 'dart:collection';
+import "dart:collection";
 
+/// A mixin for a registration repository.
 mixin RegistrationRepository {
+  /// Registers a user with the given values.
   Future<String?> register(HashMap values);
 }

pubspec.yaml

@@ -4,20 +4,19 @@
 
 name: flutter_registration
 description: A Flutter Registration package
-version: 2.0.1
+version: 3.0.0
 repository: https://github.com/Iconica-Development/flutter_registration
 
-publish_to: none
+publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub
 
 environment:
-  sdk: ">=2.18.0 <3.0.0"
+  sdk: ">=3.0.0 <4.0.0"
   flutter: ">=1.17.0"
 
 dependencies:
   flutter_input_library:
-    git:
-      url: https://github.com/Iconica-Development/flutter_input_library
-      ref: 3.1.0
+    hosted: https://forgejo.internal.iconica.nl/api/packages/internal/pub
+    version: ^3.6.0
 
   flutter:
     sdk: flutter
@@ -27,6 +26,9 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  flutter_lints: ^2.0.0
+  flutter_iconica_analysis:
+    git:
+      url: https://github.com/Iconica-Development/flutter_iconica_analysis
+      ref: 7.0.0
 
 flutter:

test/flutter_email_password_login_test.dart

@@ -3,10 +3,10 @@
 // SPDX-License-Identifier: BSD-3-Clause
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-import 'package:flutter_test/flutter_test.dart';
+import "package:flutter_test/flutter_test.dart";
 
 void main() {
-  test('test', () {
+  test("test", () {
     expect(true, true);
   });
 }