Document React.pure #1266
Closed
Document React.pure #1266
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
|
Deploy preview for reactjs ready! Built with commit 6bb9e96 |
acdlite
reviewed
Oct 19, 2018
| const MyComponent = React.pure(render, equals); | ||
| ``` | ||
|
|
||
| This method only exists as a **[performance optimization](/docs/optimizing-performance.html).** Do not rely on it to "prevent" a rendering, as this can lead to bugs. |
There was a problem hiding this comment.
Suggested change
| This method only exists as a **[performance optimization](/docs/optimizing-performance.html).** Do not rely on it to "prevent" a rendering, as this can lead to bugs. | |
| This method only exists as a **[performance optimization](/docs/optimizing-performance.html).** Do not rely on it to "prevent" a render, as this can lead to bugs. |
acdlite
reviewed
Oct 19, 2018
| @@ -26,6 +26,10 @@ React components let you split the UI into independent, reusable pieces, and thi | |||
|
|
|||
| If you don't use ES6 classes, you may use the `create-react-class` module instead. See [Using React without ES6](/docs/react-without-es6.html) for more information. | |||
|
|
|||
| React components can also be defined as functions which can be wrapped by further functionality. | |||
|
|
|||
| - [`React.pure`](#reactpure) | |||
There was a problem hiding this comment.
Suggested change
| - [`React.pure`](#reactpure) | |
| - [`React.memo`](#reactmemo) |
acdlite
reviewed
Oct 19, 2018
| ### `React.pure` | ||
|
|
||
| ```javascript | ||
| const MyComponent = React.pure(function(props) { |
There was a problem hiding this comment.
Suggested change
| const MyComponent = React.pure(function(props) { | |
| const MyComponent = React.memo(function(props) { |
acdlite
reviewed
Oct 19, 2018
| }); | ||
| ``` | ||
|
|
||
| `React.pure` is a [higher order component](/docs/higher-order-components.html). It's similar to [`React.PureComponent`](#reactpurecomponent) but for function components instead of classes. |
There was a problem hiding this comment.
Suggested change
| `React.pure` is a [higher order component](/docs/higher-order-components.html). It's similar to [`React.PureComponent`](#reactpurecomponent) but for function components instead of classes. | |
| `React.memo` is a [higher order component](/docs/higher-order-components.html). It's similar to [`React.PureComponent`](#reactpurecomponent) but for function components instead of classes. |
acdlite
reviewed
Oct 19, 2018
|
|
||
| `React.pure` is a [higher order component](/docs/higher-order-components.html). It's similar to [`React.PureComponent`](#reactpurecomponent) but for function components instead of classes. | ||
|
|
||
| If your function component renders the same result given the same props, you can wrap it in a call to `React.pure` for a performance boost in some cases by memoizing the result. |
There was a problem hiding this comment.
Suggested change
| If your function component renders the same result given the same props, you can wrap it in a call to `React.pure` for a performance boost in some cases by memoizing the result. | |
| If your function component renders the same result given the same props, you can wrap it in a call to `React.memo` for a performance boost in some cases by memoizing the result. |
acdlite
reviewed
Oct 19, 2018
| otherwise return false | ||
| */ | ||
| } | ||
| const MyComponent = React.pure(render, equals); |
There was a problem hiding this comment.
Suggested change
| const MyComponent = React.pure(render, equals); | |
| const MyComponent = React.memo(render, equals); |
acdlite
reviewed
Oct 19, 2018
| @@ -88,6 +92,42 @@ If your React component's `render()` function renders the same result given the | |||
|
|
|||
| * * * | |||
|
|
|||
| ### `React.pure` | |||
There was a problem hiding this comment.
Suggested change
| ### `React.pure` | |
| ### `React.memo` |
Merged
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.
facebook/react#13748
Pretty straight forward.
Still undecided whether we should support forwardRef by default or not. facebook/react#13822