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] Move 5 component names to Title Case #34118

Merged
merged 4 commits into from
Sep 3, 2022
Merged

[docs] Move 5 component names to Title Case #34118

merged 4 commits into from
Sep 3, 2022

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Aug 28, 2022 •
edited
Loading

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation core Infrastructure work going on behind the scenes labels Aug 28, 2022
@oliviertassinari
Copy link
Member Author

The CODEOWNER got it wrong here, I only updated documentation on these components, it shouldn't have asked for a review for everybody.

@mui-bot
Copy link

mui-bot commented Aug 28, 2022 •
edited
Loading

No bundle size changes

Generated by 🚫 dangerJS against 2072f19

samuelsycamore
samuelsycamore reviewed Sep 1, 2022
View reviewed changes
Copy link
Contributor

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

I'm glad to see more consistency here! Unstyled components should also be treated as proper nouns and capitalized.

docs/data/material/components/button-group/button-group.md Outdated Show resolved Hide resolved
docs/pages/base/api/button-unstyled.json
@@ -24,6 +24,6 @@
"forwardsRefTo": "HTMLButtonElement",
"filename": "/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/base/react-button/\">Button</a></li></ul>",
"demos": "<ul><li><a href=\"/base/react-button/\">Unstyled button</a></li></ul>",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"demos": "<ul><li><a href=\"/base/react-button/\">Unstyled button</a></li></ul>",
"demos": "<ul><li><a href=\"/base/react-button/\">Unstyled Button</a></li></ul>",

docs/pages/base/api/click-away-listener.json
@@ -23,6 +23,6 @@
"spread": false,
"filename": "/packages/mui-base/src/ClickAwayListener/ClickAwayListener.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/base/react-click-away-listener/\">Click away listener</a></li></ul>",
"demos": "<ul><li><a href=\"/base/react-click-away-listener/\">Click-away listener</a></li></ul>",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"demos": "<ul><li><a href=\"/base/react-click-away-listener/\">Click-away listener</a></li></ul>",
"demos": "<ul><li><a href=\"/base/react-click-away-listener/\">Click-Away Listener</a></li></ul>",

docs/pages/base/api/form-control-unstyled.json
@@ -16,6 +16,6 @@
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-base/src/FormControlUnstyled/FormControlUnstyled.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/base/react-form-control/\">Form control</a></li></ul>",
"demos": "<ul><li><a href=\"/base/react-form-control/\">Unstyled form control</a></li></ul>",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"demos": "<ul><li><a href=\"/base/react-form-control/\">Unstyled form control</a></li></ul>",
"demos": "<ul><li><a href=\"/base/react-form-control/\">Unstyled Form Control</a></li></ul>",

docs/pages/base/api/input-unstyled.json
@@ -47,6 +47,6 @@
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-base/src/InputUnstyled/InputUnstyled.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/base/react-input/\">Input</a></li></ul>",
"demos": "<ul><li><a href=\"/base/react-input/\">Unstyled input</a></li></ul>",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"demos": "<ul><li><a href=\"/base/react-input/\">Unstyled input</a></li></ul>",
"demos": "<ul><li><a href=\"/base/react-input/\">Unstyled Input</a></li></ul>",

packages/mui-material/src/FormControl/FormControl.d.ts
* - [Switches](https://mui.com/material-ui/react-switch/)
* - [Text fields](https://mui.com/material-ui/react-text-field/)
* - [Checkbox](https://mui.com/material-ui/react-checkbox/)
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
* - [Radio Button](https://mui.com/material-ui/react-radio-button/)

packages/mui-material/src/FormControlLabel/FormControlLabel.d.ts
* - [Radio buttons](https://mui.com/material-ui/react-radio-button/)
* - [Switches](https://mui.com/material-ui/react-switch/)
* - [Checkbox](https://mui.com/material-ui/react-checkbox/)
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
* - [Radio Button](https://mui.com/material-ui/react-radio-button/)

packages/mui-material/src/FormLabel/FormLabel.d.ts
* - [Radio buttons](https://mui.com/material-ui/react-radio-button/)
* - [Switches](https://mui.com/material-ui/react-switch/)
* - [Checkbox](https://mui.com/material-ui/react-checkbox/)
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
* - [Radio Button](https://mui.com/material-ui/react-radio-button/)

packages/mui-material/src/Radio/Radio.d.ts
@@ -55,7 +55,7 @@ export interface RadioProps
*
* Demos:
*
* - [Radio buttons](https://mui.com/material-ui/react-radio-button/)
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
* - [Radio Button](https://mui.com/material-ui/react-radio-button/)

packages/mui-material/src/RadioGroup/RadioGroup.d.ts
@@ -31,7 +31,7 @@ export type RadioGroupClassKey = keyof NonNullable<RadioGroupProps['classes']>;
*
* Demos:
*
* - [Radio buttons](https://mui.com/material-ui/react-radio-button/)
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* - [Radio button](https://mui.com/material-ui/react-radio-button/)
* - [Radio Button](https://mui.com/material-ui/react-radio-button/)

Copy link
Member Author

@oliviertassinari oliviertassinari Sep 2, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

@samuelsycamore I can't apply any of your suggestions as these lines are auto-generated. It's taking the h1 of https://mui.com/material-ui/react-radio-button/.

Copy link
Member Author

@oliviertassinari oliviertassinari Sep 2, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Also, I don't agree on this one. Maybe we should rename it to "Radio Group", like https://www.w3.org/WAI/ARIA/apg/patterns/radiobutton/.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, I didn't realize these were auto-generated. Can we change the way they're generated so that they capitalize every word in the name? Otherwise it's inconsistent.

@michaldudak
Copy link
Member

image
image
😅

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Sep 2, 2022 •
edited
Loading

@michaldudak Most of this is auto-generated. I fixed the logic that extracts the titles for the demo links. Before, it was generated arbitrarily. Now it's using the H1 of the page it links to, which is a lot more reliable and consistent.

@oliviertassinari oliviertassinari changed the title [docs] Move a few component names to Title Case [docs] Move 5 component names to Title Case Sep 3, 2022
@oliviertassinari oliviertassinari merged commit 6fd17fc into mui:master Sep 3, 2022
@oliviertassinari oliviertassinari deleted the new-component-name-convention branch September 3, 2022 15:56
@oliviertassinari oliviertassinari mentioned this pull request Sep 3, 2022
Merged
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Sep 3, 2022 •
edited
Loading

I have renamed the title to be clearer, I changed 5 components, no more, there are > 50 to handle. I'm merging as the feedback so far were covering matters outside of the scope of this PR 😁

daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
@oliviertassinari
[docs] Move 5 component names to Title Case (mui#34118)
95d7d82
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samuelsycamore samuelsycamore samuelsycamore left review comments

Assignees
No one assigned
Labels
core Infrastructure work going on behind the scenes docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@oliviertassinari @mui-bot @michaldudak @samuelsycamore