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.

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

[docs][joy] Improve the descriptions of props in API docs #36307

Merged
merged 6 commits into from
Feb 25, 2023

Conversation

hbjORbj
Copy link
Member

@hbjORbj hbjORbj commented Feb 23, 2023

@hbjORbj hbjORbj self-assigned this Feb 23, 2023
@hbjORbj hbjORbj added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Feb 23, 2023
@mui-bot
Copy link

mui-bot commented Feb 23, 2023

Netlify deploy preview

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against 3d31bc2

@hbjORbj hbjORbj requested a review from siriwatknp February 23, 2023 12:41
@siriwatknp
Copy link
Member

the Props table

let's change the description of these props for all components

  • color: (we need to create #extend-colors section in Themed components—Extend colors
    The color of the component. It supports those theme colors that make sense for this component.
    
    To learn how to add your own colors, check out [Themed components—Extend colors](https://mui.com/joy-ui/customization/themed-components/#extend-colors).
  • size:
    The size of the component.
    
    To learn how to add custom sizes to the component, check out [Themed components—Extend sizes](https://mui.com/joy-ui/customization/themed-components/#extend-sizes).
  • variant:
    The [global variant](https://mui.com/joy-ui/main-features/global-variants/) to use.
       
    To learn how to add your own variants, check out [Themed components—Extend variants](https://mui.com/joy-ui/customization/themed-components/#extend-variants).

Slots table

image

Needs #34990 to be merged. I think this can be a separate PR?

@hbjORbj
Copy link
Member Author

hbjORbj commented Feb 24, 2023

Thanks, Jun.

@hbjORbj hbjORbj requested a review from siriwatknp February 24, 2023 13:35
@hbjORbj hbjORbj changed the title [docs][joy] Improve the descriptions of slots in API docs [docs][joy] Improve the descriptions of props in API docs Feb 24, 2023
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.

👍 Nicely done!

@hbjORbj hbjORbj merged commit a150964 into mui:master Feb 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants