@zup-stark/owen-toggles v0.1.1

React UI toolkit for the web.

React HOC to toggle components by features on or off.

Installation

Owen-Toggles is available as an npm package.

npm install owen-toggles

Usage

First you should declare <FeatureToggles /> in your main container. Don't forget to pull the list of feature from the backend or a local const.

import React from 'react'
import ReactDOM from 'react-dom'
import { FeatureToggles } from 'owen-toggles';

import { getTogglesFromTheBackend } from 'core/utils/feature-toggles';

const AppRender = (features) => {
  render(
    <FeatureToggles features={features}>
      <AwesomeApplication />
    </FeatureToggles>,
    document.getElementById('root')
  );
}

const renderApplication = async () => {
  const features = await getTogglesFromTheBackend();
  return AppRender(features);
};

renderApplication()

Then you implement a component (<AwesomeComponent /> in this case) inside <Feature />.

Important: Every <Feature /> should be below <FeatureToggles />

import React from 'react'
import ReactDOM from 'react-dom'
import { Feature } from 'owen-toggles'

import AwesomeComponent from 'components/AwesomeComponent'

return (
  <Feature
    name="FEATURE_NAME_HERE"
    activeComponent={AwesomeComponent}
    props={{
      listOfAwesomePeople,
      onClick={handleClickOnListOfAwsomePeople}
    }}
  />
)

Features json example:

{
  CONFIG_INFRACTIONS: true,
  CHART_INFRACTIONS: false
}

Contributing

Bug reports, feature requests and other contributions are more than welcome! Whenever possible, please make a pull request with the implementation instead of just requesting it.

If the feature is big, open an issue first for discussion.

License

This project is licensed under the terms of the MIT license.