Clarify immutable state #9920
Closed
Clarify immutable state #9920
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
State is described as immutable [here](https://facebook.github.io/react/docs/react-component.html#state): "Never mutate this.state directly, as calling setState() afterwards may replace the mutation you made. Treat this.state as if it were immutable." However, on the Immutability Helper page, state is described as [optionally mutable](https://facebook.github.io/react/docs/update.html#overview): "React lets you use whatever style of data management you want, including mutation." I've provided a suggestion for clarification.
aweary
reviewed
Jun 15, 2017
| @@ -19,7 +19,7 @@ var update = require('react-addons-update'); // ES5 with npm | |||
|
|
|||
| ## Overview | |||
|
|
|||
| React lets you use whatever style of data management you want, including mutation. However, if you can use immutable data in performance-critical parts of your application it's easy to implement a fast [`shouldComponentUpdate()`](/react/docs/react-component.html#shouldcomponentupdate) method to significantly speed up your app. | |||
| React lets you use whatever style of data management you want, including mutation. However, React's state should be treated as immutable. Immutable data makes it easy to implement a fast [`shouldComponentUpdate()`](/react/docs/react-component.html#shouldcomponentupdate) method to significantly speed up your app. | |||
There was a problem hiding this comment.
I'm worried this might be too specific since the original sentence covered immutable data in props and context as well.
|
Thank you for filing this PR! I'm sorry to be the bearer of bad news, but the documentation and source code for reactjs.org now lives in a different repository: reactjs/reactjs.org. (For more info on why we made this move, see issue #11075.) Would you be willing to re-open this PR on the new repo? I promise we'll review it quickly! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
State is described as immutable here:
"Never mutate this.state directly, as calling setState() afterwards may replace the mutation you made. Treat this.state as if it were immutable."
However, on the Immutability Helper page, state is described as optionally mutable:
"React lets you use whatever style of data management you want, including mutation."
I've provided a suggestion for clarification.
Before submitting a pull request, please make sure the following is done:
master.npm test).npm run lint).npm run prettier).npm run flow)../scripts/fiber/record-testsbefore submitting the pull request, and commit the resulting changes.