Skip to content

fix: 使用useVbenVxeGrid配置hasEmptyText、hasEmptyRender不生效的问题 #6310

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
Jun 2, 2025

Conversation

wyc001122
Copy link
Contributor

@wyc001122 wyc001122 commented May 30, 2025

Description

在使用 useVbenVxeGrid 时,当配置了 emptyTextemptyRender 属性时,这些原生的 VXE Table 空状态配置不会生效,而是始终显示默认的空状态组件。

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 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
    • Improved empty state handling in tables: the default empty message is now only shown when no custom empty state is configured.

Copy link

changeset-bot bot commented May 30, 2025

⚠️ No Changeset found

Latest commit: 627dd23

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 May 30, 2025

Walkthrough

A computed property named showDefaultEmpty was introduced in the VxeGrid component to control the rendering of the default empty state. The template logic was updated to conditionally display the default empty content based on this property, depending on whether custom empty options are set in the grid configuration.

Changes

File(s) Change Summary
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue Added showDefaultEmpty computed property and updated template to conditionally render default empty content.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VxeGrid
    participant GridOptions

    User->>VxeGrid: Render component
    VxeGrid->>GridOptions: Check emptyText/emptyRender
    VxeGrid->>VxeGrid: Compute showDefaultEmpty
    alt showDefaultEmpty is true
        VxeGrid->>User: Render default empty state
    else showDefaultEmpty is false
        VxeGrid->>User: Do not render default empty state
    end
Loading

Suggested reviewers

  • mynetfan
  • anncwb
  • jinmao88
  • vince292007

Poem

A grid with options, so clever and neat,
Decides when its empty state should greet.
If custom text or render is found,
The default stays quietly underground.
But when all is clear and nothing is set,
The default empty message is what you get!
🐇✨


📜 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 96a10ca and 627dd23.

📒 Files selected for processing (1)
  • packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Check (ubuntu-latest)
  • GitHub Check: Lint (ubuntu-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)
🔇 Additional comments (2)
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (2)

281-288: Well-implemented fix for the empty state configuration issue.

The computed property correctly identifies when native VXE Table empty state configurations are present and prevents the default empty state from overriding them. The logic handles edge cases appropriately (empty strings and null values are treated as "configured").


471-471: Effective template integration of the empty state logic.

The conditional rendering using v-if="showDefaultEmpty" cleanly integrates with the existing slot system. This ensures that native VXE Table empty state configurations take precedence while maintaining the ability for users to override the empty slot when needed.


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.

@jinmao88 jinmao88 merged commit 470fd43 into vbenjs:main Jun 2, 2025
14 checks passed
baohaojie123 added a commit to baohaojie123/vue-vben-admin that referenced this pull request Jun 4, 2025
…into web

* 'main' of https://github.com/baohaojie123/vue-vben-admin:
  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)

# Conflicts:
#	docs/src/en/guide/in-depth/access.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants