1.0.2 • Published 6 years ago

react-only-when v1.0.2

Weekly downloads
11,111
License
MIT
Repository
github
Last release
6 years ago

react-only-when

A declarative component for conditional rendering

NPM JavaScript Style Guide

Install

npm install --save react-only-when

Usage

import Only from 'react-only-when'

<Only when={true}>
  <h1>Here I Am</h1>
</Only>

Full Example

import React from 'react';
import Only from 'react-only-when'

class App extends React.Component {
  state = {
    show: true
  };

  toggle = () => this.setState(state => ({ show: !state.show }));

  render() {
    const { show } = this.state;
    return (
      <div className="app">
        <button onClick={this.toggle}>Toggle</button>
        <Only when={show}>
          <h1>Here I Am</h1>
        </Only>
      </div>
    );
  }
}

props

prop nametypedefaultisRequireddescription
childrenreact elementnulltrueA single child element
whenboolfalsetrueWhen true, children will rendered as is
hiddenModestring"withNull"falseDetermines how children should be hidden
classNamestring"r-o_hidden"falseThis is working in combination with hiddenMode={"withCss"}

hiddenMode enum

hiddenModedescription
"withNull"Will not render the child
"withDisplay"Will render the child with display:none
"withVisibility"Will render the child with visibility:hidden
"withCss"Will render the child with a CSS class (you can pass it a custom className prop)

License

MIT © sag1v