unleash.unleash/website/docs/reference/sdks/flutter.md

title
Flutter Proxy SDK

This guide shows you how to use feature toggles in a Flutter app with the Unleash Proxy and the Unleash front-end API. You can also check out the source code for the Flutter Proxy SDK on GitHub for more details around the SDK.

Introduction

The Flutter proxy client is a tiny Unleash client written in Dart. This client stores toggles relevant for the current user with shared preferences library and synchronizes with Unleash (the proxy or the Unleash front-end API) in the background. Because toggles are stored in the user's device, the client can use them to bootstrap itself the next time the user visits the same web page.

How to use the Flutter Proxy SDK

Step 1: Install

flutter pub add unleash_proxy_client_flutter

Step 2: Initialize the SDK

import 'package:unleash_proxy_client_flutter/unleash_proxy_client_flutter.dart';

final unleash = UnleashClient(
    url: Uri.parse('https://app.unleash-hosted.com/demo/api/proxy'),
    clientKey: 'proxy-123',
    appName: 'my-app');

// Use `updateContext` to set Unleash context fields.
unleash.updateContext(UnleashContext(userId: '1233'));

// Start the background polling
unleash.start();

Option A: Connecting to the Unleash proxy

:::tip Prerequisites

To connect to an Unleash proxy, you need to have an instance of the proxy running.

:::

Add the proxy's URL and a proxy client key. The configuration section of the Unleash proxy docs contains more info on how to configure client keys for your proxy.

Option B: Connecting directly to Unleash

Use the url to your Unleash instance's front-end API (<unleash-url>/api/frontend) as the url parameter. For the clientKey parameter, use a FRONTEND token generated from your Unleash instance. Refer to the how to create API tokens guide for the necessary steps.

Step 3: Check if feature toggle is enabled

unleash.isEnabled('proxy.demo');

...or get toggle variant:

final variant = unleash.getVariant('proxy.demo');

if(variant.name == 'blue') {
// something with variant blue...
}

Listen for updates via the EventEmitter

The client is also an event emitter. This means that your code can subscribe to updates from the client. This is a neat way to update your app when toggle state updates.

unleash.on('update', (_) {
    final myToggle = unleash.isEnabled('proxy.demo');
    //do something useful
});