fix: the vxeUI global configuration does not take effect

[anncwb]

Description

fixed #4572

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 grid configuration by integrating global settings from VxeUI.
  • Improved initialization process for grid options, providing better flexibility.

• Bug Fixes

  • Added warning messages for unsupported form configurations, guiding users to use the formOptions prop instead.

• Documentation

  • Updated context for properties and method signatures to reflect new configuration logic.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4172507

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 pull request modifies the use-vxe-grid.vue component to enhance grid configuration and initialization logic. It introduces a new variable, globalGridConfig, to merge global settings from VxeUI into grid options. The init function is updated to access form configurations differently, and a warning is added regarding unsupported formConfig. The computed properties remain mostly unchanged but now include global configuration logic and additional checks for pagination and form options.

Changes

File Path	Change Summary
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue	- Introduced globalGridConfig for global grid configurations. - Updated init function to use gridOptions.value?.formConfig. - Added warning for unsupported formConfig. - Enhanced options computed property with global settings and additional checks.

Assessment against linked issues

Objective	Addressed	Explanation
Fix global settings not taking effect (#4572)	✅

Possibly related PRs

• fix: improve the layout of tables offline on the mobile #4573: This PR addresses layout issues related to tables on mobile devices, which aligns with the changes in the main PR that enhance the configuration and initialization logic for the grid, potentially affecting how tables are displayed.

Suggested reviewers

• vince292007

Poem

🐰 In the grid where options play,
Global settings come to stay.
With a wink and a hop,
Form configs won't flop,
Enhancing the way we display! 🌟

---

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.

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (2)

packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (2)

211-213: Consider refactoring the globalGridConfig retrieval to avoid duplication

The globalGridConfig is retrieved in both the options computed property and the init function. To enhance maintainability and reduce code duplication, consider moving this logic into a shared computed property or a helper function.

Suggestion:

Define a computed property for globalGridConfig:

const globalGridConfig = computed(() => VxeUI?.getConfig()?.grid ?? {});

Then, update references:

• In the options computed property, replace const globalGridConfig = VxeUI?.getConfig()?.grid ?? {}; with const globalConfig = globalGridConfig.value;.

• In the init function, use const globalConfig = globalGridConfig.value;.

---

211-213: Improve deprecation warning for formConfig

The current warning message informs users that formConfig is not supported and suggests using formOptions instead. To provide clearer guidance, consider using a standardized deprecation utility or formatting the message to include migration steps.

Suggestion:

Use a helper function for warnings:

function warnDeprecated(optionName: string, alternative: string) {
  console.warn(
    `[Vben Vxe Table]: The "${optionName}" is deprecated. Please use "${alternative}" instead.`
  );
}

if (formConfig) {
  warnDeprecated('formConfig', 'formOptions');
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 47d162e and 4172507.

📒 Files selected for processing (1)

• packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (3 hunks)