[useEuiTheme] return a memoized object for performance #6165
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
…nt, to help react optimize rendering performance
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_6165/ |
1 similar comment
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_6165/ |
thompsongl
approved these changes
Aug 24, 2022
Comment on lines
-57
to
-61
| theme={{ | ||
| euiTheme, | ||
| colorMode, | ||
| modifications, | ||
| }} |
There was a problem hiding this comment.
Ah good catch that this creates a new object on every render 🙇♂️
Co-authored-by: Greg Thompson <[email protected]>
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_6165/ |
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.
Summary
Fixes #6159
Threw a console.log in EuiIcon's render and verified any time its owner component rendered, the icon would unexpectedly re-render as well. Narrowed it down to a different
themeprop coming in fromwithEuiThemeon every render, and traced object creation to bothuseEuiThemeandwithEuiTheme.withEuiThemeupdated to forwarduseEuiTheme's return value into the wrapped componentuseEuiThemeupdated with auseMemoto keep the resulting object stableChecklist
- [ ] Checked in both light and dark modes- [ ] Checked in mobile- [ ] Checked in Chrome, Safari, Edge, and Firefox- [ ] Props have proper autodocs and playground toggles- [ ] Added documentation- [ ] Checked Code Sandbox works for any docs examples- [ ] Checked for accessibility including keyboard-only and screenreader modes- [ ] Updated the Figma library counterpart