Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[docs][Joy] component, slots, slotProps must be visible in Prop table in API docs #36666

Merged
merged 6 commits into from
Apr 13, 2023
Merged

[docs][Joy] component, slots, slotProps must be visible in Prop table in API docs #36666

merged 6 commits into from
Apr 13, 2023

Conversation

hbjORbj
Copy link
Member

@hbjORbj hbjORbj commented Mar 28, 2023 •
edited
Loading

⚠️ This PR must be merged after ##36599 and #36540 are merged.

@hbjORbj hbjORbj marked this pull request as draft March 28, 2023 05:05
@hbjORbj hbjORbj self-assigned this Mar 28, 2023
@hbjORbj hbjORbj added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Mar 28, 2023
@mui-bot
Copy link

mui-bot commented Mar 28, 2023 •
edited
Loading

Netlify deploy preview

https://deploy-preview-36666--material-ui.netlify.app/

@mui/joy: parsed: +1.29% , gzip: +1.06%

Bundle size report

Details of bundle changes

Generated by 🚫 dangerJS against 3c75b90

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 5, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 9, 2023
@hbjORbj hbjORbj force-pushed the joy/proptypes branch 2 times, most recently from 158c924 to bf81ce3 Compare April 9, 2023 21:31
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 9, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 9, 2023
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 9, 2023
@hbjORbj hbjORbj force-pushed the joy/proptypes branch 3 times, most recently from 13fb1e4 to a7216f4 Compare April 9, 2023 21:43
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 9, 2023
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 9, 2023
@github-actions github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels Apr 9, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 10, 2023
@hbjORbj
Copy link
Member Author

hbjORbj commented Apr 10, 2023

Both #36599 and #36540 are merged. This is ready for review. @siriwatknp

@hbjORbj hbjORbj requested a review from siriwatknp April 10, 2023 09:07
@hbjORbj hbjORbj marked this pull request as ready for review April 10, 2023 09:07
siriwatknp
siriwatknp reviewed Apr 11, 2023
View reviewed changes
packages/mui-joy/src/Alert/Alert.tsx
Comment on lines +127 to +129
component,
slots = {},
slotProps = {},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hbjORbj What's the reason to explicitly declare these props and compose them again in the externalForwardedProps?

My intention is that the useSlot will take care of them internally so we don't have to do this in all components.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we don't do this, then they don't show up in Proptypes (and hence not in JSON files), and hence they don't appear in Prop table in API docs

siriwatknp
siriwatknp approved these changes Apr 13, 2023
View reviewed changes
Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks for the work!

One last thing, can you check that slots test is added to all of the components? e.g. AutocompleteOption is missing the test.

@hbjORbj hbjORbj merged commit 75c1dfb into mui:master Apr 13, 2023
@hbjORbj
Copy link
Member Author

hbjORbj commented Apr 13, 2023 •
edited
Loading

@siriwatknp I've already handled that in this PR and merged it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@siriwatknp siriwatknp siriwatknp approved these changes

Assignees

@hbjORbj hbjORbj

Labels
docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hbjORbj @mui-bot @siriwatknp