Zap Flutter Package #

The Zap package provides a set of extensions and utilities to enhance the functionality of Flutter applications. It includes features for navigation, validation, localization, and local storage using SQLite.

Table of Contents #

1. ZapX Extension
2. ZapValidator Extension
3. TranslationExtension Extension
4. ZapStore Class
5. ZapNavigation Extension

ZapX Extension #

The ZapX extension provides utility properties for the ZapInterface class, offering convenient access to common properties related to the device and app.

Properties: #

1. navigatorKey: A key for accessing the navigator state.

2. context: Returns the current BuildContext using the navigator key.

3. isDarkMode: Indicates whether the app is currently in dark mode.

4. height: Returns the height of the device screen.

...

ZapValidator Extension #

The ZapValidator extension provides common validation methods for ZapInterface.

Methods: #

1. isValidEmail(String value): Validates if the given value is a valid email address.

2. isValidPassword(String value, {int minLength, bool requireUppercase, bool requireDigit, bool requireSpecialChar}): Validates if the given value is a valid password with optional criteria.

...

TranslationExtension Extension #

The TranslationExtension extension provides translation capabilities for strings.

Properties: #

1. ztr: Translates the string using the app's current locale. If a translation is found, it returns the translated string; otherwise, it returns the original string.

ZapStore Class #

The ZapStore class is a simple local storage solution using SQLite in Flutter.

Methods: #

1. insert(String key, dynamic value): Inserts a key-value pair into the database.

2. get(String key): Retrieves the value associated with a given key from the database.

...

ZapNavigation Extension #

The ZapNavigation extension provides convenient navigation methods using the Flutter Navigator.

Methods: #

1. to(dynamic page, {RouteSettings?, Transition, bool, Color?, bool, String?, bool, bool, Duration, Duration, bool}): Navigate to a new page with various configurable options.

2. toNamed(String routeName, {Object? arguments}): Navigate to a named route with optional arguments.

...

Feel free to explore and utilize the functionalities provided by the Zap package to enhance your Flutter applications. If you have any questions or feedback, please refer to the package documentation or contact the package maintainers.

Installation #

To use this package, add zap as a dependency in your pubspec.yaml:

dependencies:
  zap: ^1.0.0