Skip to content

perf: improve component packaging to enable instance method retrieval #5795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 27, 2025

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Mar 27, 2025

Description

改进组件适配器中的Api系列组件包装,使得用作表单时能够调用组件暴露的方法。

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 component customization by allowing additional configuration properties to be applied when rendering UI elements like selectors, tree selectors, and icon pickers.
  • Refactor

    • Streamlined component definitions across multiple interfaces by consolidating placeholder and property handling into a single reusable approach, reducing redundancy and improving code maintainability.

@mynetfan mynetfan requested review from anncwb, vince292007, jinmao88 and a team as code owners March 27, 2025 06:56
Copy link

changeset-bot bot commented Mar 27, 2025

⚠️ No Changeset found

Latest commit: 90ed5f9

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

Copy link
Contributor

coderabbitai bot commented Mar 27, 2025

Walkthrough

This update introduces a new parameter componentProps to the withDefaultPlaceholder function across multiple component adapters. The function is now enhanced to spread additional properties into component props when called. Component definitions for ApiSelect, ApiTreeSelect, and IconPicker (along with additional components in one adapter) have been refactored to utilize this centralized wrapping function, simplifying the registration process and reducing code redundancy.

Changes

File(s) Change Summary
apps/web-antd/src/adapter/component/index.ts
apps/web-ele/src/adapter/component/index.ts
playground/src/adapter/component/index.ts
Updated withDefaultPlaceholder to include a new componentProps parameter (defaulting to an empty object). Refactored ApiSelect, ApiTreeSelect, and IconPicker to use this function, consolidating common placeholder and prop-spreading logic.
apps/web-naive/src/adapter/component/index.ts Updated withDefaultPlaceholder with the componentProps parameter. Refactored multiple components (ApiSelect, ApiTreeSelect, IconPicker, Input, InputNumber, Select, and TreeSelect) to use the new pattern, encapsulating additional props in their definitions.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Component Caller
    participant Wrapper as withDefaultPlaceholder
    participant Component as Wrapped Component

    Caller->>Wrapper: Call with component, type, and componentProps
    Wrapper->>Component: Merge componentProps with props and attrs
    Component-->>Caller: Render component with merged properties
Loading

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • anncwb
  • vince292007

Poem

I'm a little rabbit with code so neat,
Hopping through updates with happy feet.
New props spread wide with a joyful spark,
Components now shine like a glowing mark.
In the land of code, I skip with delight—
Enhancements in view, everything's just right!
🥕🐇


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 870cd86 and 90ed5f9.

📒 Files selected for processing (4)
  • apps/web-antd/src/adapter/component/index.ts (4 hunks)
  • apps/web-ele/src/adapter/component/index.ts (4 hunks)
  • apps/web-naive/src/adapter/component/index.ts (4 hunks)
  • playground/src/adapter/component/index.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)
🔇 Additional comments (20)
playground/src/adapter/component/index.ts (5)

44-44: Enhanced function flexibility with componentProps parameter.

The addition of componentProps parameter allows for passing additional properties to the wrapped component, which enables better customization when defining components.


67-71: Improved props spreading in the render function.

Good implementation of spreading the component props. The order ensures that:

  1. Default props from componentProps are applied first
  2. Placeholder is set (potentially overriding componentProps)
  3. Direct props and attrs take precedence
  4. The ref is correctly maintained

This order gives predictable behavior while maintaining flexibility.


111-116: Refactored ApiSelect to use withDefaultPlaceholder.

Great refactoring that reduces code duplication and leverages the centralized component wrapping logic. This approach makes the code more maintainable and allows for easier access to component instance methods.


117-124: Refactored ApiTreeSelect to use withDefaultPlaceholder.

Good refactoring that follows the same pattern as ApiSelect. The component-specific configuration is now cleanly passed through the componentProps parameter.


134-138: Refactored IconPicker to use withDefaultPlaceholder.

The refactoring of IconPicker follows the same pattern as the other components, providing a consistent approach to component definition throughout the file.

apps/web-ele/src/adapter/component/index.ts (5)

40-40: Enhanced function flexibility with componentProps parameter.

The addition of the componentProps parameter allows for passing additional properties to the wrapped component, consistent with the implementation in other adapter files.


63-67: Improved props spreading in the render function.

The implementation of props spreading follows the same pattern as in other adapter files, ensuring consistency across the codebase.


97-101: Refactored ApiSelect for ElementPlus.

Good implementation that adapts the component wrapping for ElementPlus's ElSelectV2 component while maintaining the same pattern used in other adapter files.


102-109: Refactored ApiTreeSelect for ElementPlus.

Appropriate configuration for ElementPlus's tree select component, adapting the pattern used in other files to match ElementPlus's API.


139-143: Refactored IconPicker for ElementPlus.

The implementation correctly adapts the IconPicker for ElementPlus, using the appropriate slot name ('append') and model property name.

apps/web-antd/src/adapter/component/index.ts (5)

44-44: Enhanced function flexibility with componentProps parameter.

Consistent implementation of the componentProps parameter as seen in the other adapter files.


67-71: Improved props spreading in the render function.

The implementation follows the same pattern as in other adapter files, maintaining consistency in how component props are applied.


110-115: Refactored ApiSelect for Ant Design Vue.

Appropriate configuration for Ant Design Vue's Select component, with specific event name 'onDropdownVisibleChange' for visibility changes.


116-123: Refactored ApiTreeSelect for Ant Design Vue.

Good adaptation for Ant Design Vue's TreeSelect with proper field name mappings and event handlers.


133-137: Refactored IconPicker for Ant Design Vue.

Correctly configured for Ant Design Vue, using 'addonAfter' slot and 'value' as the model prop name.

apps/web-naive/src/adapter/component/index.ts (5)

40-40: Enhanced function flexibility with componentProps parameter.

Consistent implementation of the componentProps parameter across all adapter files.


63-67: Improved props spreading in the render function.

Maintains the same pattern of props application as in other adapter files, ensuring consistent behavior.


98-101: Refactored ApiSelect for Naive UI.

Clean and minimal configuration for Naive UI's Select component with just the essential properties.


102-110: Refactored ApiTreeSelect for Naive UI.

Comprehensive configuration for Naive UI's TreeSelect with appropriate property mappings for this UI framework.


138-141: Refactored IconPicker for Naive UI.

Properly configured for Naive UI, using 'suffix' slot which aligns with Naive UI's design patterns.

✨ 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
🪧 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.

@mynetfan mynetfan merged commit a77bb8e into vbenjs:main Mar 27, 2025
14 checks passed
@mynetfan mynetfan deleted the perf/improve-component branch March 27, 2025 07:13
@github-actions github-actions bot locked and limited conversation to collaborators Apr 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant