Skip to content

fix: vxeTable search button not working with slot #5678

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

Merged
merged 1 commit into from
Mar 7, 2025

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Mar 7, 2025

Description

修复为vxeTable扩展的搜索图标在使用toolbar-tools插槽时不再显示的问题;
修复搜索图标颜色与其它的默认工具按钮颜色不一致的问题

fix: #5673

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 grid's search functionality with a refreshed search icon.
    • Improved the search button behavior, offering a smoother toggle for the search form.
    • Added a customizable toolbar slot to better integrate search controls.

Copy link

changeset-bot bot commented Mar 7, 2025

⚠️ No Changeset found

Latest commit: 87c0a9b

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

Copy link
Contributor

coderabbitai bot commented Mar 7, 2025

Walkthrough

The pull request modifies the vxe-grid component in the Vue project by updating the search functionality. It imports a new VxeButton, updates the search button’s icon property, and adds a new method onSearchBtnClick to encapsulate toggling the search form via the API. The onToolbarToolClick function now delegates to onSearchBtnClick rather than calling the API method directly, and a new template slot (toolbar-tools) is introduced. Additionally, the computed property delegatedSlots is updated to exclude the TOOLBAR_TOOLS key.

Changes

File Change Summary
packages/.../use-vxe-grid.vue • Imported VxeButton from vxe-pc-ui
• Updated search button icon from 'vxe-icon--search' to 'vxe-icon-search'
• Added onSearchBtnClick method to handle search form toggling
• Updated onToolbarToolClick to call onSearchBtnClick
• Introduced new toolbar-tools slot
• Adjusted delegatedSlots computation

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant TB as Toolbar Component
    participant API as API
    U->>TB: Click Search Button
    TB->>TB: onToolbarToolClick()
    TB->>TB: onSearchBtnClick()
    TB->>API: toggleSearchForm()
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

Oh, I’m but a rabbit, hopping with glee,
Seeing code changes as lovely as can be.
A new button hops in with clicks so light,
Toggling searches in the moonlit night.
With Vxe magic and slots so clever,
My whiskers twitch — here's luck forever!
🐇✨


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (1)

356-367: Great implementation of the toolbar-tools slot.

This implementation properly addresses both issues mentioned in the PR:

  1. It ensures the search icon displays when using the toolbar-tools slot
  2. It maintains consistent styling with other tool buttons

The implementation also preserves any user-defined toolbar-tools content by including the slot before adding the search button.

Consider extracting the icon name 'vxe-icon-search' to a constant that can be shared between this implementation and the toolbarOptions computed property to avoid potential inconsistencies in the future:

+const SEARCH_ICON = 'vxe-icon-search';

// Then in toolbarOptions computed property:
  const searchBtn: VxeToolbarPropTypes.ToolConfig = {
    code: 'search',
-    icon: 'vxe-icon-search',
+    icon: SEARCH_ICON,
    circle: true,
    status: showSearchForm.value ? 'primary' : undefined,
    title: $t('common.search'),
  };

// And in the template:
        <VxeButton
-          icon="vxe-icon-search"
+          icon={SEARCH_ICON}
          circle
          class="ml-2"
          v-if="gridOptions?.toolbarConfig?.search && !!formOptions"
          :status="showSearchForm ? 'primary' : undefined"
          :title="$t('common.search')"
          @click="onSearchBtnClick"
        />
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b37ed48 and 87c0a9b.

📒 Files selected for processing (1)
  • packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Check (windows-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 (5)
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (5)

36-36: Good addition of the VxeButton import.

The import of VxeButton from 'vxe-pc-ui' is necessary to support the new implementation of the search button in the toolbar-tools slot.


118-118: Fixed icon name from 'vxe-icon--search' to 'vxe-icon-search'.

This change corrects the icon name to the proper format, which addresses the issue with the search icon not displaying properly.


204-204: Good refactoring to use the dedicated onSearchBtnClick method.

Extracting this functionality to a separate method improves code organization and maintainability.


211-213: Well-structured encapsulation of the search toggle functionality.

Creating a dedicated method for this action follows good software design principles and makes the code more maintainable.


225-230: Correctly excludes TOOLBAR_TOOLS from delegated slots.

This change is necessary to prevent conflicts with the custom implementation of the toolbar-tools slot.

@mynetfan mynetfan merged commit 89d963c into vbenjs:main Mar 7, 2025
14 checks passed
@mynetfan mynetfan deleted the fix/table-tools branch March 7, 2025 14:35
@github-actions github-actions bot locked and limited conversation to collaborators Apr 7, 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.

Bug: 当在toolbar-tools中添加了自定义按钮后,toolbarConfig中的search配置无法生效
1 participant