Document React.memo #1282
Merged
Document React.memo #1282
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
gaearon
reviewed
Oct 23, 2018
content/docs/reference-react.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
functions [...] functionality
a bit repetitive?
gaearon
reviewed
Oct 23, 2018
content/docs/reference-react.md
Outdated
|
|
||
| `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. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Our readers probably don't know what "memoize" means. Maybe add
(This means that React will skip rendering the component, and reuse the last rendered result.)
gaearon
reviewed
Oct 23, 2018
content/docs/reference-react.md
Outdated
| By default it will only shallowly compare complex objects in the props object. If you want control over the comparison, you can also provide a custom comparison function as the second argument. | ||
|
|
||
| ```javascript | ||
| function render(props) { |
There was a problem hiding this comment.
We should probably encourage proper name here so it shows up in DevTools
|
Deploy preview for reactjs ready! Built with commit f9da7e9 |
gaearon
reviewed
Oct 23, 2018
content/docs/reference-react.md
Outdated
| ### `React.memo` | ||
|
|
||
| ```javascript | ||
| const MyComponent = React.memo(function(props) { |
Uses default exports
sebmarkbage
commented
Oct 23, 2018
content/docs/reference-react.md
Outdated
| otherwise return false | ||
| */ | ||
| } | ||
| export default React.memo(MyComponent, equals); |
There was a problem hiding this comment.
Thoughts on using export default here? I don't want to name it something like MyComponentMemo since then people will just copy that pattern which is not how you're supposed to do it.
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.
Supersedes #1266