fix(custom-element): ensure exposed methods are accessible from custom elements by making them enumerable #13634

linzhe141 · 2025-07-15T01:44:58Z

Summary by CodeRabbit

Refactor
- Exposed component properties are now enumerable, improving their visibility and interaction.
Tests
- Added a test confirming that exposed methods in components correctly update the UI when invoked.

…nent

coderabbitai · 2025-07-15T01:45:04Z

Walkthrough

The change updates the applyOptions function to define exposed component properties with enumerable: true, making them iterable and accessible when exposed. No other logic or control flow was modified.

Changes

File(s)	Change Summary
packages/runtime-core/src/componentOptions.ts	Made exposed properties enumerable in `applyOptions` function
packages/runtime-dom/tests/customElement.spec.ts	Added test for exposing method via Options API in custom element

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Component
    participant ExposedObject

    User->>Component: Define expose option with methods
    Component->>ExposedObject: Define properties with enumerable: true
    User->>Component: Access method via custom element
    Component->>ExposedObject: Method is enumerable and accessible

Assessment against linked issues

Objective	Addressed	Explanation
Ensure exposed methods are accessible from custom elements by making them enumerable (#13632)	✅

Poem

🐇 With a twitch of my nose and a flick of my ear,
Exposed methods now sparkle and clearly appear!
Enumerable treasures for all to explore,
Custom elements shine and open the door.
A bunny’s delight, so simple and bright,
Making Vue’s magic just perfectly right! ✨🐰

Suggested labels

ready to merge

📜 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 e6a9956 and 11d9c28.

📒 Files selected for processing (1)

packages/runtime-dom/__tests__/customElement.spec.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/runtime-dom/tests/customElement.spec.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: test / e2e-test

✨ Finishing Touches

📝 Generate Docstrings

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

github-actions · 2025-07-15T01:46:00Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+14 B)	38.4 kB (+3 B)	34.5 kB (-25 B)
vue.global.prod.js	159 kB (+14 B)	58.5 kB (+3 B)	52.1 kB (-16 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.5 kB	18.2 kB	16.7 kB
createApp	54.5 kB (+14 B)	21.2 kB (+4 B)	19.4 kB (+14 B)
createSSRApp	58.7 kB (+14 B)	22.9 kB (+3 B)	20.9 kB (+7 B)
defineCustomElement	59.5 kB (+14 B)	22.8 kB (+1 B)	20.8 kB (-8 B)
overall	68.6 kB (+14 B)	26.4 kB (+4 B)	24 kB (-50 B)

pkg-pr-new · 2025-07-15T01:46:01Z

Open in StackBlitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@13634

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@13634

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@13634

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@13634

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@13634

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@13634

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@13634

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@13634

@vue/shared

npm i https://pkg.pr.new/@vue/shared@13634

vue

npm i https://pkg.pr.new/vue@13634

@vue/compat

npm i https://pkg.pr.new/@vue/compat@13634

commit: 11d9c28

edison1105 · 2025-07-15T07:51:58Z

LGTM.
Could you please add a test?

linzhe141 · 2025-07-15T08:17:20Z

LGTM. Could you please add a test?

Of course, I’ll add one right away.

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 69f3d5b and e6a9956.

📒 Files selected for processing (1)

packages/runtime-dom/__tests__/customElement.spec.ts (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: ci

packages/runtime-dom/__tests__/customElement.spec.ts

[error] 1-1: Vitest unit test failure: 'defineCustomElement > expose > expose attributes and callback' test failed with NotSupportedError: This name has already been registered in the registry.

packages/runtime-dom/__tests__/customElement.spec.ts

fix: properly handle expose in options API style custom element compo…

61179bc

…nent

chore: tweaks

69f3d5b

edison1105 added need test The PR has missing test cases. 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. scope: custom elements labels Jul 15, 2025

linzhe141 added 2 commits July 15, 2025 16:18

chore: update test case

e6a9956

chore: update

11d9c28

coderabbitai bot reviewed Jul 15, 2025

View reviewed changes

packages/runtime-dom/__tests__/customElement.spec.ts Outdated Show resolved Hide resolved

edison1105 added ready to merge The PR is ready to be merged. and removed need test The PR has missing test cases. labels Jul 16, 2025

edison1105 changed the title ~~fix: properly handle expose in options API style custom element component~~ fix(custom-element): ensure exposed methods are accessible from custom elements by making them enumerable Jul 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(custom-element): ensure exposed methods are accessible from custom elements by making them enumerable #13634

fix(custom-element): ensure exposed methods are accessible from custom elements by making them enumerable #13634

linzhe141 commented Jul 15, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 15, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Jul 15, 2025

Uh oh!

pkg-pr-new bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

edison1105 commented Jul 15, 2025 •

edited

Loading

Uh oh!

linzhe141 commented Jul 15, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(custom-element): ensure exposed methods are accessible from custom elements by making them enumerable #13634

Are you sure you want to change the base?

fix(custom-element): ensure exposed methods are accessible from custom elements by making them enumerable #13634

Conversation

linzhe141 commented Jul 15, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Suggested labels

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Jul 15, 2025

Size Report

Bundles

Usages

Uh oh!

pkg-pr-new bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edison1105 commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linzhe141 commented Jul 15, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

linzhe141 commented Jul 15, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Jul 15, 2025 •

edited

Loading

edison1105 commented Jul 15, 2025 •

edited

Loading