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] Add styles to styled argument list #37558

Merged
merged 1 commit into from
Jun 14, 2023

Conversation

DiegoAndai
Copy link
Member

@DiegoAndai DiegoAndai commented Jun 9, 2023

Related issues:

The styles argument is not listed in the styled function arguments list. Adding it will help with its usage.

A few questions

  • styled` can receive multiple arguments, all with the same type, should we document it? I think it would create more confusion, so my answer is no, but if you disagree please let me know
  • I used ({ ...props, theme }) => object as the function signature because that's the most concise way I could come up with to explain it, but I would appreciate alternatives if you think of some
  • Is there anything else that we should add to the explanation?

@DiegoAndai DiegoAndai added docs Improvements or additions to the documentation package: system Specific to @mui/system RFC Request For Comments labels Jun 9, 2023
@DiegoAndai DiegoAndai self-assigned this Jun 9, 2023
@DiegoAndai DiegoAndai requested a review from a team June 9, 2023 20:04
@mui-bot
Copy link

mui-bot commented Jun 9, 2023

Netlify deploy preview

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against 57ccfba

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.

👍 Nice improvement!

@DiegoAndai DiegoAndai merged commit cc5704e into mui:master Jun 14, 2023
21 checks passed
@DiegoAndai DiegoAndai deleted the styled-docs-styles-argument branch June 14, 2023 18:12
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: system Specific to @mui/system RFC Request For Comments
Projects
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

None yet

3 participants