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

[studio-docs] Improve textfield docs and re-establish links to Material UI components #3929

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

[studio-docs] Improve textfield docs and re-establish links to Material UI components #3929

wants to merge 13 commits into from

Conversation

prakhargupta1
Copy link
Member

@prakhargupta1 prakhargupta1 commented Aug 12, 2024 •
edited
Loading

Addresses point 1 of #3675 (comment). This will just re-establish the links back to Material UI docs. Tried 2,3 a bit but couldn't make it work.

Also, added a demo for textfield validation props. Preview: https://deploy-preview-3929--mui-toolpad-docs.netlify.app/toolpad/studio/components/text-field/#minlength

@prakhargupta1 prakhargupta1 added the docs Improvements or additions to the documentation label Aug 13, 2024
@prakhargupta1 prakhargupta1 marked this pull request as ready for review August 13, 2024 10:34
@prakhargupta1 prakhargupta1 changed the title [docs] Improve textfield docs and re-establish links to Material UI components [studio-docs] Improve textfield docs and re-establish links to Material UI components Aug 19, 2024
@apedroferreira
Copy link
Member

apedroferreira commented Aug 19, 2024 •
edited
Loading

I guess we should add a demo for isRequired and maxLength validation too? Or just one single demo that covers all of them?
I can do it and clean up the demos and descriptions a bit if you need help!

@prakhargupta1
Copy link
Member Author

prakhargupta1 commented Aug 20, 2024 •
edited
Loading

I guess we should add a demo for isRequired and maxLength validation too?

I agree, added demos for isRequired and maxLength as well and expanded on their description.

@apedroferreira
Copy link
Member

I've added some copy suggestions + a commit to make the demo text fields have a fixed width so that it doesn't change when they show an error.

@prakhargupta1
Copy link
Member Author

prakhargupta1 commented Aug 23, 2024 •
edited
Loading

I've added some copy suggestions + a commit to make the demo text fields have a fixed width so that it doesn't change when they show an error.

Thanks, not having a fixed with was an issue.
There remain some vale errors that show up in the auto-generated docs, I guess I can't manually edit them. Can you help me with it?

@apedroferreira
Copy link
Member

I've added some copy suggestions + a commit to make the demo text fields have a fixed width so that it doesn't change when they show an error.

Thanks, not having a fixed with was an issue. There remain some vale errors that show up in the auto-generated docs, I guess I can't manually edit them. Can you help me with it?

I changed the casing in two files and then Git always has some issues with that, sorry for that!
I don't see any vale errors, all the checks seem green?

@prakhargupta1
Copy link
Member Author

I don't see any vale errors, all the checks seem green?

Yeah my bad no errors, there are just some warnings that we can ignore I guess.

@apedroferreira
Copy link
Member

I've added a commit to fix the vale warnings!

@prakhargupta1 prakhargupta1 mentioned this pull request Aug 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apedroferreira apedroferreira apedroferreira approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@prakhargupta1 @apedroferreira