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] Improve the Base Usage page #33272

Merged
merged 11 commits into from Aug 15, 2022
Merged

[docs] Improve the Base Usage page #33272

merged 11 commits into from Aug 15, 2022

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Jun 23, 2022 •
edited

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

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: base-ui Specific to @mui/base labels Jun 23, 2022
@mui-bot
Copy link

mui-bot commented Jun 23, 2022 •
edited

No bundle size changes

Generated by 🚫 dangerJS against decf585

@ZeeshanTamboli ZeeshanTamboli mentioned this pull request Jun 24, 2022
Merged
1 task
@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
samuelsycamore and others added 2 commits July 10, 2022 20:59
@samuelsycamore @siriwatknp
Update docs/data/base/getting-started/usage/usage.md
142d1b4 
Co-authored-by: Siriwat K <siriwatkunaporn@gmail.com>
@samuelsycamore
bringing up to date
65b0ea9
@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
@samuelsycamore samuelsycamore mentioned this pull request Jul 18, 2022
Merged
danilo-leal
danilo-leal approved these changes Aug 9, 2022
View reviewed changes
Copy link
Contributor

@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!

michaldudak
michaldudak approved these changes Aug 12, 2022
View reviewed changes
Copy link
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!

mnajdova
mnajdova reviewed Aug 12, 2022
View reviewed changes
Copy link
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 :)

docs/data/base/getting-started/usage/usage.md Outdated Show resolved Hide resolved
@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
@samuelsycamore
[docs] Improve the Base Usage page (mui#33272)
e8b7962
@samuelsycamore samuelsycamore 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
Reviewers

@mnajdova mnajdova mnajdova approved these changes

@michaldudak michaldudak michaldudak approved these changes

@danilo-leal danilo-leal danilo-leal approved these changes

@siriwatknp siriwatknp Awaiting requested review from siriwatknp

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

Successfully merging this pull request may close these issues.

None yet
6 participants
@samuelsycamore @mui-bot @mnajdova @michaldudak @siriwatknp @danilo-leal