Higher order component to call a load function from props at mount.


Keywords
react, loader, hoc, placeholder, indicator, loading, nantes, zenika
License
MIT
Install
npm install hoc-react-loader@6.3.0

Documentation

hoc-react-loader

CircleCI NPM Version Coverage Status

This is a higher order component ("HOC"). It's an advanced pattern used in React that let you reuse code logic, it can be summarized as a component factory. It improves isolation, interoperability and maintainability of your code base.

hoc-react-loader's purpose is to call a load callback passed through the props of a component only once (at componentWillMount). This is convenient to load data from a backend for instance. The component shows a loading indicator when it's waiting for the props to be defined. The loading indicator can be changed easily.

Demos

You can test some examples here.

Installation

npm i --save tinycolor2 hoc-react-loader

tinycolor2 is a peer dependency of hoc-react-loader. It handles color picking for the default loading indicator. You don't have to install it if you use your own loading indicator.

Usage

With this.props

import loader from 'hoc-react-loader'

const Component = ({ data }) => <div>Component {JSON.stringify(data)}</div>

export default loader({ print: ['data'] })(Component)

In this case, the loader waits for this.props.data to be truthy, then mounts its child component and calls this.props.load if it exists. This is useful when the parent has control over the injected data, or when the Component is connected with redux. this.props.load should be injected by the parent component or injected by a Container (redux).

The print parameter should be an array of props to waits. All these props should become truthy at some point.

Since the LoadingIndicator is not specified, the default LoadingIndicator is displayed while waiting for all the props. Here's an exemple with a specified loader:

import loader from 'hoc-react-loader'

const MyLoadingIndicator = () => <div>Waiting...</div>
const Component = ({ data }) => <div>Component {data}</div>

export default loader({ print: ['data'], LoadingIndicator: MyLoadingIndicator })(Component)

The print parameter can also be a Promise. The loading indicator is displayed until print Promise is resolved or rejected.

Don't wait

import loader from 'hoc-react-loader'

const Component = ({ data }) => <div>Component {JSON.stringify(data)}</div>

export default loader()(Component)

In this example, the loader component doesn't wait for props. this.props.load is called once, but the LoadingIndicator component isn't displayed.

Load as a function parameter

import loader from 'hoc-react-loader'

const Component = ({ data }) => <div>Component {JSON.stringify(data)}</div>

export default loader({ load: () => console.log('here') })(Component)

In this case, the loader calls this.props.load if it exists AND the load parameter, resulting in here to be printed.

The default print parameter value is true. It means that in this example the LoadingIndicator isn't displayed.

Load as a string parameter

import loader from 'hoc-react-loader'

const Component = ({ data }) => <div>Component {JSON.stringify(data)}</div>

export default loader({ load: 'myLoader' })(Component)

In this case, the loader calls this.props.myLoader if it exists.

The default print parameter value is true. It means that in this example the LoadingIndicator isn't displayed.

Print as a function

The print parameter can also be a function. Then the props and context are given to it (in this order), and it should return a boolean indicating wether or not the actual component should be displayed.

Error handling

The error parameter allows to specify a prop that indicates wether or not a placeholder error component should be displayed in replacement of the real component. It's usefull when data that are required for the correct display of a component are missing.

Like for the print prop, error can be a boolean, a string (referencing a prop name), an array of string (an array of prop names) or a function (whose result will be converted to boolean).

// default error component will be displayed if 'error' prop is truthy
export default loader()(MyComponent)

// default error component will be displayed
export default loader({ error: true })(MyComponent)

// default error component will be displayed if 'errorMessage' prop is truthy
export default loader({ error: 'errorMessage' })(MyComponent)

// CustomErrorComponent will be displayed if 'error' prop is truthy
export default loader({ ErrorIndicator: CustomErrorComponent })(MyComponent)

Delay parameter

When a component loads very quickly, you will see a flash of the loading component. To avoid this behaviour, you can add a delay parameter to the loader with a time in milliseconds. Then, the loading indicator will be rendered after the delay if the Component can't be rendered before that.

// loading indicator will be displayed only after 200ms
export default loader({ print: ['data'], delay: 200 })(MyComponent)

By default, no delay is defined.

About alakarte

alakarte is created by two passionate french developers.

Do you want to contact them ? Go to their website

Guillaume CRESPEL Fabien JUIF

Zenika

This library was initiated thanks to Zenika.