feat: form compact mode support

[mynetfan]

Description

为表单新增一个“紧凑模式”属性compact，将其设为true时，表单会移除每一个子项目底部为显示校验错误信息所预留的空间。
该属性适用于不需要显示校验信息的场合（如用作表格的搜索表单）

close #5161

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 compact mode for forms, allowing for a more space-efficient layout.
  • Added new computed property isCompactForm to manage form display styles.

• Documentation

  • Updated documentation for the Vben Form component to include details on the new compact property and enhanced examples for dependencies and rules.

• Bug Fixes

  • Improved handling of reset actions to clear time fields correctly.

• Chores

  • Refined structure and organization of documentation for better clarity.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5b1e1cc

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]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/@core/ui-kit/form-ui/src/components/form-actions.vue

Oops! Something went wrong! :(

ESLint: 9.16.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

Walkthrough

The pull request introduces a new compact mode for form components across the Vben Admin framework. This feature allows developers to create more space-efficient form layouts, particularly useful for query forms. The changes span multiple files, adding a compact property to various interfaces and components, which controls the vertical spacing and validation message display. The implementation ensures that the compact mode can be toggled while maintaining the existing form functionality.

Changes

File	Change Summary
docs/src/components/common-ui/vben-form.md	Updated documentation to include compact property details and usage examples
packages/@core/ui-kit/form-ui/src/components/form-actions.vue	Added conditional padding based on compact property, enhanced reset handling
packages/@core/ui-kit/form-ui/src/form-render/form-field.vue	Introduced dynamic padding class selection using compact
packages/@core/ui-kit/form-ui/src/types.ts	Added optional compact property to FormRenderProps interface
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue	Implemented isCompactForm computed property and updated form handling

Assessment against linked issues

Objective	Addressed	Explanation
Add compact mode switch for query forms [#5161]	✅
Reduce vertical spacing in form layouts [#5161]	✅
Optional validation functionality [#5161]	❓	Compact mode doesn't directly disable validation

Suggested Labels

feature, ui-enhancement, form-component

Suggested Reviewers

• vince292007
• anncwb

Poem

🐰 A rabbit's tale of forms so neat,
Compact and tidy, a coding feat!
Spacing trimmed with magical grace,
No more layouts that feel out of place.
Efficiency hops, the code now sings! 🌟

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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: 0

🧹 Nitpick comments (1)

packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (1)

284-287: Consider refactoring class bindings for better readability

While the implementation is correct, the class bindings could be more concise using computed properties or the cn utility that's already imported.

Consider this refactor:

-      :class="{
-        'form-valid-error': isInValid,
-        'flex-col': isVertical,
-        'flex-row items-center': !isVertical,
-        'pb-6': !compact,
-        'pb-2': compact,
-      }"
-      class="flex"
+      :class="cn(
+        'flex',
+        {
+          'form-valid-error': isInValid,
+          'flex-col': isVertical,
+          'flex-row items-center': !isVertical,
+          'pb-6': !compact,
+          'pb-2': compact,
+        }
+      )"

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 181e387 and 5b1e1cc.

📒 Files selected for processing (5)

• docs/src/components/common-ui/vben-form.md (1 hunks)
• packages/@core/ui-kit/form-ui/src/components/form-actions.vue (1 hunks)
• packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (2 hunks)
• packages/@core/ui-kit/form-ui/src/types.ts (1 hunks)
• packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (3 hunks)

🔇 Additional comments (7)

packages/@core/ui-kit/form-ui/src/components/form-actions.vue (1)

141-145: LGTM! Padding adjustment for compact mode

The conditional padding adjustment aligns with the compact mode feature, providing appropriate spacing based on the form's mode.

packages/@core/ui-kit/form-ui/src/types.ts (1)

276-279: LGTM! Well-documented interface addition

The compact property is properly typed as optional and includes clear documentation explaining its purpose of removing validation message space.

packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (1)

58-58: LGTM! Clean constant declaration

The compact constant is properly derived from formRenderProps, making the code more maintainable.

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

Line range hint 71-81: LGTM: Form initialization with compact mode and state management.

The implementation correctly maintains form state by setting latest submission values after submit/reset actions. This ensures the grid has access to the most recent form data.

---

288-290: LGTM: Clean computed property implementation.

The isCompactForm computed property provides a clean way to access the form's compact state.

---

346-346: LGTM: Proper class binding for compact mode.

The template correctly uses conditional class binding to adjust padding based on the compact state.

docs/src/components/common-ui/vben-form.md (1)

360-366: LGTM: Well-documented compact mode property.

The documentation clearly explains:

• Purpose of the compact mode
• Default values in different contexts
• Important considerations regarding validation