@splitsoftware/splitio-react

Split SDK for React

Overview

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

Compatibility

This SDK is compatible with React 16.3.0 and above, since it uses React Context API.

Some features, such as useSplitClient and useSplitTreatments, use React Hooks API that requires React 16.8.0 or later.

Getting started

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

import React from 'react';

// Import SDK functions
import { SplitFactoryProvider, useSplitTreatments } from '@splitsoftware/splitio-react';

// Define your config object
const CONFIG = {
  core: {
    authorizationKey: 'YOUR_SDK_KEY',
    key: 'CUSTOMER_ID'
  }
};

function MyComponent() {
  // Evaluate feature flags with useSplitTreatments hook
  const { treatments: { FEATURE_FLAG_NAME }, isReady } = useSplitTreatments({ names: ['FEATURE_FLAG_NAME'] });

  // Check SDK readiness using isReady prop
  if (!isReady) return <div>Loading SDK ...</div>;

  if (FEATURE_FLAG_NAME.treatment === 'on') {
    // return JSX for on treatment
  } else if (FEATURE_FLAG_NAME.treatment === 'off') {
    // return JSX for off treatment
  } else {
    // return JSX for control treatment
  };
}

function MyApp() {
  return (
    // Use SplitFactoryProvider to instantiate the SDK and makes it available to nested components
    <SplitFactoryProvider config={CONFIG} >
      <MyComponent />
    </SplitFactoryProvider>
  );
}

Please refer to our official docs to learn about all the functionality provided by our SDK and the 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 [e-mail], or get started with feature flags for free at https://www.split.io/signup.

Split has built and maintains SDKs for:

• .NET Github Docs
• Android Github Docs
• Angular Github Docs
• Flutter Github Docs
• GO Github Docs
• iOS Github Docs
• Java Github Docs
• JavaScript Github Docs
• JavaScript for Browser Github Docs
• Node Github Docs
• PHP Github Docs
• PHP thin-client Github Docs
• Python Github Docs
• React Github Docs
• React Native Github Docs
• Redux Github Docs
• Ruby Github Docs

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.