Skip to content

[docs] Improve the Base Usage page#33272

Merged
mnajdova merged 11 commits intomui:masterfrom
mapache-salvaje:base-usage-clarify
Aug 15, 2022
Merged

[docs] Improve the Base Usage page#33272
mnajdova merged 11 commits intomui:masterfrom
mapache-salvaje:base-usage-clarify

Conversation

@mapache-salvaje
Copy link
Copy Markdown
Contributor

@mapache-salvaje mapache-salvaje commented Jun 23, 2022

https://deploy-preview-33272--material-ui.netlify.app/base/getting-started/usage/

I've gotten a better understanding of the component slots and the props that control them as I've been documenting them in #33156, so this PR adds some clarification to the Base Usage page where they're explained in detail.

Changes include:

  • standardizing the "slot" terminology
  • tweaking the Getting started code snippet to match the updated pattern on component pages
  • clarifying that shared props do not apply to utility components
  • pointing out the difference in slot casing between components and componentsProps
  • suggesting that componentsProps and components may be redundant for components that only have a root slot
  • recommending that users start with components over hooks

@mapache-salvaje mapache-salvaje added docs Improvements or additions to the documentation. package: @mui/base Specific to @mui/base (legacy). labels Jun 23, 2022
@mui-bot
Copy link
Copy Markdown

mui-bot commented Jun 23, 2022

No bundle size changes

Generated by 🚫 dangerJS against decf585

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Jun 24, 2022
mapache-salvaje and others added 2 commits July 10, 2022 20:59
Co-authored-by: Siriwat K <siriwatkunaporn@gmail.com>
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Jul 11, 2022
Copy link
Copy Markdown
Collaborator

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Looks great!

Copy link
Copy Markdown
Member

@michaldudak michaldudak left a comment

Choose a reason for hiding this comment

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

Looks good to me now!

Copy link
Copy Markdown
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

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

Just one detail, not sure if it is important to be emphasized :)

@mnajdova mnajdova merged commit 67ea8eb into mui:master Aug 15, 2022
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
@mapache-salvaje mapache-salvaje deleted the base-usage-clarify branch April 3, 2024 17:23
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: @mui/base Specific to @mui/base (legacy).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants