-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
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] Migrate button demos to base #31395
Conversation
I believe so, yes. Additionally, I'd add a link to the unstyled component in the Material UI docs, similar to https://mui.com/components/menus/#unstyled
The page is not only about the ButtonUnstyled component, but also the hook. I'm not 100% convinced what's the better option, but I'm leaning more towards not having the
As in https://mui.com/material/react-menu/ - the title can describe the page is about unstyled component and a hook.
I think it'll be easier to search for if we have the full name (useButton) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went ahead and did a close reading here to implement the style guide.
As for the question of whether the word "hook" should be included, I vote yes. When the docs are talking about components, elements, hooks, etc. all right next to each other, I think it's a good idea to explicitly spell it out, at least the first time it's mentioned.
|
||
{{"demo": "UnstyledButtonCustom.js"}} | ||
|
||
## useButton hook |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## useButton hook | |
## The useButton hook |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does "The" really need is this case?
Co-authored-by: Sam Sycamore <[email protected]>
…/migrate-button-demos
@michaldudak @mnajdova The build-API script is fixed! Here is the checklist for the future components to migrate from material-ui to base.
After complete the checklist, run
|
This reverts commit f9786cd.
@michaldudak @samuelsycamore Since this PR is blocking other MUI Base pages, I think we should continue the content refinement in a separate PR. |
Co-authored-by: Michał Dudak <[email protected]>
@@ -291,6 +291,14 @@ function prepareMarkdown(config) { | |||
const description = headers.description || getDescription(markdown); | |||
const contents = getContents(markdown); | |||
|
|||
if (headers.unstyled) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
Summary
unstyled: $url
is detected in the markdownQuestions?
Should the✅ YESButtonUnstyled
API link be removed from Material UI?https://deploy-preview-31395--material-ui.netlify.app/material-ui/react-button/
Should the base has❌ No-unstyled
at the end?From: https://deploy-preview-31395--material-ui.netlify.app/base/react-button/
To: https://deploy-preview-31395--material-ui.netlify.app/base/react-button-unstyled/
Should the title & meta hasUnstyled at the beginning (take a look at Sam's comment)unstyled
at the end?The title is what appears on the search. I think having
unstyled
will teach people that base is the unstyled version. But the navigation does not need to have "unstyled".Should the word "hook" be removed?❌ No (Take a look at Sam's comment)From: useButton hook
To:
useButton
I think
use*
is already explicit that it is a react hook.cc @mui/core