chore: add vxe-table export example

[gee1k]

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

  • Introduced the VxeUpload component to enhance file upload capabilities within the VxeUI component library.
  • Added an export option in the grid toolbar, allowing users to easily export data from the grid.

• Improvements

  • Enhanced grid configuration with a new exportConfig property for better data management.

[changeset-bot]

⚠️ No Changeset found

Latest commit: d278d24

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

The changes in this pull request introduce the VxeUpload component to the VxeUI library by modifying the init.ts file to include this new import and registration. Additionally, the remote.vue file is updated to enhance grid functionality by adding an exportConfig property and enabling export options in the toolbar. These modifications improve the overall capabilities of the VxeUI component library without altering existing logic or structures.

Changes

File Path	Change Summary
packages/effects/plugins/src/vxe-table/init.ts	Added import and registration of VxeUpload component.
playground/src/views/examples/vxe-table/remote.vue	Added exportConfig property to gridOptions and enabled export functionality in toolbarConfig.

Possibly related PRs

• feat: add vxe-table component #4563: Introduces the vxe-table component, enhancing the VxeUI library functionality with VxeUpload.
• fix: the vxeUI global configuration does not take effect #4574: Modifies the use-vxe-grid.vue component to enhance grid configuration, relevant to VxeUI components.
• fix(@vben/plugins/vxe-table): after resetting the search, the parameters still exist #4577: Improves form handling within the grid component, potentially relevant to the VxeUpload integration.
• feat: useVxeTable returns formApi instance #4582: Enhances useVbenVxeGrid functionality by providing a formApi instance, relevant to component interactions in VxeUI.

Suggested labels

feature

Suggested reviewers

• vince292007
• anncwb

Poem

In the garden where components bloom,
A new upload joins the room.
With grids that now can export too,
Our VxeUI grows, fresh and new!
Hops of joy, let's celebrate,
With every change, we elevate! 🐰✨

---

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

[gee1k]

vxe-table 导出功能依赖 VxeUI.saveFile 工具函数来下载文件，此工具函数在 VxeUpload 组件中才会挂载。所以必须导入 VxeUpload

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)

packages/effects/plugins/src/vxe-table/init.ts (1)

96-96: Component registration looks correct but may be unnecessary.

The registration follows the established pattern, but if VxeUpload isn't required for export functionality, we should remove both the import and this registration to keep the bundle size optimal.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e600d78 and d278d24.

📒 Files selected for processing (2)

• packages/effects/plugins/src/vxe-table/init.ts (2 hunks)
• playground/src/views/examples/vxe-table/remote.vue (2 hunks)

🔇 Additional comments (1)

playground/src/views/examples/vxe-table/remote.vue (1)

49-49: Verify export performance with large datasets.

The export functionality has been enabled in the toolbar. Since this is a remote data grid, consider the performance implications when exporting large datasets.

Consider implementing these improvements:

1. Add a loading indicator during export
2. Implement pagination or chunking for large exports
3. Add server-side export handling for very large datasets

Example implementation for loading state:

   toolbarConfig: {
     custom: true,
-    export: true,
+    export: {
+      showLoading: true,
+      message: 'Exporting data...'
+    },
     refresh: true,
     zoom: true,
   },