@mariosant/react-cond
v0.1.3
Published
Create components based on conditions, with ease
Downloads
2
Readme
React Cond
Create components based on conditions, with ease.
Installation
Add @mariosant/react-cond
to your package.json
.
$ npm install @mariosant/react-cond
You can now import the module and use it like
import cond from '@mariosant/react-cond';
// Components
const Pending = () => 'Loading. Please wait...';
const NonIdeal = () => 'It seems there is an error!';
const Component = ({data}) => `This is the actual data: ${data}`;
// Predicates
const isPending = ({pending}) => pending;
const hasError = ({error}) => error;
const isOk = ({error, pending, data}) => !error && !pending && data;
// Final complex component
export const ComplexComponent = cond(
[isPending, Pending],
[hasError, NonIdeal],
[isOk, Component],
NonIdeal,
);
Usage
The package exports two main components you can use.
import cond, {hoc} from '@mariosant/react-cond';
The cond
function takes a list of predicates and a default component if everything else fails.
const CommentsList = cond(
[isPending, Pending], // Will render Pending if isPending returns true.
[hasError, NonIdeal], // Will render NonIdeal if hasError returns true.
[isOk, Component], // Will render Component if isOk returns true.
NonIdeal, // If everything above fails, NonIdeal component will be rendered instead.
);
A predicate is a function. It will receive props
and if it returns a truthy result, the associated component will be rendered.
For example,
import cond from '@mariosant/react-cond'
const isPending = ({pending}) => pending;
const Pending = () => <div>'Loading. Please wait.'</div>;
return cond(
[isPending, Pending],
...
);
For the developer's ease, a high order component version has been included. It can be easily combined with Recompose's compose
.
import {hoc as cond} from '@mariosant/react-cond';
import {compose, withProps} from 'recompose';
return compose(
withProps({something: true}),
cond([isPending, Pending], [isOk, Component]),
)(DefaultComponent);
Meta
Marios Antonoudiou – @marios_ant – [email protected]
Distributed under the MIT license.
https://github.com/mariosant/react-cond
Contributing
- Fork it (https://github.com/mariosant/react-cond/fork)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes using a semantic commit message.
- Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request