perf: improve autoSelect of ApiComponent

[ming4762]

1、修复autoSelect指定了valueField不生效的问题，props.valueField已经被omit了
2、autoSelect支持使用函数，可以满足灵活性要求更高的场景

Description

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

  • Extended the auto-selection functionality for a component by allowing custom selection logic through a new function option, while retaining the original string-based selection methods.

• Documentation

  • Updated the API documentation to reflect the enhanced auto-selection capabilities, including guidance on using the new custom selection function.

[coderabbitai]

Walkthrough

The changes update the autoSelect property for the ApiComponent in both the documentation and the Vue component source code. The property now accepts a function signature in addition to the predefined string options and false. The documentation is revised to reflect the updated type and behavior, and the component’s logic in the emitChange function is modified to invoke the provided function when applicable for custom option selection.

Changes

File(s)	Change Summary
docs/src/components/common-ui/vben-api-component.md	Updated documentation for the autoSelect property. The type definition changed from `'first'
packages/effects/common-ui/src/components/api-component/api-component.vue	Updated the autoSelect property in the Props interface to include a function signature. Modified the emitChange function to call the custom function when provided, and updated the assignment of modelValue accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Component as ApiComponent
    participant Logic as emitChange
    participant OptionFunc as Custom Function

    Component->>Logic: Trigger change event
    alt autoSelect is a function
        Logic->>OptionFunc: Call custom function with options
        OptionFunc-->>Logic: Return selected option
    else autoSelect is a predefined string
        Logic->>Logic: Execute switch-case logic to select option
    end
    Logic->>Component: Update modelValue with selected option's value

Loading

Poem

In a garden of code, I happily hop,
New logic blooms at every stop,
A function now guides my little path,
Selecting options with a custom math,
Coding carrots, delightful and bright—
Hop on, dear devs, into the new light! 🥕🐇

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a8c4786 and c9230a2.

📒 Files selected for processing (2)

• docs/src/components/common-ui/vben-api-component.md (2 hunks)
• packages/effects/common-ui/src/components/api-component/api-component.vue (2 hunks)

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

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

🔇 Additional comments (5)

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

154-154: Type definition correctly updated to include function support

The type definition for autoSelect has been updated to include a function option that allows custom selection logic. This enhancement provides more flexibility for users who need more complex selection behaviors.

---

163-163: Good documentation for the new function option

The description clearly explains how the function parameter works - it receives the options array and should return the selected option. This helps users understand how to implement their custom selection logic.

packages/effects/common-ui/src/components/api-component/api-component.vue (3)

62-63: JSDoc updated appropriately for the new function option

The documentation comment clearly explains the behavior of the new function option for autoSelect, maintaining consistency with the documentation file.

---

65-70: Type definition correctly implemented

The updated type definition for autoSelect properly includes the function signature, ensuring type safety when using the new option.

---

218-237: Function handling for autoSelect implemented correctly

The implementation correctly checks if autoSelect is a function using isFunction before calling it, and properly structures the conditional logic to handle both function and string-based options.