Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivarconr/unleash-client-dart
Dart Client for Unleash
https://github.com/ivarconr/unleash-client-dart
continuous-delivery continuous-deployment dart devops feature feature-flags feature-toggle flutter unleash
Last synced: 17 days ago
JSON representation
Dart Client for Unleash
- Host: GitHub
- URL: https://github.com/ivarconr/unleash-client-dart
- Owner: ivarconr
- License: apache-2.0
- Created: 2020-04-28T08:36:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T10:46:40.000Z (over 1 year ago)
- Last Synced: 2024-10-20T23:33:36.733Z (25 days ago)
- Topics: continuous-delivery, continuous-deployment, dart, devops, feature, feature-flags, feature-toggle, flutter, unleash
- Language: Dart
- Homepage: https://pub.dev/packages/unleash
- Size: 135 KB
- Stars: 14
- Watchers: 3
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Unleash Client SDK for Dart and Flutter
This is an unofficial Unleash Client SDK for Dart. It is compatible with the [Unleash-hosted.com SaaS](https://www.unleash-hosted.com/) offering and [Unleash Open-Source](https://github.com/unleash/unleash).
It also works with [GitLab Feature Flags](https://docs.gitlab.com/ee/user/project/operations/feature_flags.html).
## Getting started
First, you will need to add `unleash` to your `pubspec.yaml`:
```yaml
dependencies:
unleash: x.y.z
# use the latest version found on pub.dev
```
Then, run `flutter packages get` in your terminal.
### Create a new Unleash instance
It is easy to get a new instance of Unleash. In your app you typically *just want one instance of Unleash*, and inject that where you need it.
To create a new instance of Unleash you need to pass in a config object:
```dart
import 'package:unleash/unleash.dart';
Future main() async {
final unleash = await Unleash.init(
UnleashSettings(
appName: '',
instanceId: '',
unleashApi: Uri.parse(''),
),
);
print(unleash.isEnabled('Awesome Feature'));
}
```
### Awesome feature toggle API
It is really simple to use unleash.
```dart
if(unleash.isEnabled("AwesomeFeature")) {
//do some magic
} else {
//do old boring stuff
}
```
Calling `unleash.isEnabled("AwesomeFeature")` is the equivalent of calling `unleash.isEnabled("AwesomeFeature", defaultValue: false)`.
Which means that it will return `false` if it cannot find the named toggle.
If you want it to default to `true` instead, you can pass `true` as the second argument:
```dart
unleash.isEnabled("AwesomeFeature", defaultValue: true);
```
## Built-in activation strategies
- [default](https://docs.getunleash.io/user_guide/activation_strategy#standard)
- [UserIDs](https://docs.getunleash.io/user_guide/activation_strategy#userids)
## Current state of development
This client SDK supports version 4 of the API.
This SDK currently does not support metrics reporting.
## Author
- Jonas Uekötter [GitHub](https://github.com/ueman) [Twitter](https://twitter.com/ue_man)
## Sponsoring
I'm working on my packages on my free-time, but I don't have as much time as I would. If this package or any other package I created is helping you, please consider to [sponsor](https://github.com/ueman#sponsor-me) me. By doing so, I will prioritize your issues or your pull-requests before the others.