fix: getFieldComponentRef will return actual ref within AsyncComponent

[mynetfan]

修复异步加载组件时，表单的getFieldComponentRef方法没能获取到正确的组件实例。
fixed: #6239

Summary by CodeRabbit

• Bug Fixes
  • Improved retrieval of form field component references to correctly handle asynchronous component wrappers, ensuring the actual component instance is accessed.
  • Enhanced stability by safely invoking the focus method only when it exists, preventing potential runtime errors.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5c18821

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 update the logic for retrieving field component references in the form API to correctly handle asynchronous component wrappers. Additionally, the usage of the focus method in an example is made safer by adding optional chaining to prevent runtime errors if the component or its method is undefined.

Changes

File(s)	Change Summary
packages/@core/ui-kit/form-ui/src/form-api.ts	Enhanced getFieldComponentRef to unwrap async component wrappers and return the actual component.
playground/src/views/examples/form/api.vue	Updated usage of focus with optional chaining to avoid errors if the reference or method is absent.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ExampleButton
    participant FormApi
    participant ComponentRefMap
    participant AsyncComponentWrapper
    participant ActualComponent

    User->>ExampleButton: Click "Focus Dropdown" button
    ExampleButton->>FormApi: getFieldComponentRef('fieldOptions')
    FormApi->>ComponentRefMap: Retrieve component ref
    alt Ref is AsyncComponentWrapper
        FormApi->>AsyncComponentWrapper: Unwrap $subTree.ref
        AsyncComponentWrapper->>ActualComponent: Return actual component instance
    else Ref is direct component
        ComponentRefMap->>FormApi: Return component instance
    end
    FormApi-->>ExampleButton: Return actual component instance
    ExampleButton->>ActualComponent: ?.focus?.()

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Fix focus action on dropdown in examples/form/api page (#6239)	✅

Poem

A rabbit hops with glee,
As async wrappers now set free!
Components unwrapped, focus restored,
No more errors to be ignored.
The dropdown listens, the button replies—
With every click, the focus flies!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 8ac9768 and 5c18821.

📒 Files selected for processing (2)

• packages/@core/ui-kit/form-ui/src/form-api.ts (2 hunks)
• playground/src/views/examples/form/api.vue (1 hunks)

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

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

🔇 Additional comments (3)

packages/@core/ui-kit/form-ui/src/form-api.ts (2)

14-14: Properly added dependency for the new implementation.

The import of isRef from 'vue' is necessary for the enhanced functionality in getFieldComponentRef.

---

100-123: Great fix to properly unwrap component instances from AsyncComponentWrapper!

This is a solid implementation that correctly handles the complex structure of asynchronously loaded components. The code now properly:

1. Detects when a component is wrapped in an AsyncComponentWrapper
2. Handles different ref structures (array or single ref)
3. Unwraps the actual component instance for proper usage

This fixes the issue mentioned in #6239 and ensures that consumers of the form API can reliably interact with async components.

playground/src/views/examples/form/api.vue (1)

137-137: Good defensive coding with optional chaining.

Adding optional chaining when calling the focus method prevents potential runtime errors if the component reference or its focus method is undefined. This change properly complements the fix in the getFieldComponentRef method and follows best practices for safe property access.

✨ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.