fix(checkbox): incorrect onChange typing in Checkbox Group

[wingkwong]

Closes #2594

📝 Description

as titled

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes
  • Fixed an issue with incorrect onChange typing in Checkbox Group, ensuring it now correctly handles an array of strings as values.

[changeset-bot]

🦋 Changeset detected

Latest commit: 263953e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@nextui-org/checkbox	Patch
@nextui-org/table	Patch
@nextui-org/react	Patch

Not sure what this means? Click here to learn what changesets are.

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

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 27, 2024 3:04pm

[coderabbitai]

Walkthrough

The patch addresses a specific bug in the @nextui-org/checkbox package related to the incorrect typing of the onChange event in a CheckboxGroup. It modifies the Props interface to correctly type the onChange property, ensuring it accepts an array of strings, aligning with the expected behavior for handling checkbox group changes.

Changes

File	Change Summary
.changeset/heavy-berries-sniff.md	Introduces a patch for the @nextui-org/checkbox package to fix the onChange typing issue in Checkbox Group.
packages/components/checkbox/src/use-checkbox-group.ts	Modifies the Props interface to exclude onChange from HTMLNextUIProps<"div"> and adds an onChange property that takes an array of strings as values.

Assessment against linked issues

Objective	Addressed	Explanation
Fix onChange type in CheckboxGroup [#2594]	✅

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

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>.
  • Generate unit-tests for this file.
  • 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 generate unit tests for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[vercel]

@wingkwong is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between cf0d4e4 and 7a13a21.

Files selected for processing (2)

• .changeset/heavy-berries-sniff.md (1 hunks)
• packages/components/checkbox/src/use-checkbox-group.ts (2 hunks)

Additional comments: 2

.changeset/heavy-berries-sniff.md (1)

• 1-5: The changeset description is clear and accurately reflects the patch update for the "@nextui-org/checkbox" package. It succinctly describes the fix applied to the incorrect onChange typing in the Checkbox Group component.

packages/components/checkbox/src/use-checkbox-group.ts (1)

• 44-53: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [17-50]

The modification to the Props interface, specifically the exclusion of the onChange property from HTMLNextUIProps<"div"> and the addition of a new onChange property that accepts an array of strings, correctly addresses the typing issue described in the PR. This change ensures that the CheckboxGroup component's onChange event is now correctly typed, aligning with both the documentation and developer expectations.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 7a13a21 and 263953e.

Files selected for processing (1)

• packages/components/checkbox/src/use-checkbox-group.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• packages/components/checkbox/src/use-checkbox-group.ts