Skip to content

feat: vbenCheckButtonGroup support clear and maxCount - #6329

Merged
mynetfan merged 2 commits into
vbenjs:mainfrom
mynetfan:feat/check-button
Jun 3, 2025
Merged

mynetfan merged 2 commits into
vbenjs:mainfrom
mynetfan:feat/check-button

Conversation

@mynetfan

@mynetfan mynetfan commented Jun 3, 2025 •

Copy link
Copy Markdown
Collaborator

Description

  • 按钮组支持单选清除和多选限制最大选项数

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

    • Added option to allow clearing single selections in button groups.
    • Introduced a setting to limit the maximum number of selections in multi-select button groups.
    • Added controls in the UI for toggling the clearable option and setting the maximum selection count.
    • Enabled custom icon rendering in button groups with dynamic icon states.
  • Enhancements

    • Improved button group configuration with more options for appearance and selection behavior.

* 按钮组支持单选清除和多选限制最大选项数
@changeset-bot

changeset-bot Bot commented Jun 3, 2025 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: ca71921

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

coderabbitai Bot commented Jun 3, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

The changes introduce new properties and logic to the button group component, enabling optional clearing of single selections and limiting the number of selections in multi-select mode. UI controls and form schema updates are added to the playground for configuring these features, and the component's interface is extended to support the new options.

Changes

File(s) Change Summary
.../button/button.ts Extended VbenButtonGroupProps interface with allowClear, btnClass, maxCount, options, showIcon, size. Added comments and reordered properties.
.../button/check-button-group.vue Added allowClear and maxCount props with defaults. Modified click handler to support clearing and selection limits. Added named slot icon with slot props for custom icon rendering.
playground/src/views/examples/button-group/index.vue Added allowClear to reactive props. Updated form config with commonConfig, new fields for allowClear and maxCount, and logic to propagate changes. Added example showing custom icon slot usage with imported icons.

Poem

Buttons now clearer, with limits in tow,
A hop and a skip, new features to show!
Single or many, pick just what you need—
Clear with a flick, or limit your speed.
Rabbits rejoice as the UI grows bright,
Hopping through options, everything’s right!
🐇✨


📜 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 0918a15 and ca71921.

📒 Files selected for processing (2)
  • packages/@core/ui-kit/shadcn-ui/src/components/button/check-button-group.vue (3 hunks)
  • playground/src/views/examples/button-group/index.vue (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/@core/ui-kit/shadcn-ui/src/components/button/check-button-group.vue
  • playground/src/views/examples/button-group/index.vue
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)

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.

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ea776aa and 0918a15.

📒 Files selected for processing (3)
  • packages/@core/ui-kit/shadcn-ui/src/components/button/button.ts (1 hunks)
  • packages/@core/ui-kit/shadcn-ui/src/components/button/check-button-group.vue (2 hunks)
  • playground/src/views/examples/button-group/index.vue (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Check (ubuntu-latest)
  • GitHub Check: Lint (ubuntu-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (6)
packages/@core/ui-kit/shadcn-ui/src/components/button/button.ts (1)

32-53: LGTM! Well-structured interface extensions.

The new properties are properly typed and documented. The interface correctly extends the button group functionality with:

  • allowClear for single-selection clearing
  • maxCount for limiting multi-selection count
  • Additional styling and configuration options

The TypeScript types are appropriate and the structure maintains consistency with existing patterns.

packages/@core/ui-kit/shadcn-ui/src/components/button/check-button-group.vue (2)

22-24: LGTM! Proper default values for new props.

The default values are sensible:

  • allowClear: false maintains existing behavior by default
  • maxCount: 0 indicates no limit by default

94-103: LGTM! Correct allowClear implementation.

The single-selection clearing logic is well-implemented:

  • Properly checks if the clicked value is already selected
  • Clears the selection and sets model value to undefined
  • Emits the appropriate event with undefined value
  • Maintains existing behavior when allowClear is disabled
playground/src/views/examples/button-group/index.vue (3)

54-55: LGTM! Proper reactive property initialization.

The allowClear property is correctly added to the reactive compProps object with an appropriate default value.


67-69: LGTM! Consistent form configuration.

The commonConfig addition with labelWidth: 150 ensures consistent label formatting across the form controls.


116-129: LGTM! Comprehensive form controls for new features.

The form schema additions are well-structured:

  • allowClear: Appropriate Switch component with clear help text explaining single-selection clearing behavior
  • maxCount: Proper InputNumber component with helpful description of multi-selection limits

The help text clearly communicates the expected behavior to users, making the playground an effective demonstration tool.

@mynetfan
mynetfan merged commit 4102cc2 into vbenjs:main Jun 3, 2025
@mynetfan
mynetfan deleted the feat/check-button branch June 3, 2025 15:11
baohaojie123 added a commit to baohaojie123/vue-vben-admin that referenced this pull request Jun 4, 2025
* main:
  chore: release 5.5.7
  feat: improve vbenCheckButtonGroup (vbenjs#6329)
baohaojie123 added a commit to baohaojie123/vue-vben-admin that referenced this pull request Jun 11, 2025
* 'main' of https://github.com/baohaojie123/vue-vben-admin: (35 commits)
  chore: release 5.5.7
  feat: improve vbenCheckButtonGroup (vbenjs#6329)
  types: 扩展user-dropdown组件的menus类型,支持iconify (vbenjs#6283)
  fix: resolve onClosed method failure in connectedComponent of useVbenModal (vbenjs#6309)
  fix: 修复使用useVbenVxeGrid配置hasEmptyText、hasEmptyRender不生效的问题 (vbenjs#6310)
  fix:  When defaultHomePage is inconsistent with user.homePath, the pa… (vbenjs#6299)
  docs(settings): 完善'生产环境动态配置'步骤 (vbenjs#6297)
  fix: alert width fixed in small  screen (vbenjs#6312)
  style: fix lint error (vbenjs#6298)
  feat: support for hybrid permission access control mode (vbenjs#6294)
  fix: fix table-title slot not work (vbenjs#6295)
  fix: Update index.ts (vbenjs#6268)
  fix: reset slider-captcha after login failed (vbenjs#6275)
  fix: json-bigint parse used in vxeTable (vbenjs#6271)
  fix: repair the unexpected form default value (vbenjs#5567)
  feat: optimize logo display (vbenjs#6267)
  feat: improve check updates (vbenjs#6257)
  feat: enhances compatibility with APIs returning large numeric values (vbenjs#6250)
  fix: component Input is not registered when initialize page (vbenjs#6246)
  feat: ellipsis text automatically displays tooltip based on ellipsis (vbenjs#6244)
  ...

# Conflicts:
#	apps/web-naive/src/adapter/form.ts
#	apps/web-naive/src/bootstrap.ts
#	docs/src/components/common-ui/vben-ellipsis-text.md
#	docs/src/en/guide/in-depth/access.md
#	docs/src/guide/essentials/build.md
#	docs/src/guide/essentials/route.md
baohaojie123 added a commit to baohaojie123/vue-vben-admin that referenced this pull request Jun 11, 2025
* main:
  chore: release 5.5.7
  feat: improve vbenCheckButtonGroup (vbenjs#6329)

# Conflicts:
#	apps/web-naive/src/adapter/form.ts
#	apps/web-naive/src/bootstrap.ts
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant