-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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.
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
fix(Icon): Support null tagName in Icon component #6981
Conversation
Generate changelog in
|
Update test to check for presence of span elementBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
@@ -171,7 +171,7 @@ export const Icon: IconComponent = React.forwardRef(function <T extends Element> | |||
: size === IconSize.LARGE | |||
? Classes.ICON_LARGE | |||
: undefined; | |||
return React.createElement(tagName!, { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it makes sense to ensure this value is always a valid element. The alternative would be to do something like a null check and return early, e.g.
if (tagName == null) {
return null;
}
return React.createElement(tagName, { ... });
The former will show a blip of the fallback while the icon paths load:
whereas the later will appear and shift in without any placeholder at all:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any particular reason to use ||
here over ??
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, I suppose the only main difference is that ||
will use "span"
as the default for any falsy value, including ""
, 0
, and false
. If the user is consuming this component in TypeScript, there is functionally no difference since tagName
is either type ofReact.JSX.IntrinsicElements
or null
.
Do we care about this edge case for non-TypeScript consumers?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah okay, that makes sense. I think its fair to keep this for non-TS consumers.
Fixes #6974
Checklist
Changes proposed in this pull request:
Fixes a condition where a null element gets passed into
React.createElement
while the icon is loading paths asynchronously. This prevents an error in the Icon component whennull
is passed in as thetagName
.