462 lines
13 KiB
TypeScript
462 lines
13 KiB
TypeScript
import {
|
|
defineAsyncComponent,
|
|
defineCustomElement,
|
|
h,
|
|
inject,
|
|
nextTick,
|
|
Ref,
|
|
ref,
|
|
renderSlot,
|
|
VueElement
|
|
} 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 = `<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('')
|
|
})
|
|
|
|
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>')
|
|
})
|
|
})
|
|
|
|
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 = `<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.bazQux = 'four'
|
|
await nextTick()
|
|
expect(e.shadowRoot!.innerHTML).toBe('<div></div><div>four</div>')
|
|
expect(e.getAttribute('baz-qux')).toBe('four')
|
|
})
|
|
|
|
test('attribute -> prop type casting', async () => {
|
|
const E = defineCustomElement({
|
|
props: {
|
|
foo: Number,
|
|
bar: Boolean,
|
|
baz: String
|
|
},
|
|
render() {
|
|
return [
|
|
this.foo,
|
|
typeof this.foo,
|
|
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="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', '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 `foo: ${this.foo}`
|
|
}
|
|
})
|
|
const el = document.createElement('my-el-upgrade') as any
|
|
el.foo = 'hello'
|
|
el.dataset.age = 5
|
|
container.appendChild(el)
|
|
customElements.define('my-el-upgrade', E)
|
|
expect(el.shadowRoot.innerHTML).toBe(`foo: hello`)
|
|
})
|
|
})
|
|
|
|
describe('emits', () => {
|
|
const E = defineCustomElement({
|
|
setup(_, { emit }) {
|
|
emit('created')
|
|
return () =>
|
|
h('div', {
|
|
onClick: () => emit('my-click', 1)
|
|
})
|
|
}
|
|
})
|
|
customElements.define('my-el-emits', E)
|
|
|
|
test('emit on connect', () => {
|
|
const e = new E()
|
|
const spy = jest.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 = jest.fn()
|
|
e.addEventListener('my-click', spy)
|
|
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 = `<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>`)
|
|
})
|
|
})
|
|
|
|
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 = `<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; }`)
|
|
})
|
|
})
|
|
|
|
describe('async', () => {
|
|
test('should work', async () => {
|
|
const loaderSpy = jest.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>`)
|
|
})
|
|
})
|
|
})
|