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] Revise and expand Joy UI Checkbox doc #35817

Merged
merged 20 commits into from
Jan 25, 2023
Merged

[docs] Revise and expand Joy UI Checkbox doc #35817

merged 20 commits into from
Jan 25, 2023

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Jan 13, 2023 •
edited
Loading

Part of #33998

This PR revises and expands the Joy UI Checkbox component doc.

Notable changes include:

  • expanded Introduction with guidance on usage vs Switches and Radio Buttons
  • details on Variants, Sizes, and Colors, along with demos showing off all options
  • more descriptive Label text for demos
  • clarifying the "indeterminate" state
  • additional details throughout all sections
  • anatomy

https://deploy-preview-35817--material-ui.netlify.app/joy-ui/react-checkbox/

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation component: checkbox This is the name of the generic UI component, not the React module! package: joy-ui Specific to @mui/joy labels Jan 13, 2023
@samuelsycamore samuelsycamore mentioned this pull request Jan 13, 2023
Open
61 tasks
@mui-bot
Copy link

mui-bot commented Jan 13, 2023 •
edited
Loading

Messages
📖 Netlify deploy preview: https://deploy-preview-35817--material-ui.netlify.app/

No bundle size changes

Generated by 🚫 dangerJS against 5c19646

@samuelsycamore samuelsycamore marked this pull request as ready for review January 23, 2023 20:08
siriwatknp
siriwatknp approved these changes Jan 24, 2023
View reviewed changes
Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

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

👍 Looks great! left a few comments.

docs/data/joy/components/checkbox/checkbox.md
Comment on lines +22 to +23
- Use a switch to provide the user with **a single binary choice**—checkboxes are preferable when you need to give the user multiple binary choices.
- Use radio buttons to give the user **mutually exclusive options**—checkboxes are preferable when you need to let the user select one, some, all, or none from a series of options.
Copy link
Member

Choose a reason for hiding this comment

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

🤩 Superb!

docs/data/joy/components/checkbox/checkbox.md Outdated Show resolved Hide resolved
@DevinCLane DevinCLane mentioned this pull request Jan 24, 2023
Merged
@samuelsycamore @siriwatknp
Update docs/data/joy/components/checkbox/checkbox.md
5c19646 
Co-authored-by: Siriwat K <siriwatkunaporn@gmail.com>
Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
@samuelsycamore samuelsycamore merged commit ea679a4 into mui:master Jan 25, 2023
@samuelsycamore samuelsycamore deleted the joy-checkbox branch April 3, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@siriwatknp siriwatknp siriwatknp approved these changes

@danilo-leal danilo-leal Awaiting requested review from danilo-leal

Assignees
No one assigned
Labels
component: checkbox This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@samuelsycamore @mui-bot @siriwatknp