Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

react-redux-lifecycle

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-redux-lifecycle

A higher-order component to dispatch actions on react lifecycle methods

  • 2.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
634
increased by39.04%
Maintainers
1
Weekly downloads
 
Created
Source

React Redux Lifecycle

Build Status npm version npm downloads License: MIT

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)

FAQs

Package last updated on 15 Feb 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc