Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SvgIcon] Add displayName in react-devtools #21134

Merged
merged 2 commits into from
May 25, 2020
Merged

[SvgIcon] Add displayName in react-devtools #21134

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3d462a
[createSvgIcon] fix displayName is not display in devtool
gndplayground May 21, 2020
f871c76
Document why
eps1lon May 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions packages/material-ui/src/utils/createSvgIcon.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ import SvgIcon from '../SvgIcon';
* Private module reserved for @material-ui/x packages.
*/
export default function createSvgIcon(path, displayName) {
const Component = React.memo(
React.forwardRef((props, ref) => (
<SvgIcon data-mui-test={`${displayName}Icon`} ref={ref} {...props}>
{path}
</SvgIcon>
)),
const Component = (props, ref) => (
<SvgIcon data-mui-test={`${displayName}Icon`} ref={ref} {...props}>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really related to the diff in this PR, but what do we need memo for exactly? Was it added to prevent unnecessary re-renders or something?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's one of the only components that doesn't accept a react element as a prop, so one of the few spots where memo can work on the library. Do we have a benchmark that shows the win on a real-life use case? No.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's most likely worse for perf since SvgIcon almost never has an expensive tree on which we want to bail out. But now we have it so somebody might rely on it.

{path}
</SvgIcon>
);

if (process.env.NODE_ENV !== 'production') {
// Need to set `displayName` on the inner component for React.memo.
// React prior to 16.14 ignores `displayName` on the wrapper.
Component.displayName = `${displayName}Icon`;
}

Component.muiName = SvgIcon.muiName;

return Component;
return React.memo(React.forwardRef(Component));
}