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

[material-ui][TextField] Fix the Textarea link in the multiline section #41961

Open
wants to merge 2 commits into
base: v5.x
Choose a base branch
from

Conversation

k-utsumi
Copy link
Contributor

Signed-off-by: k-utsumi <k-utsumi@users.noreply.github.com>
@danilo-leal danilo-leal changed the base branch from master to next April 19, 2024 10:32
@danilo-leal danilo-leal changed the base branch from next to master April 19, 2024 10:32
@danilo-leal danilo-leal changed the title 🐛 Fix Textarea Autosize path in text-fields.md [material-ui][TextField] Fix the Textarea link in the multiline section Apr 19, 2024
@danilo-leal danilo-leal added docs Improvements or additions to the documentation component: text field This is the name of the generic UI component, not the React module! package: material-ui Specific to @mui/material labels Apr 19, 2024
@ZeeshanTamboli
Copy link
Member

@samuelsycamore What do you think of this? Can you take a look?

Signed-off-by: k-utsumi <k-utsumi@users.noreply.github.com>
@k-utsumi
Copy link
Contributor Author

@samuelsycamore
Copy link
Member

samuelsycamore commented May 29, 2024

I can see reasonable arguments on both sides, and I don't have a strong opinion either way. That said, I would err on the side of leaving this as is for now. It's a little annoying to be redirected to a different page like this, but the alternative is that the user would leave the Material UI docs and land in the Base UI docs without any understanding of why. I think it's important for anyone using the Textarea Autosize component in Material UI to know that it will be removed. Alternatively, we could change the link and add a note to the Base UI page explaining why Material UI users are landing there. I'm curious what @danilo-leal thinks about this.

@danilo-leal
Copy link
Contributor

Seems like a safe change; I think it's okay to do it. Though I'd do a bit more to get to @samuelsycamore's recommendation to give more context:

  • Add a "deprecated" chip to the Textarea sidebar page item on the Material UI docs to speed up the warning that visitors would find upon actually visiting the page
  • Mention that we're using Base UI's Textarea component on the Multiline paragraph of the Text Field page in Material UI. Maybe here we could give the extra context @samuelsycamore is suggesting: add a callout to not only say that we're using Base UI's component, but also why.

(And on a more tactical note, I'd point this PR to next!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: text field This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants