fix(button): fix prop types for button #1473
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
|
🚀 Deployed on https://pr-1473--dhis2-ui.netlify.app |
Passing run #3401 ↗︎
Details:
Review all test suite changes for PR #1473 ↗︎ |
|||||||||||||||
Birkbjo
force-pushed
the
fix/button-prop-types
branch
from
9199aaf to
9e9ba33
Compare
KaiVandivier
approved these changes
May 22, 2024
Comment on lines
+105
to
+106
| export type ButtonProps = BaseButtonProps & | ||
| Omit<React.ComponentPropsWithoutRef<'button'>, keyof BaseButtonProps> |
There was a problem hiding this comment.
Suggested change
| export type ButtonProps = BaseButtonProps & | |
| Omit<React.ComponentPropsWithoutRef<'button'>, keyof BaseButtonProps> | |
| // For prop types we don't define, use native HTML button props | |
| // See https://github.com/dhis2/ui/pull/1473 | |
| export type ButtonProps = BaseButtonProps & | |
| Omit<React.ComponentPropsWithoutRef<'button'>, keyof BaseButtonProps> |
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.
Description
I don't think we should extend
HTML-elements directly. In some cases liketabIndexwe're actually using a conflicting type, which causes type-errors in our types.tabIndexshould really be anumber(that's what the html type is), but that would be breaking due to our prop-types etc.So instead of ButtonProps extending the
HTMLButtonElement, I'm using type intersection with theComponentPropsWithoutRef<'button'>without the keys forButtonProps, to avoid conflicts.I also split this in two types types because eg.
export interface ButtonProps extends Omit<React.ComponentPropsWithoutRef<'button'>, keyof ButtonProps>) wouldn't work because of circular references.See https://github.com/typescript-cheatsheets/react/blob/main/docs/advanced/patterns_by_usecase.md#wrappingmirroring, and expand "Why not ComponentProps or IntrinsicElements or [Element]HTMLAttributes or HTMLProps or HTMLAttributes?" for why we're using
ComponentPropsWithoutRef, as opposed to the other prop-types.