feat: customizable table separator

[mynetfan]

Description

表格的分隔条支持定制背景色或完全移除

fixed: #5896

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 a configurable separator between the search form and the table, allowing you to disable it or customize its style (e.g., background color) starting with version >5.5.4.

• Documentation

  • Updated the documentation with examples and guidance on how to tailor the separator’s appearance to suit your needs.

[changeset-bot]

⚠️ No Changeset found

Latest commit: fa8500d

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

This update introduces a new customization option for the grid component to control the separator between the search form and the table body. A new section is added in the documentation that explains how to remove or style the separator. Internally, a new SeparatorOptions interface is defined and the grid properties are extended with a separator option. The Vue component logic is updated with computed properties that determine the separator’s visibility and background color based on the provided configuration.

Changes

Files	Change Summary
docs/src/components/common-ui/vben-vxe-table.md	Added a new "定制分隔条" section with code examples and updated the properties table to include the new separator property.
packages/effects/plugins/src/vxe-table/types.ts	Introduced a new SeparatorOptions interface and updated VxeGridProps to include an optional separator property (type: boolean|SeparatorOptions).
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue	Added computed properties isSeparator and separatorBg to conditionally render the separator based on the separator configuration from usePriorityValues.

Sequence Diagram(s)

sequenceDiagram
    participant Grid as GridComponent
    participant UGV as usePriorityValues
    participant ComputeSep as isSeparator Computed
    participant ComputeBg as separatorBg Computed
    participant Render as Template Render

    Grid->>UGV: Retrieve grid options (including `separator`)
    UGV-->>Grid: Returns configuration
    Grid->>ComputeSep: Evaluate `isSeparator` based on configuration
    ComputeSep-->>Grid: Returns visibility (true/false)
    Grid->>ComputeBg: Evaluate `separatorBg` for background color
    ComputeBg-->>Grid: Returns color value or undefined
    Grid->>Render: Render form with conditional separator styling

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Support background color customization (#5896)	✅

Poem

I’m a happy CodeRabbit on the hop,
Skipping through changes that never stop.
A custom separator now colors the grid’s display,
With a twirl of code, we brighten the day.
Hoppy coding as we nibble on innovation!
🐰✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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: 0

🧹 Nitpick comments (2)

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

80-92: Consider adding type guard for non-boolean separator objects.

The logic for isSeparator is correct but could be more robust by adding a type guard when accessing separator.value.show to ensure it's a valid object.

const isSeparator = computed(() => {
  if (
    !formOptions.value ||
    showSearchForm.value === false ||
    separator.value === false
  ) {
    return false;
  }
  if (separator.value === true || separator.value === undefined) {
    return true;
  }
-  return separator.value.show !== false;
+  return typeof separator.value === 'object' && separator.value !== null
+    ? separator.value.show !== false
+    : true;
});

---

93-99: Add type guard for the separator background color access.

Similar to the previous suggestion, add a type guard when accessing separator.value.backgroundColor to prevent potential runtime errors.

const separatorBg = computed(() => {
  return !separator.value ||
    isBoolean(separator.value) ||
-    !separator.value.backgroundColor
+    !(typeof separator.value === 'object' && separator.value !== null && separator.value.backgroundColor)
    ? undefined
    : separator.value.backgroundColor;
});

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ed26dca and fa8500d.

📒 Files selected for processing (3)

• docs/src/components/common-ui/vben-vxe-table.md (2 hunks)
• packages/effects/plugins/src/vxe-table/types.ts (2 hunks)
• packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: Test (windows-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: Lint (windows-latest)
• GitHub Check: post-update (ubuntu-latest)
• GitHub Check: post-update (windows-latest)

🔇 Additional comments (6)

packages/effects/plugins/src/vxe-table/types.ts (2)

34-37: Clean and well-structured interface definition.

The SeparatorOptions interface is well-defined with appropriate optional properties for controlling the visibility and appearance of the separator.

---

71-74: Good documentation for the new property.

The JSDoc comment clearly explains the purpose of the separator property, making it easy for developers to understand its function.

docs/src/components/common-ui/vben-vxe-table.md (2)

170-186: Thorough documentation with clear examples.

The new section "定制分隔条" (Custom Separator) provides:

1. A clear explanation of the default behavior and when customization might be needed
2. Code examples for different use cases (removing the separator or changing its color)
3. Comments in the code example to guide users through different options

This is excellent documentation that will help users understand and implement the feature correctly.

---

260-260: Property table updated correctly.

The properties table has been properly updated to include the new separator property with the correct type information and version requirement (>5.5.4).

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

404-415: Class conditional logic is well implemented.

The class binding for the form container correctly applies padding based on the isSeparator computed property and the form compactness state.

---

444-447: Dynamic styling for the separator is well implemented.

The separator's visibility is properly controlled by the isSeparator property, and its background color is dynamically set using the separatorBg computed property.