Skip to content

splitio/redux-client

Repository files navigation

Split SDK for Redux

npm versionBuild 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

This SDK is compatible with Redux v2.0.0 and later, and React-Redux v4.0.0 and later.

Getting started

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

// Import modulesimportReactfrom'react';import{createStore,applyMiddleware,combineReducers}from'redux';import{Provider}from'react-redux';import{splitReducer,initSplitSdk,getTreatments,selectTreatmentAndStatus,connectSplit}from'@splitsoftware/splitio-redux'// Init Redux storeconststore=createStore(combineReducers({splitio: splitReducer// You'll have your app reducers here too}),applyMiddleware(thunk));// Define your config object and dispatch `initSplitSdk` action to init the SDKconstCONFIG={core: {authorizationKey: 'YOUR_SDK_KEY',key: 'CUSTOMER_ID'}};store.dispatch(initSplitSdk({config: CONFIG}))// Dispach a `getTreatments` action to evaluate one or more feature flags.// The evaluation is done asynchronously when the SDK is ready.store.dispatch(getTreatments({splitNames: 'FEATURE_FLAG_NAME'}))// Connect your component to splitio's piece of stateconstMyComponent=connectSplit()(({ splitio })=>{// Select a treatment valueconst{ treatment, isReady }=selectTreatmentAndStatus(splitio,'FEATURE_FLAG_NAME')// Check SDK client readiness using isReady propertyif(!isReady)return<div>Loading SDK ...</div>;if(treatment==='on'){// return JSX for 'on' treatment}elseif(treatment==='off'){// return JSX for 'off' treatment}else{// return JSX for 'control' treatment}});ReactDOM.render(<Providerstore={store}><MyComponent/></Provider>,document.getElementById('root'));

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 [email protected], 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.

Packages

No packages published

Contributors 11