Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

react-lifecycles-compat

Package Overview
Dependencies
0
Maintainers
7
Versions
17
Issues
File Explorer

Advanced tools

react-lifecycles-compat

Backwards compatibility polyfill for React class components

    3.0.4latest

Version published
Maintainers
7
Weekly downloads
6,469,666
decreased by-14.56%

Weekly downloads

Changelog

Source

3.0.4 (May 11, 2018)

Fixed shallow renderer regression (introduced in 3.0.3) that caused setState updater to fail due to incorrect this. (#26)

Readme

Source

react-lifecycles-compat

What is this project?

React version 17 will deprecate several of the class component API lifecycles: componentWillMount, componentWillReceiveProps, and componentWillUpdate. (Read the Update on Async rendering blog post to learn more about why.) A couple of new lifecycles are also being added to better support async rendering mode.

Typically, this type of change would require third party libraries to release a new major version in order to adhere to semver. However, the react-lifecycles-compat polyfill offers a way to use the new lifecycles with older versions of React as well (0.14.9+) so no breaking release is required. This enables shared libraries to support both older and newer versions of React simultaneously.

How can I use the polyfill

First, install the polyfill from NPM:

# Yarn yarn add react-lifecycles-compat # NPM npm install react-lifecycles-compat --save

Next, update your component and replace any of the deprecated lifecycles with new ones introduced with React 16.3. (Refer to the React docs for examples of how to use the new lifecycles.)

Lastly, use the polyfill to make the new lifecycles work with older versions of React:

import React from 'react'; import {polyfill} from 'react-lifecycles-compat'; class ExampleComponent extends React.Component { static getDerivedStateFromProps(nextProps, prevState) { // Normally this method would only work for React 16.3 and newer, // But the polyfill will make it work for older versions also! } getSnapshotBeforeUpdate(prevProps, prevState) { // Normally this method would only work for React 16.3 and newer, // But the polyfill will make it work for older versions also! } // render() and other methods ... } // Polyfill your component so the new lifecycles will work with older versions of React: polyfill(ExampleComponent); export default ExampleComponent;

Which lifecycles are supported?

Currently, this polyfill supports static getDerivedStateFromProps and getSnapshotBeforeUpdate- both introduced in version 16.3.

Validation

Note that in order for the polyfill to work, none of the following lifecycles can be defined by your component: componentWillMount, componentWillReceiveProps, or componentWillUpdate.

Note also that if your component contains getSnapshotBeforeUpdate, componentDidUpdate must be defined as well.

An error will be thrown if any of the above conditions are not met.

FAQs

What is react-lifecycles-compat?

Backwards compatibility polyfill for React class components

Is react-lifecycles-compat popular?

The npm package react-lifecycles-compat receives a total of 5,206,807 weekly downloads. As such, react-lifecycles-compat popularity was classified as popular.

Is react-lifecycles-compat well maintained?

We found that react-lifecycles-compat demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 7 open source maintainers collaborating on the project.

Last updated on 11 May 2018

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc