Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

async-safe, static lifecycle hooks [update] #12

Merged
merged 3 commits into from
Jan 19, 2018
Merged

async-safe, static lifecycle hooks [update] #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd12d7f
Update getDerivedStateFromProps to reflect final implementation
bvaughn Jan 19, 2018
0da882b
Updated deprecation notes to mirror dev-warnings
bvaughn Jan 19, 2018
7727fec
Grammatical tweak
bvaughn Jan 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions text/0006-static-lifecycle-methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,11 +160,12 @@ class ExampleComponent extends React.Component {

```js
class ExampleComponent extends React.Component {
// Initialize state in constructor,
// Or with a property initializer.
state = {};

static getDerivedStateFromProps(nextProps, prevState) {
if (
!prevState ||
prevState.someMirroredValue !== nextProps.someValue
) {
if (prevState.someMirroredValue !== nextProps.someValue) {
return {
derivedData: computeDerivedState(nextProps),
someMirroredValue: nextProps.someValue
Expand Down Expand Up @@ -359,33 +360,33 @@ class ExampleComponent extends React.Component {

## New static lifecycle methods

### `static getDerivedStateFromProps(nextProps: Props, prevState: State | null): PartialState | null`
### `static getDerivedStateFromProps(nextProps: Props, prevState: State): PartialState | null`

This method is invoked after a component is constructed. Return an object to initialize component state. Note that the value of `prevState` may be null in this case if the constructor did not initialize `this.state`.
This method is invoked after a component is instantiated and when it receives new props. Return an object to update state in response to prop changes. Return null to indicate no change to state.

This method is also invoked before a mounted component receives new props. Return an object to update state in response to prop changes. Return null to indicate no change to state.
If an object is returned, its keys will be merged into the existing state.

Note that React may call this method even if the props have not changed. If calculating derived data is expensive, compare next and previous props to conditionally handle changes.

## Deprecated lifecycle methods

### `componentWillMount` -> `UNSAFE_componentWillMount`

This method will log a deprecation warning in development mode recommending that users use `componentDidMount` instead (when possible) or rename to `UNSAFE_componentWillMount`.
This method is deprecated and will be removed in the next major version. Read about the motivations behind this change at [fb.me/react-async-component-lifecycle-hooks](https://fb.me/react-async-component-lifecycle-hooks)

`componentWillMount` will be removed entirely in version 17.
As a temporary workaround, you can rename to `UNSAFE_componentWillMount` instead.

### `componentWillUpdate` -> `UNSAFE_componentWillUpdate`

This method will log a deprecation warning in development mode recommending that users use `componentDidUpdate` instead (when possible) or rename to `UNSAFE_componentWillUpdate`.
This method is deprecated and will be removed in the next major version. Read about the motivations behind this change at [fb.me/react-async-component-lifecycle-hooks](https://fb.me/react-async-component-lifecycle-hooks)

`componentWillUpdate` will be removed entirely in version 17.
As a temporary workaround, you can rename to `UNSAFE_componentWillUpdate` instead.

### `componentWillReceiveProps` -> `UNSAFE_componentWillReceiveProps`

This method will log a deprecation warning in development mode recommending that users use the new static `getDerivedStateFromProps` method instead (when possible) or rename to `UNSAFE_componentWillReceiveProps`.
This method is deprecated and will be removed in the next major version. Use `static getDerivedStateFromProps()` instead. Read about the motivations behind this change at [fb.me/react-async-component-lifecycle-hooks](https://fb.me/react-async-component-lifecycle-hooks)

`componentWillReceiveProps` will be removed entirely in version 17.
As a temporary workaround, you can rename to `UNSAFE_componentWillReceiveProps` instead.

# Drawbacks

Expand Down