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

[base-ui][docs] Remove redundant "Styled" prefix #40478

Merged
merged 2 commits into from
Feb 5, 2024

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jan 7, 2024

A continuation of #37029. This feels much better. Open https://mui.com/base-ui/react-autocomplete/#hook, I can't imagine developers would want to use "Styled" in their actual implementation.

Preview: https://deploy-preview-40478--material-ui.netlify.app/base-ui/react-autocomplete/#hook

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation component: autocomplete This is the name of the generic UI component, not the React module! package: base-ui Specific to @mui/base labels Jan 7, 2024
@mui-bot
Copy link

mui-bot commented Jan 7, 2024

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 3b4d395

@oliviertassinari oliviertassinari force-pushed the remove-styled branch 2 times, most recently from 9ec3ced to 915882c Compare January 7, 2024 23:52
@oliviertassinari oliviertassinari changed the title [base-ui][Autocomplete] Remove Styled noise [base-ui][Autocomplete] Remove "Styled" noise Jan 8, 2024
@oliviertassinari oliviertassinari changed the title [base-ui][Autocomplete] Remove "Styled" noise [base-ui][docs] Remove "Styled" noise Jan 8, 2024
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 good! This is the type of thing that deserves internal documentation. In case this ever comes up again, we can share this as a guideline we follow instead of it being "silently" defined just by the code 👍

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jan 8, 2024

documentation

Agree, I think that we should agree on one of the components page as the gold standard and have these types of PRs to update it, so that when we review PRs, we can compare again the gold standard (feels better than a Notion page).

@samuelsycamore which component page should it be?

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 20, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 1, 2024
@oliviertassinari oliviertassinari enabled auto-merge (squash) February 1, 2024 01:02
@oliviertassinari
Copy link
Member Author

Adding @colmtuite to the loop as it's related to the docs experience for the demos of Base UI.

@colmtuite
Copy link
Contributor

I agree on all changes. I have an open PR #40742 which focuses just on improving the functional CSS for the button demo. I'm planning to get back to that PR this afternoon.

Once that is merged, I'm planning to open another PR on the Button component to address imports/aliases and how to handle theme values and theming. We could then review that and potentially use it as a guide for updating other component docs.

@oliviertassinari oliviertassinari changed the title [base-ui][docs] Remove "Styled" noise [base-ui][docs] Remove redundant "Styled" prefix Feb 5, 2024
@oliviertassinari oliviertassinari merged commit b43049d into mui:master Feb 5, 2024
19 checks passed
@oliviertassinari oliviertassinari deleted the remove-styled branch February 5, 2024 21:23
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: autocomplete This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: base-ui Specific to @mui/base
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants