chore(docs): add missing onValueChange in CheckboxGroup #5332

wingkwong · 2025-05-30T11:23:59Z

Closes #5330

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

Documentation
- Updated the Checkbox Group component documentation to include the new onValueChange event handler, describing its usage and parameters.

linear · 2025-05-30T11:24:02Z

ENG-2545 [BUG] - CheckboxGroup documentation discrepancy

changeset-bot · 2025-05-30T11:24:03Z

⚠️ No Changeset found

Latest commit: bfbbca7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2025-05-30T11:24:04Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
heroui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 30, 2025 11:28am
heroui-sb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 30, 2025 11:28am

coderabbitai · 2025-05-30T11:24:06Z

Walkthrough

The documentation for the Checkbox Group component was updated to include a new event handler property, onValueChange, describing its purpose and usage. This addition aligns the documented API with the example code and clarifies available event handlers for the component.

Changes

File(s)	Change Summary
apps/docs/content/docs/components/checkbox-group.mdx	Added documentation for the `onValueChange` event handler property in the Checkbox Group API.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure CheckboxGroup documentation lists both `onChange` and `onValueChange` event handlers (#5330)	✅
Ensure documentation is internally consistent regarding event handler properties (#5330)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d40c744 and bfbbca7.

📒 Files selected for processing (1)

apps/docs/content/docs/components/checkbox-group.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

GitHub Check: TypeScript
GitHub Check: Continuous Release
GitHub Check: ESLint
GitHub Check: Tests
GitHub Check: Build

🔇 Additional comments (1)

apps/docs/content/docs/components/checkbox-group.mdx (1)

236-242: API table updated correctly
The new onValueChange event handler entry has been added to the Checkbox Group props table and aligns with the usage example above. Documentation now accurately reflects the component’s API.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-05-30T11:30:20Z

Open in StackBlitz

@heroui/accordion

npm i https://pkg.pr.new/@heroui/accordion@5332

@heroui/alert

npm i https://pkg.pr.new/@heroui/alert@5332

@heroui/autocomplete

npm i https://pkg.pr.new/@heroui/autocomplete@5332

@heroui/avatar

npm i https://pkg.pr.new/@heroui/avatar@5332

@heroui/badge

npm i https://pkg.pr.new/@heroui/badge@5332

@heroui/breadcrumbs

npm i https://pkg.pr.new/@heroui/breadcrumbs@5332

@heroui/button

npm i https://pkg.pr.new/@heroui/button@5332

@heroui/calendar

npm i https://pkg.pr.new/@heroui/calendar@5332

@heroui/card

npm i https://pkg.pr.new/@heroui/card@5332

@heroui/checkbox

npm i https://pkg.pr.new/@heroui/checkbox@5332

@heroui/chip

npm i https://pkg.pr.new/@heroui/chip@5332

@heroui/code

npm i https://pkg.pr.new/@heroui/code@5332

@heroui/date-input

npm i https://pkg.pr.new/@heroui/date-input@5332

@heroui/date-picker

npm i https://pkg.pr.new/@heroui/date-picker@5332

@heroui/divider

npm i https://pkg.pr.new/@heroui/divider@5332

@heroui/drawer

npm i https://pkg.pr.new/@heroui/drawer@5332

@heroui/dropdown

npm i https://pkg.pr.new/@heroui/dropdown@5332

@heroui/form

npm i https://pkg.pr.new/@heroui/form@5332

@heroui/image

npm i https://pkg.pr.new/@heroui/image@5332

@heroui/input

npm i https://pkg.pr.new/@heroui/input@5332

@heroui/input-otp

npm i https://pkg.pr.new/@heroui/input-otp@5332

@heroui/kbd

npm i https://pkg.pr.new/@heroui/kbd@5332

@heroui/link

npm i https://pkg.pr.new/@heroui/link@5332

@heroui/listbox

npm i https://pkg.pr.new/@heroui/listbox@5332

@heroui/menu

npm i https://pkg.pr.new/@heroui/menu@5332

@heroui/modal

npm i https://pkg.pr.new/@heroui/modal@5332

@heroui/navbar

npm i https://pkg.pr.new/@heroui/navbar@5332

@heroui/number-input

npm i https://pkg.pr.new/@heroui/number-input@5332

@heroui/pagination

npm i https://pkg.pr.new/@heroui/pagination@5332

@heroui/popover

npm i https://pkg.pr.new/@heroui/popover@5332

@heroui/progress

npm i https://pkg.pr.new/@heroui/progress@5332

@heroui/radio

npm i https://pkg.pr.new/@heroui/radio@5332

@heroui/ripple

npm i https://pkg.pr.new/@heroui/ripple@5332

@heroui/scroll-shadow

npm i https://pkg.pr.new/@heroui/scroll-shadow@5332

@heroui/select

npm i https://pkg.pr.new/@heroui/select@5332

@heroui/skeleton

npm i https://pkg.pr.new/@heroui/skeleton@5332

@heroui/slider

npm i https://pkg.pr.new/@heroui/slider@5332

@heroui/snippet

npm i https://pkg.pr.new/@heroui/snippet@5332

@heroui/spacer

npm i https://pkg.pr.new/@heroui/spacer@5332

@heroui/spinner

npm i https://pkg.pr.new/@heroui/spinner@5332

@heroui/switch

npm i https://pkg.pr.new/@heroui/switch@5332

@heroui/table

npm i https://pkg.pr.new/@heroui/table@5332

@heroui/tabs

npm i https://pkg.pr.new/@heroui/tabs@5332

@heroui/toast

npm i https://pkg.pr.new/@heroui/toast@5332

@heroui/tooltip

npm i https://pkg.pr.new/@heroui/tooltip@5332

@heroui/user

npm i https://pkg.pr.new/@heroui/user@5332

@heroui/react

npm i https://pkg.pr.new/@heroui/react@5332

@heroui/system

npm i https://pkg.pr.new/@heroui/system@5332

@heroui/system-rsc

npm i https://pkg.pr.new/@heroui/system-rsc@5332

@heroui/theme

npm i https://pkg.pr.new/@heroui/theme@5332

@heroui/use-aria-accordion

npm i https://pkg.pr.new/@heroui/use-aria-accordion@5332

@heroui/use-aria-accordion-item

npm i https://pkg.pr.new/@heroui/use-aria-accordion-item@5332

@heroui/use-aria-button

npm i https://pkg.pr.new/@heroui/use-aria-button@5332

@heroui/use-aria-link

npm i https://pkg.pr.new/@heroui/use-aria-link@5332

@heroui/use-aria-modal-overlay

npm i https://pkg.pr.new/@heroui/use-aria-modal-overlay@5332

@heroui/use-aria-multiselect

npm i https://pkg.pr.new/@heroui/use-aria-multiselect@5332

@heroui/use-callback-ref

npm i https://pkg.pr.new/@heroui/use-callback-ref@5332

@heroui/use-clipboard

npm i https://pkg.pr.new/@heroui/use-clipboard@5332

@heroui/use-data-scroll-overflow

npm i https://pkg.pr.new/@heroui/use-data-scroll-overflow@5332

@heroui/use-disclosure

npm i https://pkg.pr.new/@heroui/use-disclosure@5332

@heroui/use-draggable

npm i https://pkg.pr.new/@heroui/use-draggable@5332

@heroui/use-image

npm i https://pkg.pr.new/@heroui/use-image@5332

@heroui/use-infinite-scroll

npm i https://pkg.pr.new/@heroui/use-infinite-scroll@5332

@heroui/use-intersection-observer

npm i https://pkg.pr.new/@heroui/use-intersection-observer@5332

@heroui/use-is-mobile

npm i https://pkg.pr.new/@heroui/use-is-mobile@5332

@heroui/use-is-mounted

npm i https://pkg.pr.new/@heroui/use-is-mounted@5332

@heroui/use-measure

npm i https://pkg.pr.new/@heroui/use-measure@5332

@heroui/use-pagination

npm i https://pkg.pr.new/@heroui/use-pagination@5332

@heroui/use-real-shape

npm i https://pkg.pr.new/@heroui/use-real-shape@5332

@heroui/use-ref-state

npm i https://pkg.pr.new/@heroui/use-ref-state@5332

@heroui/use-resize

npm i https://pkg.pr.new/@heroui/use-resize@5332

@heroui/use-safe-layout-effect

npm i https://pkg.pr.new/@heroui/use-safe-layout-effect@5332

@heroui/use-scroll-position

npm i https://pkg.pr.new/@heroui/use-scroll-position@5332

@heroui/use-ssr

npm i https://pkg.pr.new/@heroui/use-ssr@5332

@heroui/use-theme

npm i https://pkg.pr.new/@heroui/use-theme@5332

@heroui/use-update-effect

npm i https://pkg.pr.new/@heroui/use-update-effect@5332

@heroui/aria-utils

npm i https://pkg.pr.new/@heroui/aria-utils@5332

@heroui/dom-animation

npm i https://pkg.pr.new/@heroui/dom-animation@5332

@heroui/framer-utils

npm i https://pkg.pr.new/@heroui/framer-utils@5332

@heroui/react-rsc-utils

npm i https://pkg.pr.new/@heroui/react-rsc-utils@5332

@heroui/react-utils

npm i https://pkg.pr.new/@heroui/react-utils@5332

@heroui/shared-icons

npm i https://pkg.pr.new/@heroui/shared-icons@5332

@heroui/shared-utils

npm i https://pkg.pr.new/@heroui/shared-utils@5332

@heroui/stories-utils

npm i https://pkg.pr.new/@heroui/stories-utils@5332

@heroui/test-utils

npm i https://pkg.pr.new/@heroui/test-utils@5332

commit: bfbbca7

* fix(date-picker): error state (#5317) * fix(date-range-picker): fixed the error state in preset * Update giant-sloths-shop.md * Removed if statement * chore(date-picker): prettier --------- Co-authored-by: WK Wong <[email protected]> * fix(theme): clear button in mobile (#5252) * fix(toast): fixed close button hover position * fix(input): fixed the clear button rendering on smaller devices * Delete .changeset/soft-spoons-march.md * Update input.ts * Undo unrelated toast changes * fix(toast): icons (#5246) * feat(shared-icons): add loading icon * fix(toast): icons * chore(toast): revise types for icons * chore(changeset): add changeset * refactor: migrate eslint to v9 (#5267) * refactor: migrate eslint to v9 * chore: lint * chore: update eslint command * chore: fix lint warnings * chore: separate lint and lint:fix * chore: exclude contentlayer generated code * fix(scripts): add missing await * fix(autocomplete): persist last selected item position (#5286) * refactor(select): remove unnecessary code * fix(autocomplete): persist last selected item position * chore(changeset): add changeset * chore(deps): bump framer-motion version (#5287) * chore(deps): bump framer-motion version * fix: typing issues * chore(changeset): add changeset --------- Co-authored-by: Junior Garcia <[email protected]> * chore(docs): supplement onAction & selectionBehavior (#5289) * fix(autocomplete): ensure focused item matches selected item after filter, selection (#5290) * fix(autocomplete): ensure focused item matches selected item after filter, selection * chore: apply type and default value * chore: add perpose coment in updated code * test: add focuskey management testcode * docs: add changeset * docs: update changeset * chore: remove comment * fix: broken components in stories (#5291) * chore(switch): remove xl size * chore(docs): remove xl size * chore(system-rsc): remove xl size * chore(circular-progress): remove xl size * chore: undo * chore(deps): bump RA versions (#5310) * chore(deps): ra version bump * chore(changeset): add changeset * fix(scripts): incorrect docs path --------- Co-authored-by: Junior Garcia <[email protected]> * chore(docs): update meta data (#5311) * docs(layout.tsx): added text-foreground (#5316) * feat(tabs): add click handling for tab items in tests and implementation (#3917) Co-authored-by: WK Wong <[email protected]> * fix issues in tabs examples (#2405) Co-authored-by: WK Wong <[email protected]> * chore(docs): add missing onValueChange in CheckboxGroup (#5332) * ci(changesets): version packages (#5323) Co-authored-by: Junior Garcia <[email protected]> --------- Co-authored-by: Vishv Salvi <[email protected]> Co-authored-by: WK Wong <[email protected]> Co-authored-by: KumJungMin <[email protected]> Co-authored-by: liaoyinglong <[email protected]> Co-authored-by: zhengjitf <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* chore: add herohack announcement * fix(date-picker): error state (#5317) * fix(date-range-picker): fixed the error state in preset * Update giant-sloths-shop.md * Removed if statement * chore(date-picker): prettier --------- Co-authored-by: WK Wong <[email protected]> * chore: banner replacement * fix(theme): clear button in mobile (#5252) * fix(toast): fixed close button hover position * fix(input): fixed the clear button rendering on smaller devices * Delete .changeset/soft-spoons-march.md * Update input.ts * Undo unrelated toast changes * fix(toast): icons (#5246) * feat(shared-icons): add loading icon * fix(toast): icons * chore(toast): revise types for icons * chore(changeset): add changeset * refactor: migrate eslint to v9 (#5267) * refactor: migrate eslint to v9 * chore: lint * chore: update eslint command * chore: fix lint warnings * chore: separate lint and lint:fix * chore: exclude contentlayer generated code * fix(scripts): add missing await * fix(autocomplete): persist last selected item position (#5286) * refactor(select): remove unnecessary code * fix(autocomplete): persist last selected item position * chore(changeset): add changeset * chore(deps): bump framer-motion version (#5287) * chore(deps): bump framer-motion version * fix: typing issues * chore(changeset): add changeset --------- Co-authored-by: Junior Garcia <[email protected]> * chore(docs): supplement onAction & selectionBehavior (#5289) * fix(autocomplete): ensure focused item matches selected item after filter, selection (#5290) * fix(autocomplete): ensure focused item matches selected item after filter, selection * chore: apply type and default value * chore: add perpose coment in updated code * test: add focuskey management testcode * docs: add changeset * docs: update changeset * chore: remove comment * fix: broken components in stories (#5291) * chore(switch): remove xl size * chore(docs): remove xl size * chore(system-rsc): remove xl size * chore(circular-progress): remove xl size * chore: undo * chore(deps): bump RA versions (#5310) * chore(deps): ra version bump * chore(changeset): add changeset * fix(scripts): incorrect docs path --------- Co-authored-by: Junior Garcia <[email protected]> * chore(docs): update meta data (#5311) * docs(layout.tsx): added text-foreground (#5316) * feat(tabs): add click handling for tab items in tests and implementation (#3917) Co-authored-by: WK Wong <[email protected]> * fix issues in tabs examples (#2405) Co-authored-by: WK Wong <[email protected]> * chore(docs): add missing onValueChange in CheckboxGroup (#5332) * ci(changesets): version packages (#5323) Co-authored-by: Junior Garcia <[email protected]> * chore: remove pre.json --------- Co-authored-by: Junior Garcia <[email protected]> Co-authored-by: Vishv Salvi <[email protected]> Co-authored-by: KumJungMin <[email protected]> Co-authored-by: liaoyinglong <[email protected]> Co-authored-by: zhengjitf <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

chore(docs): add missing onValueChange in CheckboxGroup

bfbbca7

wingkwong added this to the v2.7.9 milestone May 30, 2025

wingkwong assigned jrgarciadev May 30, 2025

wingkwong requested a review from jrgarciadev as a code owner May 30, 2025 11:24

vercel bot deployed to Preview – heroui-sb May 30, 2025 11:25 View deployment

vercel bot deployed to Preview – heroui May 30, 2025 11:28 View deployment

jrgarciadev approved these changes Jun 1, 2025

View reviewed changes

jrgarciadev merged commit 6e9247a into canary Jun 1, 2025
10 checks passed

jrgarciadev deleted the docs/eng-2545 branch June 1, 2025 17:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

chore(docs): add missing onValueChange in CheckboxGroup #5332

chore(docs): add missing onValueChange in CheckboxGroup #5332

Uh oh!

wingkwong commented May 30, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

linear bot commented May 30, 2025

Uh oh!

changeset-bot bot commented May 30, 2025

Uh oh!

vercel bot commented May 30, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 30, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

pkg-pr-new bot commented May 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chore(docs): add missing onValueChange in CheckboxGroup #5332

chore(docs): add missing onValueChange in CheckboxGroup #5332

Uh oh!

Conversation

wingkwong commented May 30, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

Uh oh!

linear bot commented May 30, 2025

Uh oh!

changeset-bot bot commented May 30, 2025

⚠️ No Changeset found

Uh oh!

vercel bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

pkg-pr-new bot commented May 30, 2025

Uh oh!

Uh oh!

Uh oh!

wingkwong commented May 30, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented May 30, 2025 •

edited

Loading

coderabbitai bot commented May 30, 2025 •

edited

Loading