Skip to content

fix(custom-element): component styles are not merged with 2nd argument styles #13792

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(custom-element): component styles are not merged with 2nd argument styles #13792

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
079bf14
fix(custom-element): component styles are not merged with 2nd argumen…
LeeSamFong Aug 21, 2025
d99c785
fix(custom-element): component styles are not merged with 2nd argumen…
LeeSamFong Aug 21, 2025
f79814c
fix(custom-element): from CodeRabbit suggested
LeeSamFong Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions packages/runtime-dom/__tests__/customElement.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -852,12 +852,13 @@ describe('defineCustomElement', () => {
return h('div', 'hello')
},
})
const Foo = defineCustomElement(def)
const Foo = defineCustomElement(def, {
extraStyles: [`div { color: green; }`],
})
customElements.define('my-el-with-styles', Foo)
container.innerHTML = `<my-el-with-styles></my-el-with-styles>`
const el = container.childNodes[0] as VueElement
const style = el.shadowRoot?.querySelector('style')!
expect(style.textContent).toBe(`div { color: red; }`)
assertStyles(el, [`div { color: red; }`, `div { color: green; }`])

// hmr
__VUE_HMR_RUNTIME__.reload('foo', {
Expand All @@ -866,7 +867,11 @@ describe('defineCustomElement', () => {
} as any)

await nextTick()
assertStyles(el, [`div { color: blue; }`, `div { color: yellow; }`])
assertStyles(el, [
`div { color: blue; }`,
`div { color: yellow; }`,
`div { color: green; }`,
])
})

test("child components should inject styles to root element's shadow root", async () => {
Expand Down
18 changes: 14 additions & 4 deletions packages/runtime-dom/src/apiCustomElement.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export type VueElementConstructor<P = {}> = {

export interface CustomElementOptions {
styles?: string[]
extraStyles?: string[]
shadowRoot?: boolean
nonce?: string
configureApp?: (app: App) => void
Expand Down Expand Up @@ -220,6 +221,10 @@ export class VueElement
* @internal
*/
_nonce: string | undefined = this._def.nonce
/**
* @internal
*/
_extraStyles?: string[] = this._def.extraStyles

/**
* @internal
Expand Down Expand Up @@ -391,7 +396,7 @@ export class VueElement
// apply CSS
if (this.shadowRoot) {
this._applyStyles(styles)
} else if (__DEV__ && styles) {
} else if (__DEV__ && (styles || this._extraStyles)) {
warn(
'Custom element style injection is not supported when using ' +
'shadowRoot: false',
Expand Down Expand Up @@ -586,18 +591,23 @@ export class VueElement
styles: string[] | undefined,
owner?: ConcreteComponent,
) {
if (!styles) return
const fullStyles: string[] = []
styles && fullStyles.push(...styles)
const { _extraStyles } = this
_extraStyles && fullStyles.push(..._extraStyles)
if (!fullStyles.length) return

if (owner) {
if (owner === this._def || this._styleChildren.has(owner)) {
return
}
this._styleChildren.add(owner)
}
const nonce = this._nonce
for (let i = styles.length - 1; i >= 0; i--) {
for (let i = fullStyles.length - 1; i >= 0; i--) {
const s = document.createElement('style')
if (nonce) s.setAttribute('nonce', nonce)
s.textContent = styles[i]
s.textContent = fullStyles[i]
this.shadowRoot!.prepend(s)
// record for HMR
if (__DEV__) {
Expand Down