fix(custom-element): ensure correct order of nested component styles #13030

yangxiuxiu1115 · 2025-03-13T07:04:38Z

Summary by CodeRabbit

Bug Fixes
- Improved the order of injected styles for custom elements, ensuring child component styles appear before parent styles even with nested wrappers.
Tests
- Added a new test to verify that child component styles are correctly applied before parent styles within custom elements.

pkg-pr-new · 2025-03-13T07:15:57Z

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: b53b103

github-actions · 2025-03-13T07:19:01Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+79 B)	38.4 kB (+23 B)	34.5 kB (-24 B)
vue.global.prod.js	159 kB (+79 B)	58.5 kB (+22 B)	52.1 kB (+99 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB	18.2 kB	16.7 kB
createApp	54.5 kB	21.2 kB	19.4 kB
createSSRApp	58.8 kB	23 kB	20.9 kB
defineCustomElement	59.6 kB (+79 B)	22.8 kB (+25 B)	20.8 kB (+10 B)
overall	68.6 kB	26.4 kB	24.1 kB

edison1105 · 2025-03-13T13:53:46Z

/ecosystem-ci run

vue-bot · 2025-03-13T14:00:27Z

📝 Ran ecosystem CI: Open

suite	result	latest scheduled
language-tools	✅ success	✅ success
primevue	❌ failure	✅ success
router	✅ success	✅ success
radix-vue	✅ success	✅ success
quasar	✅ success	✅ success
test-utils	✅ success	✅ success
pinia	❌ failure	✅ success
nuxt	✅ success	✅ success
vite-plugin-vue	✅ success	✅ success
vue-simple-compiler	✅ success	✅ success
vue-macros	✅ success	✅ success
vant	✅ success	✅ success
vue-i18n	✅ success	✅ success
vuetify	✅ success	✅ success
vueuse	✅ success	✅ success
vitepress	✅ success	✅ success

packages/runtime-dom/src/apiCustomElement.ts

edison1105 · 2025-03-14T02:46:16Z

LGTM~

coderabbitai · 2025-05-21T07:10:41Z

"""

Walkthrough

The changes update the style injection mechanism for Vue custom elements to ensure that child component styles are injected before parent styles in the shadow DOM. This is achieved by tracking and reusing style elements per component using a WeakMap, and a new test verifies the correct style order in nested custom element scenarios.

Changes

File(s)	Change Summary
packages/runtime-dom/src/apiCustomElement.ts	Refactored the `_styleChildren` field in `VueElement` from a `WeakSet` to a `WeakMap`, updated `_applyStyles` logic to track and prepend child styles before parent styles, ensuring correct style order in the shadow DOM.
packages/runtime-dom/tests/customElement.spec.ts	Added a test case to verify that child component styles are injected before parent styles in custom elements.

Sequence Diagram(s)

sequenceDiagram
    participant ParentComponent
    participant WrapperComponent
    participant ChildComponent
    participant VueElement
    participant ShadowRoot

    ChildComponent->>VueElement: Mount with styles (green)
    VueElement->>ShadowRoot: Prepend child styles (green)
    WrapperComponent->>VueElement: Mount with styles (blue)
    VueElement->>ShadowRoot: Prepend wrapper styles (blue)
    ParentComponent->>VueElement: Mount with styles (red)
    VueElement->>ShadowRoot: Prepend parent styles (red)

Assessment against linked issues

Objective	Addressed	Explanation
Ensure child component styles are injected before parent styles in custom element shadow DOM (#13029)	✅
Add test coverage to verify style order in nested custom element scenarios (#13029)	✅

Poem

In the garden of shadow DOM,
Where colors once went wrong,
Now green before blue, before red,
Each style in its proper bed.
With order restored, the rabbit hops—
Hooray for styles that stack, not flop!
🐇✨
"""

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 a03dcca and b53b103.

📒 Files selected for processing (2)

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

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

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

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

edison1105 · 2025-05-23T02:58:02Z

packages/runtime-dom/src/apiCustomElement.ts

+      const existingStyles = this._styleChildren.get(owner)
+      if (existingStyles) {
+        // move existing styles to the top
+        this.shadowRoot!.prepend(...existingStyles)


The logic here is incorrect; the rendered style should not be moved to the very top but rather before the current parent component's style.

see

with this PR

Playground without customElement

插入顺序确实有点问题。我看到你已经提了新pr，先关闭这个pr

Because I'm not entirely sure if my implementation is correct, I didn't make changes directly to your PR but instead created a new one. If you're interested, you could help review it.

fix(custom-element): ensure correct order of nested component styles

07d28f8

edison1105 reviewed Mar 14, 2025

View reviewed changes

packages/runtime-dom/src/apiCustomElement.ts Outdated Show resolved Hide resolved

edison1105 added 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. scope: custom elements wait changes labels Mar 14, 2025

chore: update

c953666

edison1105 added ready to merge The PR is ready to be merged. and removed wait changes labels Mar 14, 2025

chore: tweaks

a03dcca

Merge branch 'main' into fix-customElement-styles

b53b103

edison1105 reviewed May 23, 2025

View reviewed changes

edison1105 removed the ready to merge The PR is ready to be merged. label May 23, 2025

yangxiuxiu1115 closed this May 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(custom-element): ensure correct order of nested component styles #13030

fix(custom-element): ensure correct order of nested component styles #13030

Uh oh!

yangxiuxiu1115 commented Mar 13, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

pkg-pr-new bot commented Mar 13, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 13, 2025 •

edited

Loading

Uh oh!

edison1105 commented Mar 13, 2025

Uh oh!

vue-bot commented Mar 13, 2025

Uh oh!

Uh oh!

edison1105 commented Mar 14, 2025

Uh oh!

coderabbitai bot commented May 21, 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!

edison1105 May 23, 2025 •

edited

Loading

Uh oh!

yangxiuxiu1115 May 23, 2025

Uh oh!

edison1105 May 23, 2025

Uh oh!

Uh oh!

Uh oh!

fix(custom-element): ensure correct order of nested component styles #13030

fix(custom-element): ensure correct order of nested component styles #13030

Uh oh!

Conversation

yangxiuxiu1115 commented Mar 13, 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!

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

Uh oh!

Uh oh!

github-actions bot commented Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report

Bundles

Usages

Uh oh!

edison1105 commented Mar 13, 2025

Uh oh!

vue-bot commented Mar 13, 2025

Uh oh!

Uh oh!

edison1105 commented Mar 14, 2025

Uh oh!

coderabbitai bot commented May 21, 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

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangxiuxiu1115 May 23, 2025

Choose a reason for hiding this comment

Uh oh!

edison1105 May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yangxiuxiu1115 commented Mar 13, 2025 •

edited by coderabbitai bot

Loading

pkg-pr-new bot commented Mar 13, 2025 •

edited

Loading

github-actions bot commented Mar 13, 2025 •

edited

Loading

coderabbitai bot commented May 21, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

edison1105 May 23, 2025 •

edited

Loading