[docs] Update links and sidebar nav for Base UI components in Material UI #44581
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
samuelsycamore
requested review from
aarongarciah,
DiegoAndai,
zanivan and
alelthomas
aarongarciah
approved these changes
Dec 2, 2024
There was a problem hiding this comment.
Nice
adds deprecated chips to the sidebar nav for the 4 Base UI components included in Material UI (suggested in this comment - I'm on the fence about it so I'm curious what others think)
Since these components are deprecated, I think it makes sense to mark them as deprecated.
| @@ -44,8 +44,8 @@ The `helperText` prop can then be used to provide feedback to the user about the | |||
|
|
|||
| ## Multiline | |||
|
|
|||
| The `multiline` prop transforms the text field into a [TextareaAutosize](/material-ui/react-textarea-autosize/) element. | |||
| Unless the `rows` prop is set, the height of the text field dynamically matches its content (using [TextareaAutosize](/material-ui/react-textarea-autosize/)). | |||
| The `multiline` prop transforms the Text Field into a [Base UI Textarea Autosize](/base-ui/react-textarea-autosize/) element. | |||
There was a problem hiding this comment.
off-topic: I find this convention weird. As a user I always prefer to read the actual component name:
- "TextField" vs "Text Field"
- "TextareaAutosize" vs "Textarea Autosize"
- "ClickAwayListener" vs "Click-Away Listener"
There was a problem hiding this comment.
Interesting. This was a style convention we adopted a few years ago to try to help improve readability as I recall. But if it's not actually helping then maybe we should consider re-evaluating it as an org.
alelthomas
approved these changes
Dec 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up to #41961
deprecatedchips to the sidebar nav for the 4 Base UI components included in Material UI (suggested in this comment - I'm on the fence about it so I'm curious what others think)