[docs][joy] List slots in API documentation #36271
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
docs
hbjORbj
changed the title
Netlify deploy previewhttps://deploy-preview-36271--material-ui.netlify.app/ Bundle size report |
hbjORbj
force-pushed
the
joy/api-slots-section
branch
from
01adb39 to
4c93697
Compare
github-actions
bot
added
the
PR: out-of-date
hbjORbj
force-pushed
the
joy/api-slots-section
branch
from
b8dcd1b to
9718f5f
Compare
github-actions
bot
removed
the
PR: out-of-date
siriwatknp
reviewed
Feb 22, 2023
siriwatknp
reviewed
Feb 22, 2023
Comment on lines
+26
to
+27
| export type CreateSlotsAndSlotProps<Slots, K extends Record<keyof Slots, any>> = { | ||
| slots?: Partial<Slots>; |
There was a problem hiding this comment.
Is my understanding is correct that this change is necessary for the API generation?
There was a problem hiding this comment.
- This change was needed so we could read the properties inside
slotsand its JSDoc. - I also noticed that we miss 'slotProps' and 'slots' in our API docs. That's a different issue. I was going to address this in a separate PR.
There was a problem hiding this comment.
This change was needed so we could read the properties inside slots and its JSDoc.
👌 Got it.
siriwatknp
approved these changes
Feb 22, 2023
siriwatknp
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Feb 24, 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.
Preview: https://deploy-preview-36271--material-ui.netlify.app/joy-ui/api/alert/#slots <- Alert API Doc