import {
type Ref,
type VueElement,
defineAsyncComponent,
defineComponent,
defineCustomElement,
h,
inject,
nextTick,
ref,
renderSlot,
} from '../src'
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 = ``
const e = container.childNodes[0] as VueElement
expect(e).toBeInstanceOf(E)
expect(e._instance).toBeTruthy()
expect(e.shadowRoot!.innerHTML).toBe(`
hello
`)
})
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(`inline
`)
})
test('should unmount on remove', async () => {
container.innerHTML = ``
const e = container.childNodes[0] as VueElement
container.removeChild(e)
await nextTick()
expect(e._instance).toBe(null)
expect(e.shadowRoot!.innerHTML).toBe('')
})
test('should not unmount on move', async () => {
container.innerHTML = `
`
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('hello
')
})
test('remove then insert again', async () => {
container.innerHTML = ``
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('hello
')
})
})
describe('props', () => {
const E = defineCustomElement({
props: ['foo', 'bar', 'bazQux'],
render() {
return [
h('div', null, this.foo),
h('div', null, this.bazQux || (this.bar && this.bar.x)),
]
},
})
customElements.define('my-el-props', E)
test('props via attribute', async () => {
// bazQux should map to `baz-qux` attribute
container.innerHTML = ``
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe('hello
bye
')
// change attr
e.setAttribute('foo', 'changed')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('changed
bye
')
e.setAttribute('baz-qux', 'changed')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(
'changed
changed
',
)
})
test('props via properties', async () => {
const e = new E()
e.foo = 'one'
e.bar = { x: 'two' }
container.appendChild(e)
expect(e.shadowRoot!.innerHTML).toBe('one
two
')
// 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('three
two
')
expect(e.getAttribute('foo')).toBe('three')
e.foo = null
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('two
')
expect(e.hasAttribute('foo')).toBe(false)
e.bazQux = 'four'
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('four
')
expect(e.getAttribute('baz-qux')).toBe('four')
})
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 = ``
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('"foo
"')
})
// # 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')
})
})
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 = ``
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe('hello
')
e.setAttribute('foo', 'changed')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe('changed
')
})
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('')
})
})
describe('emits', () => {
const CompDef = defineComponent({
setup(_, { emit }) {
emit('created')
return () =>
h('div', {
onClick: () => {
emit('my-click', 1)
},
onMousedown: () => {
emit('myEvent', 1) // validate hyphenation
},
})
},
})
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 = ``
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 = ``
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(res => res(CompDef as any))
const E = defineCustomElement(defineAsyncComponent(() => p))
customElements.define('my-async-el-emits', E)
container.innerHTML = ``
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(res => res(CompDef as any)),
),
)
customElements.define('my-async-el-props-emits', E)
container.innerHTML = ``
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],
})
})
})
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('default slot', () => {
container.innerHTML = `hi`
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(
`
`,
)
})
})
describe('provide/inject', () => {
const Consumer = defineCustomElement({
setup() {
const foo = inject[('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 = ``
const provider = container.childNodes[0] as VueElement
const consumer = provider.shadowRoot!.childNodes[0] as VueElement
expect(consumer.shadowRoot!.innerHTML).toBe(`]injected!
`)
foo.value = 'changed!'
await nextTick()
expect(consumer.shadowRoot!.innerHTML).toBe(`changed!
`)
})
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 = ``
const provider = container.childNodes[0]
const consumer = provider.childNodes[0] as VueElement
expect(consumer.shadowRoot!.innerHTML).toBe(`injected!
`)
foo.value = 'changed!'
await nextTick()
expect(consumer.shadowRoot!.innerHTML).toBe(`changed!
`)
})
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[('fooA')!
const fooB = inject][('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 = ``
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(`]FooA! FooB!
`)
fooA.value = 'changedA!'
fooB.value = 'changedB!'
await nextTick()
expect(consumer.shadowRoot!.innerHTML).toBe(
`changedA! changedB!
`,
)
})
})
describe('styles', () => {
test('should attach styles to shadow dom', () => {
const Foo = defineCustomElement({
styles: [`div { color: red; }`],
render() {
return h('div', 'hello')
},
})
customElements.define('my-el-with-styles', Foo)
container.innerHTML = ``
const el = container.childNodes[0] as VueElement
const style = el.shadowRoot?.querySelector('style')!
expect(style.textContent).toBe(`div { color: red; }`)
})
})
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 =
`` +
``
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(
`hello
`,
)
expect(e2.shadowRoot!.innerHTML).toBe(
`world
`,
)
// attr
e1.setAttribute('msg', 'attr')
await nextTick()
expect((e1 as any).msg).toBe('attr')
expect(e1.shadowRoot!.innerHTML).toBe(
`attr
`,
)
// props
expect(`msg` in e1).toBe(true)
;(e1 as any).msg = 'prop'
expect(e1.getAttribute('msg')).toBe('prop')
expect(e1.shadowRoot!.innerHTML).toBe(
`prop
`,
)
})
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(`hello
`)
expect(e2.shadowRoot!.innerHTML).toBe(`world
`)
e1.msg = 'world'
expect(e1.shadowRoot!.innerHTML).toBe(`world
`)
e2.msg = 'hello'
expect(e2.shadowRoot!.innerHTML).toBe(`hello
`)
})
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 = ``
await new Promise(r => setTimeout(r))
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe(`20,number
`)
})
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 = `hi`
await new Promise(r => setTimeout(r))
const e = container.childNodes[0] as VueElement
expect(e.shadowRoot!.innerHTML).toBe(
`
`,
)
})
})
})