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

1465 lines
43 KiB
TypeScript

import type { MockedFunction } from 'vitest'
import {
type HMRRuntime,
type Ref,
Teleport,
type VueElement,
createApp,
defineAsyncComponent,
defineComponent,
defineCustomElement,
h,
inject,
nextTick,
onMounted,
provide,
ref,
render,
renderSlot,
useHost,
useShadowRoot,
} from '../src'
declare var __VUE_HMR_RUNTIME__: HMRRuntime
describe('defineCustomElement', () => {
const container = document.createElement('div')
document.body.appendChild(container)
beforeEach(() => {
container.innerHTML = ''
})
describe('mounting/unmount', () => {
const E = defineCustomElement({
props: {
msg: {
type: String,
default: 'hello',
},
},
render() {
return h('div', this.msg)
},
})
customElements.define('my-element', E)
test('should work', () => {
container.innerHTML = `<my-element></my-element>`
const e = container.childNodes[0] as VueElement
expect(e).toBeInstanceOf(E)
expect(e._instance).toBeTruthy()
expect(e.shadowRoot!.innerHTML).toBe(`<div>hello</div>`)
})
test('should work w/ manual instantiation', () => {
const e = new E({ msg: 'inline' })
// should lazy init
expect(e._instance).toBe(null)
// should initialize on connect
container.appendChild(e)
expect(e._instance).toBeTruthy()
expect(e.shadowRoot!.innerHTML).toBe(`<div>inline</div>`)
})
test('should unmount on remove', async () => {
container.innerHTML = `<my-element></my-element>`
const e = container.childNodes[0] as VueElement
container.removeChild(e)
await nextTick()
expect(e._instance).toBe(null)
expect(e.shadowRoot!.innerHTML).toBe('')
})
// #10610
test('When elements move, avoid prematurely disconnecting MutationObserver', async () => {
const CustomInput = defineCustomElement({
props: ['value'],
emits: ['update'],
setup(props, { emit }) {
return () =>
h('input', {
type: 'number',
value: props.value,
onInput: (e: InputEvent) => {
const num = (e.target! as HTMLInputElement).valueAsNumber
emit('update', Number.isNaN(num) ? null : num)
},
})
},
})
customElements.define('my-el-input', CustomInput)
const num = ref('12')
const containerComp = defineComponent({
setup() {
return () => {
return h('div', [
h('my-el-input', {
value: num.value,
onUpdate: ($event: CustomEvent) => {
num.value = $event.detail[0]
},
}),
h('div', { id: 'move' }),
])
}
},
})
const app = createApp(containerComp)
const container = document.createElement('div')
document.body.appendChild(container)
app.mount(container)
const myInputEl = container.querySelector('my-el-input')!
const inputEl = myInputEl.shadowRoot!.querySelector('input')!
await nextTick()
expect(inputEl.value).toBe('12')
const moveEl = container.querySelector('#move')!
moveEl.append(myInputEl)
await nextTick()
myInputEl.removeAttribute('value')
await nextTick()
expect(inputEl.value).toBe('')
})
test('should not unmount on move', async () => {
container.innerHTML = `<div><my-element></my-element></div>`
const e = container.childNodes[0].childNodes[0] as VueElement
const i = e._instance
// moving from one parent to another - this will trigger both disconnect
// and connected callbacks synchronously
container.appendChild(e)
await nextTick()
// should be the same instance
expect(e._instance).toBe(i)
expect(e.shadowRoot!.innerHTML).toBe('<div>hello</div>')
})
test('remove then insert again', async () => {
container.innerHTML = `<my-element></my-element>`
const e = container.childNodes[0] as VueElement
container.removeChild(e)
await nextTick()
expect(e._instance).toBe(null)
expect(e.shadowRoot!.innerHTML).toBe('')
container.appendChild(e)
expect(e._instance).toBeTruthy()
expect(e.shadowRoot!.innerHTML).toBe('<div>hello</div>')
})
})
describe('props', () => {
const E = defineCustomElement({
props: {
foo: [String, null],
bar: Object,
bazQux: null,
value: null,
},
render() {
return [
h('div', null, this.foo || ''),
h('div', null, this.bazQux || (this.bar && this.bar.x)),
]
},
})
customElements.define('my-el-props', E)
test('renders custom element w/ correct object prop value', () => {
render(h('my-el-props', { value: { x: 1 } }), container)
const el = container.children[0]
expect((el as any).value).toEqual({ x: 1 })
})
test('props via attribute', async () => {
// bazQux should map to `baz-qux` attribute
container.innerHTML = `<my-el-props foo="hello" baz-qux="bye"></my-el-props>`
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe('<div>hello</div><div>bye</div>')
// change attr
e.setAttribute('foo', 'changed')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('<div>changed</div><div>bye</div>')
e.setAttribute('baz-qux', 'changed')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(
'<div>changed</div><div>changed</div>',
)
})
test('props via properties', async () => {
const e = new E()
e.foo = 'one'
e.bar = { x: 'two' }
container.appendChild(e)
expect(e.shadowRoot!.innerHTML).toBe('<div>one</div><div>two</div>')
// reflect
// should reflect primitive value
expect(e.getAttribute('foo')).toBe('one')
// should not reflect rich data
expect(e.hasAttribute('bar')).toBe(false)
e.foo = 'three'
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('<div>three</div><div>two</div>')
expect(e.getAttribute('foo')).toBe('three')
e.foo = null
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('<div></div><div>two</div>')
expect(e.hasAttribute('foo')).toBe(false)
e.foo = undefined
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('<div></div><div>two</div>')
expect(e.hasAttribute('foo')).toBe(false)
expect(e.foo).toBe(undefined)
e.bazQux = 'four'
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('<div></div><div>four</div>')
expect(e.getAttribute('baz-qux')).toBe('four')
})
test('props via hyphen property', async () => {
const Comp = defineCustomElement({
props: {
fooBar: Boolean,
},
render() {
return 'Comp'
},
})
customElements.define('my-el-comp', Comp)
render(h('my-el-comp', { 'foo-bar': true }), container)
const el = container.children[0]
expect((el as any).outerHTML).toBe('<my-el-comp foo-bar=""></my-el-comp>')
})
test('attribute -> prop type casting', async () => {
const E = defineCustomElement({
props: {
fooBar: Number, // test casting of camelCase prop names
bar: Boolean,
baz: String,
},
render() {
return [
this.fooBar,
typeof this.fooBar,
this.bar,
typeof this.bar,
this.baz,
typeof this.baz,
].join(' ')
},
})
customElements.define('my-el-props-cast', E)
container.innerHTML = `<my-el-props-cast foo-bar="1" baz="12345"></my-el-props-cast>`
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe(
`1 number false boolean 12345 string`,
)
e.setAttribute('bar', '')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(`1 number true boolean 12345 string`)
e.setAttribute('foo-bar', '2e1')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(
`20 number true boolean 12345 string`,
)
e.setAttribute('baz', '2e1')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(`20 number true boolean 2e1 string`)
})
// #4772
test('attr casting w/ programmatic creation', () => {
const E = defineCustomElement({
props: {
foo: Number,
},
render() {
return `foo type: ${typeof this.foo}`
},
})
customElements.define('my-element-programmatic', E)
const el = document.createElement('my-element-programmatic') as any
el.setAttribute('foo', '123')
container.appendChild(el)
expect(el.shadowRoot.innerHTML).toBe(`foo type: number`)
})
test('handling properties set before upgrading', () => {
const E = defineCustomElement({
props: {
foo: String,
dataAge: Number,
},
setup(props) {
expect(props.foo).toBe('hello')
expect(props.dataAge).toBe(5)
},
render() {
return h('div', `foo: ${this.foo}`)
},
})
const el = document.createElement('my-el-upgrade') as any
el.foo = 'hello'
el.dataset.age = 5
el.notProp = 1
container.appendChild(el)
customElements.define('my-el-upgrade', E)
expect(el.shadowRoot.firstChild.innerHTML).toBe(`foo: hello`)
// should not reflect if not declared as a prop
expect(el.hasAttribute('not-prop')).toBe(false)
})
test('handle properties set before connecting', () => {
const obj = { a: 1 }
const E = defineCustomElement({
props: {
foo: String,
post: Object,
},
setup(props) {
expect(props.foo).toBe('hello')
expect(props.post).toBe(obj)
},
render() {
return JSON.stringify(this.post)
},
})
customElements.define('my-el-preconnect', E)
const el = document.createElement('my-el-preconnect') as any
el.foo = 'hello'
el.post = obj
container.appendChild(el)
expect(el.shadowRoot.innerHTML).toBe(JSON.stringify(obj))
})
// https://github.com/vuejs/core/issues/6163
test('handle components with no props', async () => {
const E = defineCustomElement({
render() {
return h('div', 'foo')
},
})
customElements.define('my-element-noprops', E)
const el = document.createElement('my-element-noprops')
container.appendChild(el)
await nextTick()
expect(el.shadowRoot!.innerHTML).toMatchInlineSnapshot('"<div>foo</div>"')
})
// #5793
test('set number value in dom property', () => {
const E = defineCustomElement({
props: {
'max-age': Number,
},
render() {
// @ts-expect-error
return `max age: ${this.maxAge}/type: ${typeof this.maxAge}`
},
})
customElements.define('my-element-number-property', E)
const el = document.createElement('my-element-number-property') as any
container.appendChild(el)
el.maxAge = 50
expect(el.maxAge).toBe(50)
expect(el.shadowRoot.innerHTML).toBe('max age: 50/type: number')
})
// #9006
test('should reflect default value', () => {
const E = defineCustomElement({
props: {
value: {
type: String,
default: 'hi',
},
},
render() {
return this.value
},
})
customElements.define('my-el-default-val', E)
container.innerHTML = `<my-el-default-val></my-el-default-val>`
const e = container.childNodes[0] as any
expect(e.value).toBe('hi')
})
// #12214
test('Boolean prop with default true', async () => {
const E = defineCustomElement({
props: {
foo: {
type: Boolean,
default: true,
},
},
render() {
return String(this.foo)
},
})
customElements.define('my-el-default-true', E)
container.innerHTML = `<my-el-default-true></my-el-default-true>`
const e = container.childNodes[0] as HTMLElement & { foo: any },
shadowRoot = e.shadowRoot as ShadowRoot
expect(shadowRoot.innerHTML).toBe('true')
e.foo = undefined
await nextTick()
expect(shadowRoot.innerHTML).toBe('true')
e.foo = false
await nextTick()
expect(shadowRoot.innerHTML).toBe('false')
e.foo = null
await nextTick()
expect(shadowRoot.innerHTML).toBe('null')
e.foo = ''
await nextTick()
expect(shadowRoot.innerHTML).toBe('true')
})
test('support direct setup function syntax with extra options', () => {
const E = defineCustomElement(
props => {
return () => props.text
},
{
props: {
text: String,
},
},
)
customElements.define('my-el-setup-with-props', E)
container.innerHTML = `<my-el-setup-with-props text="hello"></my-el-setup-with-props>`
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe('hello')
})
})
describe('attrs', () => {
const E = defineCustomElement({
render() {
return [h('div', null, this.$attrs.foo as string)]
},
})
customElements.define('my-el-attrs', E)
test('attrs via attribute', async () => {
container.innerHTML = `<my-el-attrs foo="hello"></my-el-attrs>`
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe('<div>hello</div>')
e.setAttribute('foo', 'changed')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('<div>changed</div>')
})
test('non-declared properties should not show up in $attrs', () => {
const e = new E()
// @ts-expect-error
e.foo = '123'
container.appendChild(e)
expect(e.shadowRoot!.innerHTML).toBe('<div></div>')
})
// #12408
test('should set number tabindex as attribute', () => {
render(h('my-el-attrs', { tabindex: 1, 'data-test': true }), container)
const el = container.children[0] as HTMLElement
expect(el.getAttribute('tabindex')).toBe('1')
expect(el.getAttribute('data-test')).toBe('true')
})
})
describe('emits', () => {
const CompDef = defineComponent({
setup(_, { emit }) {
emit('created')
return () =>
h('div', {
onClick: () => {
emit('my-click', 1)
},
onMousedown: () => {
emit('myEvent', 1) // validate hyphenation
},
onWheel: () => {
emit('my-wheel', { bubbles: true }, 1)
},
})
},
})
const E = defineCustomElement(CompDef)
customElements.define('my-el-emits', E)
test('emit on connect', () => {
const e = new E()
const spy = vi.fn()
e.addEventListener('created', spy)
container.appendChild(e)
expect(spy).toHaveBeenCalled()
})
test('emit on interaction', () => {
container.innerHTML = `<my-el-emits></my-el-emits>`
const e = container.childNodes[0] as VueElement
const spy = vi.fn()
e.addEventListener('my-click', spy)
e.shadowRoot!.childNodes[0].dispatchEvent(new CustomEvent('click'))
expect(spy).toHaveBeenCalledTimes(1)
expect(spy.mock.calls[0][0]).toMatchObject({
detail: [1],
})
})
// #5373
test('case transform for camelCase event', () => {
container.innerHTML = `<my-el-emits></my-el-emits>`
const e = container.childNodes[0] as VueElement
const spy1 = vi.fn()
e.addEventListener('myEvent', spy1)
const spy2 = vi.fn()
// emitting myEvent, but listening for my-event. This happens when
// using the custom element in a Vue template
e.addEventListener('my-event', spy2)
e.shadowRoot!.childNodes[0].dispatchEvent(new CustomEvent('mousedown'))
expect(spy1).toHaveBeenCalledTimes(1)
expect(spy2).toHaveBeenCalledTimes(1)
})
test('emit from within async component wrapper', async () => {
const p = new Promise<typeof CompDef>(res => res(CompDef as any))
const E = defineCustomElement(defineAsyncComponent(() => p))
customElements.define('my-async-el-emits', E)
container.innerHTML = `<my-async-el-emits></my-async-el-emits>`
const e = container.childNodes[0] as VueElement
const spy = vi.fn()
e.addEventListener('my-click', spy)
// this feels brittle but seems necessary to reach the node in the DOM.
await customElements.whenDefined('my-async-el-emits')
await nextTick()
await nextTick()
e.shadowRoot!.childNodes[0].dispatchEvent(new CustomEvent('click'))
expect(spy).toHaveBeenCalled()
expect(spy.mock.calls[0][0]).toMatchObject({
detail: [1],
})
})
// #7293
test('emit in an async component wrapper with properties bound', async () => {
const E = defineCustomElement(
defineAsyncComponent(
() => new Promise<typeof CompDef>(res => res(CompDef as any)),
),
)
customElements.define('my-async-el-props-emits', E)
container.innerHTML = `<my-async-el-props-emits id="my_async_el_props_emits"></my-async-el-props-emits>`
const e = container.childNodes[0] as VueElement
const spy = vi.fn()
e.addEventListener('my-click', spy)
await customElements.whenDefined('my-async-el-props-emits')
await nextTick()
await nextTick()
e.shadowRoot!.childNodes[0].dispatchEvent(new CustomEvent('click'))
expect(spy).toHaveBeenCalled()
expect(spy.mock.calls[0][0]).toMatchObject({
detail: [1],
})
})
test('emit with options', async () => {
container.innerHTML = `<my-el-emits></my-el-emits>`
const e = container.childNodes[0] as VueElement
const spy = vi.fn()
e.addEventListener('my-wheel', spy)
e.shadowRoot!.childNodes[0].dispatchEvent(new CustomEvent('wheel'))
expect(spy).toHaveBeenCalledTimes(1)
expect(spy.mock.calls[0][0]).toMatchObject({
bubbles: true,
detail: [{ bubbles: true }, 1],
})
})
})
describe('slots', () => {
const E = defineCustomElement({
render() {
return [
h('div', null, [
renderSlot(this.$slots, 'default', undefined, () => [
h('div', 'fallback'),
]),
]),
h('div', null, renderSlot(this.$slots, 'named')),
]
},
})
customElements.define('my-el-slots', E)
test('render slots correctly', () => {
container.innerHTML = `<my-el-slots><span>hi</span></my-el-slots>`
const e = container.childNodes[0] as VueElement
// native slots allocation does not affect innerHTML, so we just
// verify that we've rendered the correct native slots here...
expect(e.shadowRoot!.innerHTML).toBe(
`<div><slot><div>fallback</div></slot></div><div><slot name="named"></slot></div>`,
)
})
})
describe('provide/inject', () => {
const Consumer = defineCustomElement({
setup() {
const foo = inject<Ref>('foo')!
return () => h('div', foo.value)
},
})
customElements.define('my-consumer', Consumer)
test('over nested usage', async () => {
const foo = ref('injected!')
const Provider = defineCustomElement({
provide: {
foo,
},
render() {
return h('my-consumer')
},
})
customElements.define('my-provider', Provider)
container.innerHTML = `<my-provider><my-provider>`
const provider = container.childNodes[0] as VueElement
const consumer = provider.shadowRoot!.childNodes[0] as VueElement
expect(consumer.shadowRoot!.innerHTML).toBe(`<div>injected!</div>`)
foo.value = 'changed!'
await nextTick()
expect(consumer.shadowRoot!.innerHTML).toBe(`<div>changed!</div>`)
})
test('over slot composition', async () => {
const foo = ref('injected!')
const Provider = defineCustomElement({
provide: {
foo,
},
render() {
return renderSlot(this.$slots, 'default')
},
})
customElements.define('my-provider-2', Provider)
container.innerHTML = `<my-provider-2><my-consumer></my-consumer><my-provider-2>`
const provider = container.childNodes[0]
const consumer = provider.childNodes[0] as VueElement
expect(consumer.shadowRoot!.innerHTML).toBe(`<div>injected!</div>`)
foo.value = 'changed!'
await nextTick()
expect(consumer.shadowRoot!.innerHTML).toBe(`<div>changed!</div>`)
})
test('inherited from ancestors', async () => {
const fooA = ref('FooA!')
const fooB = ref('FooB!')
const ProviderA = defineCustomElement({
provide: {
fooA,
},
render() {
return h('provider-b')
},
})
const ProviderB = defineCustomElement({
provide: {
fooB,
},
render() {
return h('my-multi-consumer')
},
})
const Consumer = defineCustomElement({
setup() {
const fooA = inject<Ref>('fooA')!
const fooB = inject<Ref>('fooB')!
return () => h('div', `${fooA.value} ${fooB.value}`)
},
})
customElements.define('provider-a', ProviderA)
customElements.define('provider-b', ProviderB)
customElements.define('my-multi-consumer', Consumer)
container.innerHTML = `<provider-a><provider-a>`
const providerA = container.childNodes[0] as VueElement
const providerB = providerA.shadowRoot!.childNodes[0] as VueElement
const consumer = providerB.shadowRoot!.childNodes[0] as VueElement
expect(consumer.shadowRoot!.innerHTML).toBe(`<div>FooA! FooB!</div>`)
fooA.value = 'changedA!'
fooB.value = 'changedB!'
await nextTick()
expect(consumer.shadowRoot!.innerHTML).toBe(
`<div>changedA! changedB!</div>`,
)
})
})
describe('styles', () => {
function assertStyles(el: VueElement, css: string[]) {
const styles = el.shadowRoot?.querySelectorAll('style')!
expect(styles.length).toBe(css.length) // should not duplicate multiple copies from Bar
for (let i = 0; i < css.length; i++) {
expect(styles[i].textContent).toBe(css[i])
}
}
test('should attach styles to shadow dom', async () => {
const def = defineComponent({
__hmrId: 'foo',
styles: [`div { color: red; }`],
render() {
return h('div', 'hello')
},
})
const Foo = defineCustomElement(def)
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; }`)
// hmr
__VUE_HMR_RUNTIME__.reload('foo', {
...def,
styles: [`div { color: blue; }`, `div { color: yellow; }`],
} as any)
await nextTick()
assertStyles(el, [`div { color: blue; }`, `div { color: yellow; }`])
})
test("child components should inject styles to root element's shadow root", async () => {
const Baz = () => h(Bar)
const Bar = defineComponent({
__hmrId: 'bar',
styles: [`div { color: green; }`, `div { color: blue; }`],
render() {
return 'bar'
},
})
const Foo = defineCustomElement({
styles: [`div { color: red; }`],
render() {
return [h(Baz), h(Baz)]
},
})
customElements.define('my-el-with-child-styles', Foo)
container.innerHTML = `<my-el-with-child-styles></my-el-with-child-styles>`
const el = container.childNodes[0] as VueElement
// inject order should be child -> parent
assertStyles(el, [
`div { color: green; }`,
`div { color: blue; }`,
`div { color: red; }`,
])
// hmr
__VUE_HMR_RUNTIME__.reload(Bar.__hmrId!, {
...Bar,
styles: [`div { color: red; }`, `div { color: yellow; }`],
} as any)
await nextTick()
assertStyles(el, [
`div { color: red; }`,
`div { color: yellow; }`,
`div { color: red; }`,
])
__VUE_HMR_RUNTIME__.reload(Bar.__hmrId!, {
...Bar,
styles: [`div { color: blue; }`],
} as any)
await nextTick()
assertStyles(el, [`div { color: blue; }`, `div { color: red; }`])
})
test('with nonce', () => {
const Foo = defineCustomElement(
{
styles: [`div { color: red; }`],
render() {
return h('div', 'hello')
},
},
{ nonce: 'xxx' },
)
customElements.define('my-el-with-nonce', Foo)
container.innerHTML = `<my-el-with-nonce></my-el-with-nonce>`
const el = container.childNodes[0] as VueElement
const style = el.shadowRoot?.querySelector('style')!
expect(style.getAttribute('nonce')).toBe('xxx')
})
})
describe('async', () => {
test('should work', async () => {
const loaderSpy = vi.fn()
const E = defineCustomElement(
defineAsyncComponent(() => {
loaderSpy()
return Promise.resolve({
props: ['msg'],
styles: [`div { color: red }`],
render(this: any) {
return h('div', null, this.msg)
},
})
}),
)
customElements.define('my-el-async', E)
container.innerHTML =
`<my-el-async msg="hello"></my-el-async>` +
`<my-el-async msg="world"></my-el-async>`
await new Promise(r => setTimeout(r))
// loader should be called only once
expect(loaderSpy).toHaveBeenCalledTimes(1)
const e1 = container.childNodes[0] as VueElement
const e2 = container.childNodes[1] as VueElement
// should inject styles
expect(e1.shadowRoot!.innerHTML).toBe(
`<style>div { color: red }</style><div>hello</div>`,
)
expect(e2.shadowRoot!.innerHTML).toBe(
`<style>div { color: red }</style><div>world</div>`,
)
// attr
e1.setAttribute('msg', 'attr')
await nextTick()
expect((e1 as any).msg).toBe('attr')
expect(e1.shadowRoot!.innerHTML).toBe(
`<style>div { color: red }</style><div>attr</div>`,
)
// props
expect(`msg` in e1).toBe(true)
;(e1 as any).msg = 'prop'
expect(e1.getAttribute('msg')).toBe('prop')
expect(e1.shadowRoot!.innerHTML).toBe(
`<style>div { color: red }</style><div>prop</div>`,
)
})
test('set DOM property before resolve', async () => {
const E = defineCustomElement(
defineAsyncComponent(() => {
return Promise.resolve({
props: ['msg'],
setup(props) {
expect(typeof props.msg).toBe('string')
},
render(this: any) {
return h('div', this.msg)
},
})
}),
)
customElements.define('my-el-async-2', E)
const e1 = new E()
// set property before connect
e1.msg = 'hello'
const e2 = new E()
container.appendChild(e1)
container.appendChild(e2)
// set property after connect but before resolve
e2.msg = 'world'
await new Promise(r => setTimeout(r))
expect(e1.shadowRoot!.innerHTML).toBe(`<div>hello</div>`)
expect(e2.shadowRoot!.innerHTML).toBe(`<div>world</div>`)
e1.msg = 'world'
expect(e1.shadowRoot!.innerHTML).toBe(`<div>world</div>`)
e2.msg = 'hello'
expect(e2.shadowRoot!.innerHTML).toBe(`<div>hello</div>`)
})
test('Number prop casting before resolve', async () => {
const E = defineCustomElement(
defineAsyncComponent(() => {
return Promise.resolve({
props: { n: Number },
setup(props) {
expect(props.n).toBe(20)
},
render(this: any) {
return h('div', this.n + ',' + typeof this.n)
},
})
}),
)
customElements.define('my-el-async-3', E)
container.innerHTML = `<my-el-async-3 n="2e1"></my-el-async-3>`
await new Promise(r => setTimeout(r))
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe(`<div>20,number</div>`)
})
test('with slots', async () => {
const E = defineCustomElement(
defineAsyncComponent(() => {
return Promise.resolve({
render(this: any) {
return [
h('div', null, [
renderSlot(this.$slots, 'default', undefined, () => [
h('div', 'fallback'),
]),
]),
h('div', null, renderSlot(this.$slots, 'named')),
]
},
})
}),
)
customElements.define('my-el-async-slots', E)
container.innerHTML = `<my-el-async-slots><span>hi</span></my-el-async-slots>`
await new Promise(r => setTimeout(r))
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe(
`<div><slot><div>fallback</div></slot></div><div><slot name="named"></slot></div>`,
)
})
})
describe('shadowRoot: false', () => {
const E = defineCustomElement({
shadowRoot: false,
props: {
msg: {
type: String,
default: 'hello',
},
},
render() {
return h('div', this.msg)
},
})
customElements.define('my-el-shadowroot-false', E)
test('should work', async () => {
function raf() {
return new Promise(resolve => {
requestAnimationFrame(resolve)
})
}
container.innerHTML = `<my-el-shadowroot-false></my-el-shadowroot-false>`
const e = container.childNodes[0] as VueElement
await raf()
expect(e).toBeInstanceOf(E)
expect(e._instance).toBeTruthy()
expect(e.innerHTML).toBe(`<div>hello</div>`)
expect(e.shadowRoot).toBe(null)
})
const toggle = ref(true)
const ES = defineCustomElement(
{
render() {
return [
renderSlot(this.$slots, 'default'),
toggle.value ? renderSlot(this.$slots, 'named') : null,
renderSlot(this.$slots, 'omitted', {}, () => [
h('div', 'fallback'),
]),
]
},
},
{ shadowRoot: false },
)
customElements.define('my-el-shadowroot-false-slots', ES)
test('should render slots', async () => {
container.innerHTML =
`<my-el-shadowroot-false-slots>` +
`<span>default</span>text` +
`<div slot="named">named</div>` +
`</my-el-shadowroot-false-slots>`
const e = container.childNodes[0] as VueElement
// native slots allocation does not affect innerHTML, so we just
// verify that we've rendered the correct native slots here...
expect(e.innerHTML).toBe(
`<span>default</span>text` +
`<div slot="named">named</div>` +
`<div>fallback</div>`,
)
toggle.value = false
await nextTick()
expect(e.innerHTML).toBe(
`<span>default</span>text` + `<!---->` + `<div>fallback</div>`,
)
})
test('render nested customElement w/ shadowRoot false', async () => {
const calls: string[] = []
const Child = defineCustomElement(
{
setup() {
calls.push('child rendering')
onMounted(() => {
calls.push('child mounted')
})
},
render() {
return renderSlot(this.$slots, 'default')
},
},
{ shadowRoot: false },
)
customElements.define('my-child', Child)
const Parent = defineCustomElement(
{
setup() {
calls.push('parent rendering')
onMounted(() => {
calls.push('parent mounted')
})
},
render() {
return renderSlot(this.$slots, 'default')
},
},
{ shadowRoot: false },
)
customElements.define('my-parent', Parent)
const App = {
render() {
return h('my-parent', null, {
default: () => [
h('my-child', null, {
default: () => [h('span', null, 'default')],
}),
],
})
},
}
const app = createApp(App)
app.mount(container)
await nextTick()
const e = container.childNodes[0] as VueElement
expect(e.innerHTML).toBe(
`<my-child data-v-app=""><span>default</span></my-child>`,
)
expect(calls).toEqual([
'parent rendering',
'parent mounted',
'child rendering',
'child mounted',
])
app.unmount()
})
test('render nested Teleport w/ shadowRoot false', async () => {
const target = document.createElement('div')
const Child = defineCustomElement(
{
render() {
return h(
Teleport,
{ to: target },
{
default: () => [renderSlot(this.$slots, 'default')],
},
)
},
},
{ shadowRoot: false },
)
customElements.define('my-el-teleport-child', Child)
const Parent = defineCustomElement(
{
render() {
return renderSlot(this.$slots, 'default')
},
},
{ shadowRoot: false },
)
customElements.define('my-el-teleport-parent', Parent)
const App = {
render() {
return h('my-el-teleport-parent', null, {
default: () => [
h('my-el-teleport-child', null, {
default: () => [h('span', null, 'default')],
}),
],
})
},
}
const app = createApp(App)
app.mount(container)
await nextTick()
expect(target.innerHTML).toBe(`<span>default</span>`)
app.unmount()
})
})
describe('helpers', () => {
test('useHost', () => {
const Foo = defineCustomElement({
setup() {
const host = useHost()!
host.setAttribute('id', 'host')
return () => h('div', 'hello')
},
})
customElements.define('my-el-use-host', Foo)
container.innerHTML = `<my-el-use-host>`
const el = container.childNodes[0] as VueElement
expect(el.id).toBe('host')
})
test('useShadowRoot for style injection', () => {
const Foo = defineCustomElement({
setup() {
const root = useShadowRoot()!
const style = document.createElement('style')
style.innerHTML = `div { color: red; }`
root.appendChild(style)
return () => h('div', 'hello')
},
})
customElements.define('my-el-use-shadow-root', Foo)
container.innerHTML = `<my-el-use-shadow-root>`
const el = container.childNodes[0] as VueElement
const style = el.shadowRoot?.querySelector('style')!
expect(style.textContent).toBe(`div { color: red; }`)
})
})
describe('expose', () => {
test('expose attributes and callback', async () => {
type SetValue = (value: string) => void
let fn: MockedFunction<SetValue>
const E = defineCustomElement({
setup(_, { expose }) {
const value = ref('hello')
const setValue = (fn = vi.fn((_value: string) => {
value.value = _value
}))
expose({
setValue,
value,
})
return () => h('div', null, [value.value])
},
})
customElements.define('my-el-expose', E)
container.innerHTML = `<my-el-expose></my-el-expose>`
const e = container.childNodes[0] as VueElement & {
value: string
setValue: MockedFunction<SetValue>
}
expect(e.shadowRoot!.innerHTML).toBe(`<div>hello</div>`)
expect(e.value).toBe('hello')
expect(e.setValue).toBe(fn!)
e.setValue('world')
expect(e.value).toBe('world')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(`<div>world</div>`)
})
test('warning when exposing an existing property', () => {
const E = defineCustomElement({
props: {
value: String,
},
setup(props, { expose }) {
expose({
value: 'hello',
})
return () => h('div', null, [props.value])
},
})
customElements.define('my-el-expose-two', E)
container.innerHTML = `<my-el-expose-two value="world"></my-el-expose-two>`
expect(
`[Vue warn]: Exposed property "value" already exists on custom element.`,
).toHaveBeenWarned()
})
})
test('async & nested custom elements', async () => {
let fooVal: string | undefined = ''
const E = defineCustomElement(
defineAsyncComponent(() => {
return Promise.resolve({
setup(props) {
provide('foo', 'foo')
},
render(this: any) {
return h('div', null, [renderSlot(this.$slots, 'default')])
},
})
}),
)
const EChild = defineCustomElement({
setup(props) {
fooVal = inject('foo')
},
render(this: any) {
return h('div', null, 'child')
},
})
customElements.define('my-el-async-nested-ce', E)
customElements.define('slotted-child', EChild)
container.innerHTML = `<my-el-async-nested-ce><div><slotted-child></slotted-child></div></my-el-async-nested-ce>`
await new Promise(r => setTimeout(r))
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe(`<div><slot></slot></div>`)
expect(fooVal).toBe('foo')
})
test('async & multiple levels of nested custom elements', async () => {
let fooVal: string | undefined = ''
let barVal: string | undefined = ''
const E = defineCustomElement(
defineAsyncComponent(() => {
return Promise.resolve({
setup(props) {
provide('foo', 'foo')
},
render(this: any) {
return h('div', null, [renderSlot(this.$slots, 'default')])
},
})
}),
)
const EChild = defineCustomElement({
setup(props) {
provide('bar', 'bar')
},
render(this: any) {
return h('div', null, [renderSlot(this.$slots, 'default')])
},
})
const EChild2 = defineCustomElement({
setup(props) {
fooVal = inject('foo')
barVal = inject('bar')
},
render(this: any) {
return h('div', null, 'child')
},
})
customElements.define('my-el-async-nested-m-ce', E)
customElements.define('slotted-child-m', EChild)
customElements.define('slotted-child2-m', EChild2)
container.innerHTML =
`<my-el-async-nested-m-ce>` +
`<div><slotted-child-m>` +
`<slotted-child2-m></slotted-child2-m>` +
`</slotted-child-m></div>` +
`</my-el-async-nested-m-ce>`
await new Promise(r => setTimeout(r))
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe(`<div><slot></slot></div>`)
expect(fooVal).toBe('foo')
expect(barVal).toBe('bar')
})
describe('configureApp', () => {
test('should work', () => {
const E = defineCustomElement(
() => {
const msg = inject('msg')
return () => h('div', msg!)
},
{
configureApp(app) {
app.provide('msg', 'app-injected')
},
},
)
customElements.define('my-element-with-app', E)
container.innerHTML = `<my-element-with-app></my-element-with-app>`
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot?.innerHTML).toBe('<div>app-injected</div>')
})
})
// #9885
test('avoid double mount when prop is set immediately after mount', () => {
customElements.define(
'my-input-dupe',
defineCustomElement({
props: {
value: String,
},
render() {
return 'hello'
},
}),
)
const container = document.createElement('div')
document.body.appendChild(container)
createApp({
render() {
return h('div', [
h('my-input-dupe', {
onVnodeMounted(vnode) {
vnode.el!.value = 'fesfes'
},
}),
])
},
}).mount(container)
expect(container.children[0].children[0].shadowRoot?.innerHTML).toBe(
'hello',
)
})
// #11081
test('Props can be casted when mounting custom elements in component rendering functions', async () => {
const E = defineCustomElement(
defineAsyncComponent(() =>
Promise.resolve({
props: ['fooValue'],
setup(props) {
expect(props.fooValue).toBe('fooValue')
return () => h('div', props.fooValue)
},
}),
),
)
customElements.define('my-el-async-4', E)
const R = defineComponent({
setup() {
const fooValue = ref('fooValue')
return () => {
return h('div', null, [
h('my-el-async-4', {
fooValue: fooValue.value,
}),
])
}
},
})
const app = createApp(R)
app.mount(container)
await new Promise(r => setTimeout(r))
const e = container.querySelector('my-el-async-4') as VueElement
expect(e.shadowRoot!.innerHTML).toBe(`<div>fooValue</div>`)
app.unmount()
})
// #11276
test('delete prop on attr removal', async () => {
const E = defineCustomElement({
props: {
boo: {
type: Boolean,
},
},
render() {
return this.boo + ',' + typeof this.boo
},
})
customElements.define('el-attr-removal', E)
container.innerHTML = '<el-attr-removal boo>'
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe(`true,boolean`)
e.removeAttribute('boo')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(`false,boolean`)
})
test('hyphenated attr removal', async () => {
const E = defineCustomElement({
props: {
fooBar: {
type: Boolean,
},
},
render() {
return this.fooBar
},
})
customElements.define('el-hyphenated-attr-removal', E)
const toggle = ref(true)
const Comp = {
render() {
return h('el-hyphenated-attr-removal', {
'foo-bar': toggle.value ? '' : null,
})
},
}
render(h(Comp), container)
const el = container.children[0]
expect(el.hasAttribute('foo-bar')).toBe(true)
expect((el as any).outerHTML).toBe(
`<el-hyphenated-attr-removal foo-bar=""></el-hyphenated-attr-removal>`,
)
toggle.value = false
await nextTick()
expect(el.hasAttribute('foo-bar')).toBe(false)
expect((el as any).outerHTML).toBe(
`<el-hyphenated-attr-removal></el-hyphenated-attr-removal>`,
)
})
})