The aim of this project is to provide a range of useful Dart and Flutter utilities ranging from extensions to widgets. It has utilities from basic functions to widgets to routing. An example is provided that uses most of the provided functionality.
This package isn't on pub.dev, so to be used it has be added as a local path package.
To install and build the project you have to have already installed git, and flutter. You can find instructions on how to install those on their respected websites:
-
Add the repo as a submodule to your project
mkdir -p packages/utilities git submodule add https://github.com/helpis-software/utilities.git packages/utilities
-
Clone the repo
git submodule update --remote --init --recursive --progress
-
Change directory to utilities
cd packages/utilities -
Install Flutter packages
flutter pub get cd ../.. -
Add the package to your local
pubspec.yaml# ... dependencies: utilities: path: packages/utilities
-
Update your dependencies
flutter pub get
-
Include it to your project
// Suggested to be used with a prefix to avoid potential name conflicts // Even better, use `show` to import only the members you will be using import 'package:utilities/utilities.dart' as util;
An extensive example with a demo application can be found at utilities_example.
We try to be consistent in code style throughout our codebase and follow certain guidelines. Most of them should comply with popular standards, but some might diverge due to personal preferences and conventions. Please read more about our code style if you are considering to contribute to our products. You find general recommendations at STYLEGUIDE.md, and language-specific guidelines at the respective styleguides for each language used.