@splitsoftware/splitio-react-native
TypeScript icon, indicating that this package has built-in type declarations

0.8.1 • Public • Published

Split JavaScript SDK for React Native

npm version Build Status

Overview

This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.

Twitter Follow

Compatibility

The React Native SDK is a library for React Native applications. The library was build with native modules to support streaming in Android and iOS, and therefore it requires linking the native dependency in order to use streaming. For Expo applications, streaming is not supported by default but a polyfill can be used instead. Check our public documentation for installation details.

Getting started

Below is a simple App.jsx example that describes the instantiation and most basic usage of our SDK:

// Import the SDK
import { SplitFactory } from '@splitsoftware/splitio-react-native';

// Instantiate the SDK
var factory = SplitFactory({
  core: {
    authorizationKey: 'YOUR_SDK_KEY',
    key: 'CUSTOMER_ID'
  }
});

// Set a callback to listen for the SDK_READY event, to make sure the SDK is properly loaded before asking for a treatment
client.on(client.Event.SDK_READY, function() {
  var treatment = client.getTreatment('FEATURE_FLAG_NAME');
  if (treatment == 'on') {
    // insert code here for on treatment
  } else if (treatment == 'off') {
    // insert code here for off treatment
  } else {
    // insert your control treatment code here
  }
});

Please refer to React Native SDK to learn about all the functionality provided by our SDK as well as specifics for configuration options available for tailoring it to your current application setup.

Submitting issues

The Split team monitors all issues submitted to this issue tracker. We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.

Contributing

Please see Contributors Guide to find all you need to submit a Pull Request (PR).

License

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

About Split

Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.

To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.

Split has built and maintains SDKs for:

For a comprehensive list of open source projects visit our Github page.

Learn more about Split:

Visit split.io/product for an overview of Split, or visit our documentation at help.split.io for more detailed information.

Dependencies (1)

Dev Dependencies (16)

Package Sidebar

Install

npm i @splitsoftware/splitio-react-native

Weekly Downloads

8,995

Version

0.8.1

License

Apache-2.0

Unpacked Size

1.22 MB

Total Files

277

Last publish

Collaborators

  • robertgrassian
  • ezamora.split
  • patricioe
  • nicolas.zelaya
  • emiliano-sanchez
  • matias.melograno
  • split-sysadmin
  • shaunsplit