Skip to content

README.md

Latest commit

 

History

History
93 lines (62 loc) · 1.96 KB

README.md

File metadata and controls

93 lines (62 loc) · 1.96 KB
Raw

Unleash React Native SDK

Unleash is a private, secure, and scalable feature management platform built to reduce the risk of releasing new features and accelerate software development. This React Native / Expo SDK is designed to help you integrate with Unleash and evaluate feature flags inside your application.

You can use this SDK with Unleash Enterprise or Unleash Open Source.

Full documentation: https://docs.getunleash.io/sdks/react-native

Installation

npm

npm install @unleash/unleash-react-native-sdk unleash-proxy-client

Yarn

yarn add @unleash/unleash-react-native-sdk unleash-proxy-client

Expo

npx expo install @unleash/unleash-react-native-sdk unleash-proxy-client

Quick start

import { FlagProvider, useFlag } from '@unleash/unleash-react-native-sdk';

const config = {
  url: 'https://<your-unleash-instance>/api/frontend',
  clientKey: '<your-frontend-token>',
  appName: 'my-app',
};

function MyComponent() {
  const isEnabled = useFlag('my-feature');
  return isEnabled ? <NewFeature /> : <OldFeature />;
}

export default function App() {
  return (
    <FlagProvider config={config}>
      <MyComponent />
    </FlagProvider>
  );
}

For configuration options, context management, bootstrapping, testing, and troubleshooting, see the full documentation.

Contributing

Requirements

  • Node.js 20.11 or later
  • Yarn

Local development

git clone https://github.com/Unleash/unleash-react-native-sdk.git
cd unleash-react-native-sdk
yarn install

Running tests

yarn test

Building

yarn build

Code style and formatting

See the Unleash contribution guide for general guidelines.

Releasing

Releases are published to npm under the @unleash scope.

License

Apache-2.0