feat: make element types more accurate #252
Merged
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
Library consumers may provide any `ElementType` as the `tagName` for the elements created by the library, but the elements themselves were typed as `HTMLDivElement`. The types are widened to the more accurate `HTMLElement`, and some variable names adjusted to reflect the types, e.g. `divElementRef` -> `elementRef`.
This was too wide, allowing for non-HTML element tags like `svg`, which cause runtime errors. Closes bvaughn#251
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Looks like this broke a bunch of things in CI. |
psychedelicious
commented
Dec 30, 2023
Comment on lines
-93
to
+96
| }) { | ||
| }): ReactNode { |
There was a problem hiding this comment.
When I added keyof HTMLElementTagNameMap, declaration generation failed despite tsc being happy. The error message was a red herring - the components just need an explicit return type. Not sure what to make of that.
Maybe just ReactElement is more appropriate?
There was a problem hiding this comment.
That's interesting. Not sure why that is, but I think ReactNode makes sense as the return type 👍🏼
Was trying to fix the CI issue and missed reverting these changes.
bvaughn
approved these changes
Dec 31, 2023
Comment on lines
-93
to
+96
| }) { | ||
| }): ReactNode { |
There was a problem hiding this comment.
That's interesting. Not sure why that is, but I think ReactNode makes sense as the return type 👍🏼
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.
This widens the usage of
HTMLDivElementtoHTMLElementthroughout.Also narrows the allowed tag names to actual HTML elements. Closes #251