Unlaunch React SDK

main	development

Overview

The Unlaunch React SDK provides a React API to access Unlaunch feature flags and other features. Using the SDK, you can easily build React applications that can evaluate feature flags, dynamic configurations, and more.

Important Links

• To create feature flags to use with Java SDK, login to your Unlaunch Console at https://app.unlaunch.io
• Official Guide

Compatibility

Unlaunch React SDK requires React 16.3.0 or higher.

Getting Started

Here is a simple example.

First, add the npm dependency to your project.

 npm install --save unlaunch-react-sdk

Here's how you'd use the React SDK in your application.

1. asyncWithUnlaunchProvider

import{asyncWithUnlaunchProvider}from'unlaunch-react-sdk';(async()=>{constunLaunchProvider=awaitasyncWithUnlaunchProvider({flagKeys : ['flag-1','flag-1']// Flag key setapiKey : '<PROVIDE_BROWSER_PUBLIC_KEY_FOR_YOUR_PROJECT>'identity : 'anonymous' // Use special anonymous identity which generates a unique UUIDoptions={offline: false,requestTimeoutInMillis: 1000,logLevel: 'debug'});render(<UnlaunchProvider><YourApp/></UnlaunchProvider>,document.getElementById('reactDiv'),);})();}}

2. withUnlaunchProvider

import{withUnlaunchProvider}from'unlaunch-react-sdk';exportdefaultwithUnlaunchProvider({flagKeys : ['flag-1','flag-1']// Flag key setapiKey : '<PROVIDE_BROWSER_PUBLIC_KEY_FOR_YOUR_PROJECT>'identity : 'anonymous' // Use special anonymous identity which generates a unique UUIDoptions: {/* ... */}})(YourApp);

withUnlaunchConsumer

This is a wrapper function with which we can access flags and unlaunchClient as props in any component at any level of hierarchy. The return value of withUnlaunchConsumer is a wrapper function that takes your component and returns a React component injected with flags & unlaunchClient as props.

import{withUnlaunchConsumer}from'unlaunch-react-sdk';constHome=({ flags, unlaunchClient /*, ...otherProps */})=>{// You can call any of the methods from the Unlaunch JavaScript SDKreturnflags.testFlag ? <div>Flag on</div> : <div>Flag off</div>;};exportdefaultwithUnlaunchConsumer()(Home);

For more information, see the official guide.

License

Licensed under the Apache License, Version 2.0. See: Apache License.

About Unlaunch

Unlaunch is a Feature Release Platform for engineering teams. Our mission is allow engineering teams of all sizes to release features safely and quickly to delight their customers. To learn more about Unlaunch, please visit www.unlaunch.io. You can sign up to get started for free at https://app.unlaunch.io/signup .

More Questions?

At Unlaunch, we are obsessed about making it easier for developers all over the world to release features safely and with confidence. If you have any questions or something isn't working as expected, please email unlaunch@gmail.com.