feat: add form field autofocus configuration

[Squall2017]

Description

添加表单form 控件聚焦配置

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 focus management for form fields, allowing automatic focus when specified.
  • Improved event handling for better interaction with input components.
  • Warning notifications for unregistered components in the form field.

• Bug Fixes

  • Resolved issues with event binding for components passing event objects.

[changeset-bot]

⚠️ No Changeset found

Latest commit: eca5e6d

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 enhance the form-field.vue component by introducing reactive features such as focus management and improved event handling. Key additions include a reference to the input element for programmatic focus, a watcher for the autofocus property, and robust event binding. Additionally, a warning is included for unregistered components, ensuring better usability and interactivity.

Changes

Files	Change Summary
packages/@core/ui-kit/form-ui/src/form-render/form-field.vue	- Added fieldComponentRef for input reference. - Introduced focus() function for managing input focus. - Implemented watcher for computedProps.value?.autofocus. - Updated fieldBindEvent for better event handling. - Enhanced fieldComponent to include registration warnings.

Possibly related PRs

• fix: the focus style and antd of the input box validation failure should be consistent #4446: This PR modifies the focus style of the input box in form-field.vue, which is directly related to the focus management enhancements introduced in the main PR.

Suggested labels

feature

Suggested reviewers

• vince292007
• anncwb

Poem

In fields of code, a rabbit hops,
With focus bright, no time for stops.
Events now dance, so smooth and neat,
Our form fields sing, a joyful feat!
With every click, they leap and play,
Enhancing forms in a splendid way! 🐇✨

---

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

🧹 Outside diff range and nitpick comments (2)

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

55-55: Consider using a more generic type for fieldComponentRef

Currently, fieldComponentRef is typed as ref<HTMLInputElement | null>(null). If the component being referenced is not always an HTMLInputElement, consider using a more generic type like HTMLElement to accommodate different component types.

Apply this diff to adjust the type:

-const fieldComponentRef = ref<HTMLInputElement | null>(null);
+const fieldComponentRef = ref<HTMLElement | null>(null);

---

60-60: Maintain consistent language in code comments

The comment on line 60 is in Chinese (// 检查当前是否有元素被聚焦). For consistency and readability, consider translating the comment to English.

Apply this diff to update the comment:

-    document.activeElement !== fieldComponentRef.value // 检查当前是否有元素被聚焦
+    document.activeElement !== fieldComponentRef.value // Check if the current element is focused

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b2c117f and eca5e6d.

📒 Files selected for processing (1)

• packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (4 hunks)

🔇 Additional comments (3)

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

6-6: Necessary imports are correctly added

The imports of ref, nextTick, and watch from 'vue' are appropriate for the added functionality.

---

56-64: Focus function implementation is correct

The focus function appropriately checks if fieldComponentRef exists, has a focus method, and is not already the active element before focusing. This ensures that focus is applied correctly without unnecessary refocusing.

---

169-179: Watch on autofocus property works as intended

The watch function correctly observes changes to computedProps.value?.autofocus and triggers the focus function when it becomes true, ensuring the component gains focus when needed. The use of nextTick and the immediate: true option is appropriate.