feat: vben checkbox support indeterminate state and transition animation

[mynetfan]

Description

为checkbox组件添加半选状态和状态变更动画

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features
  • Enhanced the checkbox components to support an optional indeterminate state for partial selections.
  • Now displays a dynamic icon (switching between checked and indeterminate states) with smooth visual transitions.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 3a91a18

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

[coderabbitai]

Walkthrough

This pull request extends the checkbox components by adding support for an indeterminate state. In both the component and UI implementations, the props are updated to include an optional indeterminate boolean. Additionally, the UI component now conditionally renders the Minus icon (from lucide-vue-next) instead of the static Check component when the indeterminate state is active, and a minor class update adds a transition effect.

Changes

File(s)	Change Summary
packages/@core/ui-kit/.../checkbox/checkbox.vue packages/@core/ui-kit/.../checkbox/Checkbox.vue	Updated checkbox components to accept an optional indeterminate prop. In the first file, the prop type is extended; in the second file, the prop is added, the import now includes the Minus icon, and conditional rendering logic is implemented to display either Minus or Check based on the indeterminate state with an added class for transitions.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant C as CheckboxComponent
    participant I as Icon Renderer

    U->>C: Toggles checkbox
    alt Indeterminate is true
        C->>I: Request to render Minus icon
    else
        C->>I: Request to render Check icon
    end
    I-->>C: Renders icon with transition effect

Loading

Possibly related PRs

• fix: the failure of breadcrumb animation #4073: Introduces an indeterminate prop in the checkbox component similar to this change.
• fix: limit the drag range of tabs, fixed #4640 #4659: Also adds support for the indeterminate state in a checkbox, aligning with the modifications in this PR.

Suggested labels

enhancement

Suggested reviewers

• anncwb
• vince292007

Poem

I'm a curious rabbit, hopping through the code,
Adding indeterminate states, lightening the load.
With a "Minus" when unsure and a "Check" when it's set,
My transitions are smooth—a design you'll not forget.
🐇 Code hops along, playful yet precise,
Celebrating these changes in a bundle of delight!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3478964 and 3a91a18.

📒 Files selected for processing (2)

• packages/@core/ui-kit/shadcn-ui/src/components/checkbox/checkbox.vue (1 hunks)
• packages/@core/ui-kit/shadcn-ui/src/ui/checkbox/Checkbox.vue (3 hunks)

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

• GitHub Check: Test (windows-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: post-update (windows-latest)
• GitHub Check: Lint (windows-latest)
• GitHub Check: post-update (ubuntu-latest)
• GitHub Check: Check (ubuntu-latest)
• GitHub Check: Lint (ubuntu-latest)
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (5)

packages/@core/ui-kit/shadcn-ui/src/components/checkbox/checkbox.vue (1)

10-10: LGTM: Successfully implemented indeterminate state support.

The component now accepts an optional indeterminate boolean prop by extending the CheckboxRootProps interface, which correctly enables the indeterminate state functionality.

packages/@core/ui-kit/shadcn-ui/src/ui/checkbox/Checkbox.vue (4)

8-8: LGTM: Added Minus icon for indeterminate state.

Properly imported the Minus icon from lucide-vue-next to represent the indeterminate state visually.

---

15-17: LGTM: Extended props to support indeterminate state.

The props declaration now includes the optional indeterminate boolean property, maintaining consistency with the wrapper component.

---

34-34: LGTM: Added transition effect for state changes.

Added the transition class to enable smooth animations when the checkbox changes states, enhancing the user experience.

---

43-43: LGTM: Implemented conditional icon rendering.

The component now dynamically renders either the Minus icon (for indeterminate state) or the Check icon (for checked state) based on the indeterminate prop value, providing clear visual feedback to users.

---

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

• 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>, please review it.
  • Generate unit testing code 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 testing code 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 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 generate unit testing code.
  • @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.

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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

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.