react-feature-flags
v1.0.0
Published
Make feature flipping great again by simplify flags sharing across your app
Downloads
15,120
Readme
react-feature-flags
A feature toggle (also feature switch, feature flag, feature flipper, conditional feature, etc.) is a technique in software development that attempts to provide an alternative to maintaining multiple source-code branches (known as feature branches), such that a feature can be tested even before it is completed and ready for release. Feature toggle is used to hide, enable or disable the feature during run time. For example, during the development process, a developer can enable the feature for testing and disable it for other users. https://en.wikipedia.org/wiki/Feature_toggle
Install
npm install --save react-feature-flags
Usage
Load your flags
Get your flags from anywhere: fetch, localStorage, a json file, Redux... The shape must be an array of object containing the following keys: name and isActive
const flags = [
{ name: 'vipOnly', isActive: false },
{ name: 'adminOnly', isActive: true }
];
FlagsProvider
Wrap your root component with FlagsProvider
and pass your flags to it with the value
props.
That's how they will be available to all Flags
component thanks to React context.
import { FlagsProvider } from 'react-feature-flags';
ReactDOM.render(
<FlagsProvider value={flags}>
<App />
</FlagsProvider>,
document.getElementById('root')
);
Flags
Flags
components are aware of all flags given to FlagsProvider
.
To render a node or a component based on your flags, you must pass by props an array of authorized flags to Flags
component.
Then you can wrapped the desired component as children to a Flag
component or use a renderOn
props. It will be rendered if one or many flags are active (isActive) and match the flags included in authorizedFlags
.
If the flags are not active neither matched with authorizedFlags
nothing will be rendered unless you pass a component as fallback by the renderOff
props.
with children props
import { Flags } from 'react-feature-flags';
<Flags authorizedFlags={['adminOnly']}>
<h1>For admin</h1>
</Flags>
with renderOn props
import { Flags } from 'react-feature-flags';
<Flags authorizedFlags={['adminOnly']}
renderOn={(authorizedFlags) => <h1>For admin</h1>}
/>
with renderOn props and renderOff props as fallback
import { Flags } from 'react-feature-flags';
<Flags authorizedFlags={['adminOnly']}
renderOn={() => <h1>For admin</h1>}
renderOff={() => <h1>For customers</h1>}
/>
when all flags are required
You can use the exactFlags
props when you require all flag specified by authorizedFlags
to be active before rendering something.
import { Flags } from 'react-feature-flags';
<Flags
exactFlags
authorizedFlags={['flag', 'flagB']}
renderOn={() => <h1>visible when flagA AND flagB are active</h1>}
/>
optionaly you can pass active flags down to children components
import { Flags } from 'react-feature-flags';
<Flags
exactFlags
authorizedFlags={['flag', 'flagB']}
renderOn={(activeFlags) => <SomeComponent />}
/>
SomeComponent
will access to active flags (flags from context that match with authorizedFlags props)
License
MIT