at_sync_ui_flutter 1.0.8 icon indicating copy to clipboard operation
at_sync_ui_flutter: ^1.0.8 copied to clipboard

A Flutter plugin project to provide UI widgets for displaying status of sync process in atProtocol apps.

example/EXAMPLE.md

at_sync_ui_flutter example #

The [at_sync_ui_flutter] package is designed to make it easy for displaying status of sync process in atProtocol apps.

Give it a try #

This package includes a working sample application in the example directory that demonstrates the key features of the package. To create a personalized copy, use at_app create as shown below or check it out on GitHub.

$ flutter pub global activate at_app 
$ at_app create --sample=<package ID> <app name> 
$ cd <app name>
$ flutter run

Notes:

  1. You only need to run flutter pub global activate once
  2. Use at_app.bat for Windows

How it works #

Like most applications built for the atPlatform, we start with the at_onboarding_flutter widget which handles secure management of secret keys for an atsign as cryptographically secure replacement for usernames and passwords.

We use the [Onboarding()] widget in our [main.dart] and navigate to our [second_screen.dart] after successfully onboarding.

If you want to remove any already paired atsign, use the Clear paired atsigns button, it will remove all the paired atsigns for this example package.

As the [at_sync_ui_flutter] package has to be initialised, so we initialise it in the [init()] of second_screen.dart by calling

    AtSyncUIService().init(
        appNavigator: NavService.navKey,
        onSuccessCallback: _onSuccessCallback,
        onErrorCallback: _onErrorCallback,
    );

The [second_screen.dart] consists of the following functions:

  • Default Sync - Will call the sync function and show the UI selected in the init() of AtSyncUIService().
  • Sync with dialog overlay - Will call the sync function and show the dialog with an overlay. The background will not be responsive.
  • Sync with snackbar - Will call the sync function and show the snackbar with an overlay. The background will be responsive.
  • See all UI options - Will navigate to UIOptions() screen which displays all type of UI options available in the package.

Open source usage and contributions #

Like everything else we do, this package and even the sample application are open source software which means we love it when you gift us with your feedback, contributions and even any bugs that you help us to discover. See CONTRIBUTING.md for detailed guidance on how to setup tools, tests and make a pull request.

3
likes
120
pub points
74%
popularity

Publisher

verified publisher iconatsign.org

A Flutter plugin project to provide UI widgets for displaying status of sync process in atProtocol apps.

Homepage
View/report issues

Documentation

API reference

License

Icon for licenses.BSD-3-Clause (LICENSE)

Dependencies

at_client, at_client_mobile, at_common_flutter, flutter

More

Packages that depend on at_sync_ui_flutter