A registration widget in Flutter allowing for custom wizards in regards to user creation
Find a file
2024-02-13 13:34:32 +01:00
.github feat(documentation): Create component-documentation.yml workflow file 2024-02-13 13:34:32 +01:00
example feat: register function can now return a nullable string 2023-09-20 11:45:55 +02:00
lib feat: ability to wait for the onfinished 2023-10-16 15:46:23 +02:00
LICENSES initial version 2022-09-20 15:51:22 +02:00
test Add BSD-3-Clause license 2022-11-01 09:19:20 +01:00
.gitignore initial version 2022-09-20 15:51:22 +02:00
analysis_options.yaml - feat: add customBackgroundColor to AuthScreen 2023-03-31 11:20:21 +02:00
bitbucket-pipelines.yml initial version 2022-09-20 15:51:22 +02:00
CHANGELOG.md fix: Changelog 2023-10-16 15:47:39 +02:00
CONTRIBUTING.md initial version 2022-09-20 15:51:22 +02:00
flutter_registration.gif feat: improved README, fixed example, added GIF, added Github Actions, added dependabot 2023-03-31 11:30:37 +02:00
LICENSE Add BSD-3-Clause license 2022-11-01 09:19:20 +01:00
pubspec.yaml fix: Changelog 2023-10-16 15:47:39 +02:00
README.md feat: improved README, fixed example, added GIF, added Github Actions, added dependabot 2023-03-31 11:30:37 +02:00

pub package Build status style: effective dart

Flutter Registration

Flutter Registration is a package to easily implement a registration flow in your app.

Registration GIF

Setup

To use this package, add flutter_registration as a dependency in your pubspec.yaml file.

How to use

To configure the registration plug-in use the RegistrationScreen widget.

void main() {
  runApp(
    MaterialApp(
      home: RegistrationScreen(
        registrationOptions: RegistrationOptions(
          registrationRepository: ExampleRegistrationRepository(),
          registrationSteps: RegistrationOptions.defaultSteps,
          afterRegistration: () {
            debugPrint('Registered!');
          },
        ),
      ),
    ),
  );
}

You are required to provide your own RegistrationRepository, this can be done using the parameter registrationRepository within the RegistrationsOptions which can be assigned to the RegistrationScreen widget.

A RegistrationRepository is responsible for sending the provided user details (email address and password for example) to an API.

An example for creating a RegistrationRepository is specificied below:

class ExampleRegistrationRepository with RegistrationRepository {
  @override
  Future<bool> register(HashMap values) {
    debugPrint('register: $values');
    return Future.value(true);
  }
}

See the Example Code for an example on how to use this package.

Issues

Please file any issues, bugs or feature request as an issue on our GitHub page. Commercial support is available if you need help with integration with your app or services. You can contact us at support@iconica.nl.

Want to contribute

If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our contribution guide and send us your pull request.

Author

This flutter_registration for Flutter is developed by Iconica. You can contact us at support@iconica.nl