[Badge][base] Drop component prop
#37028
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
hbjORbj
added
component: badge
Netlify deploy previewBundle size report |
github-actions
bot
added
the
PR: out-of-date
hbjORbj
force-pushed
the
badge/component-prop
branch
from
b1482ab
to
c112f5d
Compare
github-actions
bot
removed
the
PR: out-of-date
19 tasks
michaldudak
reviewed
Apr 26, 2023
| @@ -89,6 +85,20 @@ The following code snippet applies a CSS class called `my-badge` to the badge sl | |||
| <Badge slotProps={{ badge: { className: 'my-badge' } }} /> | |||
| ``` | |||
|
|
|||
| #### Usage with TypeScript | |||
|
|
|||
| In TypeScript, you can specify the custom component type used in the `slots.root` as a generic to the unstyled component. This way, you can safely provide the custom compoenent's props directly on the compnent: | |||
There was a problem hiding this comment.
Suggested change
| In TypeScript, you can specify the custom component type used in the `slots.root` as a generic to the unstyled component. This way, you can safely provide the custom compoenent's props directly on the compnent: | |
| In TypeScript, you can specify the custom component type used in the `slots.root` as a generic parameter of the unstyled component. This way, you can safely provide the custom root's props directly on the component: |
There was a problem hiding this comment.
will do the same for other components' markdown too
michaldudak
reviewed
Apr 26, 2023
| /> | ||
|
|
||
| {/* @ts-expect-error onClick must be specified in the custom root component */} | ||
| <Badge<typeof CustomRoot> slots={{ root: CustomRoot }} onClick={() => {}} /> |
There was a problem hiding this comment.
IMO this test was pretty specific to a button. I don't think we need to have it in all components
michaldudak
reviewed
Apr 26, 2023
| @@ -77,7 +76,7 @@ const Badge = React.forwardRef(function Badge<RootComponentType extends React.El | |||
| className: classes.root, | |||
| }); | |||
|
|
|||
| const BadgeComponent = slots.badge || 'span'; | |||
| const BadgeComponent = slots.badge ?? 'span'; | |||
michaldudak
reviewed
Apr 27, 2023
| ::: | ||
|
|
||
| Use the `component` prop to override the root slot with a custom element: | ||
| Use the `slots.root` prop to override the root slot with a custom element: |
There was a problem hiding this comment.
I'd remove this paragraph and change the next one to: "Use the slots prop to override the root or any other interior slot."
hbjORbj
force-pushed
the
badge/component-prop
branch
from
8519708
to
b971587
Compare
michaldudak
approved these changes
Apr 27, 2023
|
The changes look OK. Please make sure the build check pass and it should be good to go. |
hbjORbj
force-pushed
the
badge/component-prop
branch
from
81a285c
to
ca1a638
Compare
hbjORbj
force-pushed
the
badge/component-prop
branch
from
05df30c
to
3bf3cc2
Compare
binh1298
pushed a commit
to binh1298/material-ui
that referenced
this pull request
May 17, 2023
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.
BREAKING CHANGE
It will be covered by codemod, see #36831
For Base UI components, the
componentprop value should be moved toslots.root:If using TypeScript, you should add the custom component type as a generic on the
Badgecomponent.