Flowr


Flowr provides a set of useful _React_ components for controlling your render flow.

Installation

To add flowr to your application dependencies you just need to run:

``shell
npm install flowr -S
`

This will download flowr into your node_modules folder and then you can import any flowr component into your modules.

`javascript
import { Maybe, Either, Await } from 'flowr'
// ...
`

Flowr is _tree-shaking_ friendly. As long as you are using ES6 modules, your bundle will contain only the required flowr components. Read more about tree shaking

There are two categories of Components available: Conditionals and Schedulers

Read the docs

#### Conditionals

| Name | Props | Description |
| ---------------------- | :----- | :---------------------------------------------------------------------------------------------------- |
| [Maybe][maybe] | when | Renders it's children only if when is true |
| [Either][either] | when | If when is true it renders the first child, otherwise it renders the second |
| [Flip][flip] | when | Flips the order of the first two children |
| [Reverse][reverse] | when | Reverses the order of all its children |
| [Order][order] | sort | Re-orders the children in the order provided through sort |
| [One][one] | at | Renders only the child at the specified index |
| [Some][some] | at | Renders only the children at the specified indices if they exist |
| [Constant][constant] | * | Will render only once, never updating the state of it's children (shouldComponentUpdate -> false) |
| [Pure][pure] | * | Will re-render only when the passed props have changed (PureComponent) |
| [Just][just] | * | Just renders it's children, nothing special, good for dynamic rendering |
| [Nothing][nothing] | * | Renders nothing |

[maybe]: https://monojack.github.io/flowr/docs/conditionals/Maybe.html
[either]: https://monojack.github.io/flowr/docs/conditionals/Either.html
[flip]: https://monojack.github.io/flowr/docs/conditionals/Flip.html
[reverse]: https://monojack.github.io/flowr/docs/conditionals/Reverse.html
[order]: https://monojack.github.io/flowr/docs/conditionals/Order.html
[one]: https://monojack.github.io/flowr/docs/conditionals/One.html
[some]: https://monojack.github.io/flowr/docs/conditionals/Some.html
[constant]: https://monojack.github.io/flowr/docs/conditionals/Constant.html
[pure]: https://monojack.github.io/flowr/docs/conditionals/Pure.html
[just]: https://monojack.github.io/flowr/docs/conditionals/Just.html
[nothing]: https://monojack.github.io/flowr/docs/conditionals/Nothing.html

#### Schedulers

| Name | Props | Description |
| ---------------------- | :------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Await][await] | for, tap, onPromise | Renders it's children when and only if the provided promise resolves. When used with a render prop, it will always apply the promise result _(err, res)_ to the callback. It also accepts a function that returns a Promise |
| [Stream][stream] | * | Render-prop component that enables working with props streams |
| [Debounce][debounce] | time, immediate | Renders it's children only after a certain amount of time has passed since the previous render. |
| [Delay][delay] | time | Renders it's children only after a certain amount of time has passed |
| [Throttle][throttle] | time` | Renders it's children at most once in the specified time interval. |

[await]: https://monojack.github.io/flowr/docs/schedulers/Await.html
[stream]: https://monojack.github.io/flowr/docs/schedulers/Stream.html
[debounce]: https://monojack.github.io/flowr/docs/schedulers/Debounce.html
[delay]: https://monojack.github.io/flowr/docs/schedulers/Delay.html
[throttle]: https://monojack.github.io/flowr/docs/schedulers/Throttle.html