npm install react.rt --save
`
And it's just as easy with bower:
`
bower install react.rt --save
`
Live Demo
https://rawgit.com/NShahri/React.ReleaseToggle/master/lib/js/demo.html
Importing
$3
`javascript
import Toggle from 'react.rt';
`
or
`javascript
import {ToggleReleaseApp, ToggleRelease, withReleaseToggleContext, CurrentTogglesView} from 'react.rt';
`
$3
`javascript
var Toggle = require('react.rt');
`
Basic Usage
You can use ReleaseToggleApp to define enabled/disabled features for all children.
You can use ReleaseToggle to check if features are matched to specified condition.
`javascript
ReleaseToggleApp only define context of existing features for all children
This message is visible when feature1 and feature3 are enabled and feature2 is disabled
`
$3
In order to more easily access the toggle context object, a withReleaseToggleContext component has been added.
It is usable on any React Component of any type.
This component uses React context internally and as long as React supports this.context in its current form, any code written for that API will continue to work.
We think it is nicer and easier to use withReleaseToggleContext which hide the implementation details.
`javascript
import React from 'react';
import { withReleaseToggleContext } from 'release-toggle';
class MyView extends React.Component{
let features = this.props.releaseToggleContext.features;
let result = Object.keys(features).map(m=>m+'='+features[m]).join(',');
render() {
return ({result});
}
}
export default withReleaseToggleContext(MyView)
`
$3
You can use ReleaseToggleApp nested in another ReleaseToggleApp. In the following sample nested ReleaseToggleApp will override feature2 and message should be visisble.
`javascript
This message is visible when feature1, feature2 and feature3 are enabled
`
$3
If you want to display context on your application you can use CurrentTogglesView.
We do not recomment to use this component in your production release, but it can be useful for testing purposes.
`javascript
`
$3
The ReleaseToggleApp and ReleaseToggle components take any number of arguments which can be a string or object. also property 'features' value will process as object of features.
Arrays will be recursively flattened as per the rules above:
The argument 'foo' is short for { foo: true }. If the value of the key is false, it won't be included in the output.
$3
`javascript
This message is visible when feature1 and feature3 are enabled and feature2 is disabled
This message is visible when feature1 and feature3 are enabled and feature2 is disabled
`
$3
`javascript
`
$3
1. Documentation (in progress)
1. More unit tests (in progress)
1. Using build server
1. Fixing bower package
1. Publishing es6 and umd of each modules which can be used in any other application build process
1. Using cookies to get list of features
1. Using query string for list of features
1. Implementing versioning for features, ie: feature1: '~1.0.2'
1. Supporting different engine for checking features
1. Server side supporting
$3
Use GitHub issues for requests.
I actively welcome pull requests.
I expect project participants to adhere to [Code of Conduct]().
Polyfills needed to support older browsers
Array.isArray: see MDN for details about unsupported older browsers and a simple polyfill.
Object.keys: see MDN for details about unsupported older browsers and a simple polyfill.
Array.map: see MDN for details about unsupported older browsers and a simple polyfill.
Object.assign: see MDN for details about unsupported older browsers and a simple polyfill.
Array.find`: see MDN for details about unsupported older browsers and a simple polyfill.