-
Notifications
You must be signed in to change notification settings - Fork 236
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
Docs: Add examples of indeterminate checkboxes #1300
Docs: Add examples of indeterminate checkboxes #1300
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis update introduces an "indeterminate" state for checkboxes, enriching the component with a third state beyond the traditional checked and unchecked. This new feature aligns with web standards and enhances user interface flexibility. Changes
Possibly related issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Actionable comments outside the diff hunks (2)
src/routes/docs/forms/checkbox.md (2)
Line range hint
58-58
: Consider adding a comma for clarity and using "of" instead of "about" for correct preposition usage.- If you need separate control over the label and the checkbox you can use the verbose syntax, but then you need to take care about aligning manually. + If you need separate control over the label and the checkbox, you can use the verbose syntax, but then you need to take care of aligning manually.
Line range hint
261-261
: Correct the typo "I can be used" to "It can be used".- I can be used as standalone element or be wrapped inside [ButtonGroup](/docs/components/button-group). + It can be used as a standalone element or be wrapped inside [ButtonGroup](/docs/components/button-group).
Review Status
Configuration used: CodeRabbit UI
Files selected for processing (1)
- src/routes/docs/forms/checkbox.md (3 hunks)
Additional comments not posted (1)
src/routes/docs/forms/checkbox.md (1)
Line range hint
105-105
: Avoid repetitive phrasing to enhance readability.Consider rephrasing to add variety to your writing. For example, "To add a secondary helper text for the checkbox component, follow this example."
@@ -27,7 +27,7 @@ The checkbox component can be used to receive one or more selected options from | |||
|
|||
## Checkbox examples | |||
|
|||
Use this default example of a checbkox element in a checked and unchecked state. | |||
Use this default example of a checbkox element in a checked, unchecked and indeterminate state. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct the spelling mistake in "checbkox" to "checkbox".
- Use this default example of a checbkox element in a checked, unchecked and indeterminate state.
+ Use this default example of a checkbox element in a checked, unchecked and indeterminate state.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Use this default example of a checbkox element in a checked, unchecked and indeterminate state. | |
Use this default example of a checkbox element in a checked, unchecked and indeterminate state. |
📑 Description
Add an example of how to make an indeterminate checkbox.
Backstory:
I was having problems with indeterminate checkboxes not looking like they should.
I started this branch to attempt to fix the problem, which would have started by displaying such checkboxes in the docs, so that I could fix the issue.
Upon digging deeper, I found out that the issue had already been fixed in flowbite (themesberg/flowbite#623) and that I was using a slightly older version.
There is still a small issue with them, but again, the fix should happen upstream on flowbite (themesberg/flowbite#851).
Keep this in consideration if you're going to go ahead with #951, as you may need to sync fixes between the 2 projects if they happen.
Status
✅ Checks
Additional Information
Summary by CodeRabbit