React Redux Lifecycle

Often, actions need to be dispatched as part of the React lifecycle. In many cases, the only reason to extend React.Component instead of using functional components is to do this.

Well, no more! Now you can just wrap your component in this higher-order component and remain in your functional bliss.

Installation

NPM

npm install --save react-redux-lifecycle

This assumes that you’re using npm package manager with a module bundler like Webpack or Browserify to consume CommonJS modules.

Usage

Standard Actions

import { withLifecycleActions } from 'react-redux-lifecycle'

const myAction = { type: 'MY_ACTION' }

const MyComponent = ({ message }) => <div>{message}</div>

export default withLifecycleActions({ componentDidMount: myAction })(MyComponent)

...

import MyComponent from './MyComponent'

<MyComponent message="Hello World!" />

Action Creators

import { withLifecycleActions } from 'react-redux-lifecycle'

const myActionCreator = () => ({ type: 'MY_ACTION' })

const MyComponent = ({ message }) => <div>{message}</div>

export default withLifecycleActions({ componentDidMount: myActionCreator })(MyComponent)

...

import MyComponent from './MyComponent'

<MyComponent message="Hello World!" />

With props

The component props are passed to any functions that are provided

import { withLifecycleActions } from 'react-redux-lifecycle'

const myActionCreator = ({ id }) => ({ type: 'MY_ACTION', id })

const MyComponent = ({ message }) => <div>{message}</div>

export default withLifecycleActions({ componentDidMount: myActionCreator })(MyComponent)

...

import MyComponent from './MyComponent'

<MyComponent id={123} message="Hello World!" />

Multiple Actions

import { withLifecycleActions } from 'react-redux-lifecycle'

const myAction = () => { type: 'MY_ACTION' }
const myActionCreator = () => myAction

const MyComponent = ({ message }) => <div>{message}</div>

export default withLifecycleActions({ componentDidMount: [myAction, myActionCreator] })(MyComponent)

...

import MyComponent from './MyComponent'

<MyComponent message="Hello World!" />

Single Method Helpers

Helper functions are available if you only need to dispatch the action on a single lifecycle method.

import { onComponentDidMount } from 'react-redux-lifecycle'

const myAction = { type: 'MY_ACTION' }

const MyComponent = ({ message }) => <div>{message}</div>

export default onComponentDidMount(myAction)(MyComponent)

...

import MyComponent from './MyComponent'

<MyComponent message="Hello World!" />

Basic action, action creators and multiple actions are all supported in the same manner as withLifecycleActions.

Supported Lifecycle Methods

The following lifecycle methods are supported:

• componentWillMount (helper: onComponentWillMount)
• componentDidMount (helper: onComponentDidMount)
• componentWillReceiveProps (helper: onComponentWillReceiveProps)
• componentWillUpdate (helper: onComponentWillUpdate)
• componentDidUpdate (helper: onComponentDidUpdate)
• componentWillUnmount (helper: onComponentWillUnmount)
• componentDidCatch (helper: onComponentDidCatch)