@permettezmoideconstruire/react-if
v3.3.0
Published
🌗 Render React components conditionally
Downloads
3
Readme
React If
Render React components conditionally.
What does this component do
Take a look at the following presentational component, which contains a commonly used pattern for conditional rendering:
const Bar = ({ name, age, drinkingAge }) => (
<div>
<Header />
{
age >= drinkingAge
? <span className="ok">Have a beer, {name}!</span>
: <span className="not-ok">Sorry, {name}, you are not old enough.</span>
}
<Footer />
</div>
)
With React-If
you can rewrite this into a more readable, expressive format:
const Bar = ({ name, age, drinkingAge }) => (
<div>
<Header />
<If condition={ age >= drinkingAge }>
<Then><span className="ok">Have a beer, {name}!</span></Then>
<Else><span className="not-ok">Sorry, {name}, you are not old enough.</span></Else>
</If>
<Footer />
</div>
)
Delaying evaluation of children
It is important to note that, because JavaScript is an eagearly evaluated language, children of both the Then
and Else
component will be evaluated regardless of the value of the condition. Should that be an issue for performance reasons, one can wrap said children in a arrow function, to delay evaluation of the children, as in the following example:
const renderData = (data) => {
val computed = /* expensive computation */
return <span>Here is the result: {computed}</span>;
};
const Foo = ({ data }) => (
<div>
<If condition={false}>
<Then>{() =>
renderData(data)
}</Then>
<Else>
Nothing to see here
</Else>
</If>
</div>
)
By doing so, renderData
will not be called in the above example.
Installing and usage
NPM:
npm install react-if
Bower:
bower install react-if
// ES2015
import { If, Then, Else, When, Unless } from 'react-if'
// CommonJS:
const { If, Then, Else, When, Unless } = require('react-if')
// Global
var If = ReactIf.If
var Then = If.Then
var Else = If.Else
var When = If.When
var Unless = If.Unless
Examples
Shorthands: When and Unless
import React from 'react'
import { When, Unless } from 'react-if'
const someCondition = false
const Example = () => (
<div>
<When condition={ someCondition }>
This will only be displayed, if the condition is TRUE
</When>
</div>
)
const AnotherExample = () => (
<div>
<Unless condition={ someCondition }>
This will only be displayed, if the condition is FALSE
</Unless>
</div>
)
API
<If />
| Property | Type |
| ------------- | ------- |
| condition
| Boolean |
If condition
evaluates to true
, renders the <Then />
block will be rendered, otherwise renders the <Else />
block. Either block may be omitted.
This component can contain any number of <Then />
or <Else />
blocks, but only the first block of the right type (either Then
or Else
, depending on the condition) will be rendered.
<Then />
Can contain any number of elements inside, which it renders as-is. It can also contain a function. Should not be used outside of an <If />
block. It will only be displayed, if parent If
block's condition is true.
<Else />
Can contain any number of elements inside, which it renders as-is. It can also contain a function. Should not be used outside of an <If />
block. It will only be displayed, if parent If
block's condition is false.
<When />
A shorthand for <If condition={...}><Then>...</Then></If>
. The same rules apply to the child elements as with using the Then
block.
<Unless />
A shorthand for <If condition={...}><Else>...</Else></If>
. The same rules apply to the child elements as with using the Else
block.
License
React If is released under the MIT license.