docs: add form slots docs

[mynetfan]

Description

添加Form的Slots文档

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

• Documentation
  • Updated the Vben Form component documentation with a new "Slots" section for custom content insertion.
  • Clarified the renderComponentContent property in the FormSchema interface.
  • Improved overall document structure for better readability and accessibility.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1a9193f

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 updates the documentation for the Vben Form component, adding a new "Slots" section that explains the use of custom slots for inserting content in the form. It also clarifies the renderComponentContent property in the FormSchema interface with a new comment. The overall structure of the document has been improved for better readability, and minor text adjustments have been made for clarity and consistency.

Changes

File Path	Change Summary
docs/src/components/common-ui/vben-form.md	- Added a new "Slots" section detailing custom slot usage. - Updated comment for renderComponentContent in FormSchema interface. - Enhanced document structure for readability and made minor text adjustments.

Possibly related PRs

• feat: add form slot for action area #4621: This PR introduces new slots for the action area in form components, which aligns with the main PR's focus on enhancing the Vben Form component's documentation regarding the use of custom slots.

Suggested labels

documentation

Suggested reviewers

• vince292007
• anncwb

🐰 In the garden, I hop with glee,
New slots in forms, oh what a spree!
With clearer docs, we’ll guide the way,
Custom content brightens the day.
Let’s render joy, let’s make it right,
Vben Form shines, a true delight! 🌼

---

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: 0

🧹 Outside diff range and nitpick comments (2)

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

422-422: Consider adding English translation for consistency

The comment "自定义组件内部渲染" (Custom component internal rendering) should include an English translation to maintain consistency with the rest of the documentation's bilingual format.

-  /** 自定义组件内部渲染  */
+  /** 自定义组件内部渲染 (Custom component internal rendering) */

---

503-519: Enhance slots documentation with examples

The slots documentation is well-structured but could be more helpful with practical examples. Consider:

1. Adding usage examples for built-in slots
2. Including a code example demonstrating field name slots

Here's a suggested addition:

 | expand-after  | 展开按钮之后的位置 |

+### Examples
+
+```vue
+<!-- Using built-in slots -->
+<VbenForm>
+  <template #submit-before>
+    <Button>Custom Action</Button>
+  </template>
+</VbenForm>
+
+<!-- Using field name as slot -->
+<VbenForm :schema="[{ fieldName: 'customField', label: 'Custom' }]">
+  <template #customField>
+    <div>Custom Field Content</div>
+  </template>
+</VbenForm>
+```

 ::: tip 字段插槽

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e8992a1 and 1a9193f.

📒 Files selected for processing (1)

• docs/src/components/common-ui/vben-form.md (2 hunks)