mirror of
https://github.com/reactjs/react.dev.git
synced 2026-02-24 04:33:10 +00:00
docs better indicate that state updaters shallowly merge with state (#9554)
this was a surprise to me because the docs seemed to indicate that when using an updater, the result _needed_ to be a new state object. I was [not alone](https://twitter.com/ken_wheeler/status/857939690191806464) i think in discovering this as a result of the previous tweet in the thread.
This commit is contained in:
@@ -243,10 +243,10 @@ Think of `setState()` as a *request* rather than an immediate command to update
|
||||
The first argument is an `updater` function with the signature:
|
||||
|
||||
```javascript
|
||||
(prevState, props) => nextState
|
||||
(prevState, props) => stateChange
|
||||
```
|
||||
|
||||
`prevState` is a reference to the previous state. It should not be directly mutated. Instead, changes should be represented by building a new state object based on the input from `prevState` and `props`. For instance, suppose we wanted to increment a value in state by `props.step`:
|
||||
`prevState` is a reference to the previous state. It should not be directly mutated. Instead, changes should be represented by building a new object based on the input from `prevState` and `props`. For instance, suppose we wanted to increment a value in state by `props.step`:
|
||||
|
||||
```javascript
|
||||
this.setState((prevState, props) => {
|
||||
@@ -254,7 +254,7 @@ this.setState((prevState, props) => {
|
||||
});
|
||||
```
|
||||
|
||||
Both `prevState` and `props` received by the updater function are guaranteed to be up-to-date.
|
||||
Both `prevState` and `props` received by the updater function are guaranteed to be up-to-date. The output of the updater is shallowly merged with `prevState`.
|
||||
|
||||
The second parameter to `setState()` is an optional callback function that will be executed once `setState` is completed and the component is re-rendered. Generally we recommend using `componentDidUpdate()` for such logic instead.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user