| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160 |
- 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 attributes and properties changed together', async () => {
- const e = new E()
- e.foo = 'foo1'
- e.bar = { x: 'bar1' }
- container.appendChild(e)
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe('<div>foo1</div><div>bar1</div>')
- // change attr then property
- e.setAttribute('foo', 'foo2')
- e.bar = { x: 'bar2' }
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe('<div>foo2</div><div>bar2</div>')
- expect(e.getAttribute('foo')).toBe('foo2')
- expect(e.hasAttribute('bar')).toBe(false)
- // change prop then attr
- e.bar = { x: 'bar3' }
- e.setAttribute('foo', 'foo3')
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe('<div>foo3</div><div>bar3</div>')
- expect(e.getAttribute('foo')).toBe('foo3')
- expect(e.hasAttribute('bar')).toBe(false)
- })
- 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')
- })
- test('prop types validation', async () => {
- const E = defineCustomElement({
- props: {
- num: {
- type: [Number, String],
- },
- bool: {
- type: Boolean,
- },
- },
- render() {
- return h('div', [
- h('span', [`${this.num} is ${typeof this.num}`]),
- h('span', [`${this.bool} is ${typeof this.bool}`]),
- ])
- },
- })
- customElements.define('my-el-with-type-props', E)
- render(h('my-el-with-type-props', { num: 1, bool: true }), container)
- const e = container.childNodes[0] as VueElement
- // @ts-expect-error
- expect(e.num).toBe(1)
- // @ts-expect-error
- expect(e.bool).toBe(true)
- expect(e.shadowRoot!.innerHTML).toBe(
- '<div><span>1 is number</span><span>true is boolean</span></div>',
- )
- })
- test('should patch all props together', async () => {
- let prop1Calls = 0
- let prop2Calls = 0
- const E = defineCustomElement({
- props: {
- prop1: {
- type: String,
- default: 'default1',
- },
- prop2: {
- type: String,
- default: 'default2',
- },
- },
- data() {
- return {
- data1: 'defaultData1',
- data2: 'defaultData2',
- }
- },
- watch: {
- prop1(_) {
- prop1Calls++
- this.data2 = this.prop2
- },
- prop2(_) {
- prop2Calls++
- this.data1 = this.prop1
- },
- },
- render() {
- return h('div', [
- h('h1', this.prop1),
- h('h1', this.prop2),
- h('h2', this.data1),
- h('h2', this.data2),
- ])
- },
- })
- customElements.define('my-watch-element', E)
- render(h('my-watch-element'), container)
- const e = container.childNodes[0] as VueElement
- expect(e).toBeInstanceOf(E)
- expect(e._instance).toBeTruthy()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><h1>default1</h1><h1>default2</h1><h2>defaultData1</h2><h2>defaultData2</h2></div>`,
- )
- expect(prop1Calls).toBe(0)
- expect(prop2Calls).toBe(0)
- // patch props
- render(
- h('my-watch-element', { prop1: 'newValue1', prop2: 'newValue2' }),
- container,
- )
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><h1>newValue1</h1><h1>newValue2</h1><h2>newValue1</h2><h2>newValue2</h2></div>`,
- )
- expect(prop1Calls).toBe(1)
- expect(prop2Calls).toBe(1)
- // same prop values
- render(
- h('my-watch-element', { prop1: 'newValue1', prop2: 'newValue2' }),
- container,
- )
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><h1>newValue1</h1><h1>newValue2</h1><h2>newValue1</h2><h2>newValue2</h2></div>`,
- )
- expect(prop1Calls).toBe(1)
- expect(prop2Calls).toBe(1)
- // update only prop1
- render(
- h('my-watch-element', { prop1: 'newValue3', prop2: 'newValue2' }),
- container,
- )
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><h1>newValue3</h1><h1>newValue2</h1><h2>newValue1</h2><h2>newValue2</h2></div>`,
- )
- expect(prop1Calls).toBe(2)
- expect(prop2Calls).toBe(1)
- })
- test('should patch all props together (async)', async () => {
- let prop1Calls = 0
- let prop2Calls = 0
- const E = defineCustomElement(
- defineAsyncComponent(() =>
- Promise.resolve(
- defineComponent({
- props: {
- prop1: {
- type: String,
- default: 'default1',
- },
- prop2: {
- type: String,
- default: 'default2',
- },
- },
- data() {
- return {
- data1: 'defaultData1',
- data2: 'defaultData2',
- }
- },
- watch: {
- prop1(_) {
- prop1Calls++
- this.data2 = this.prop2
- },
- prop2(_) {
- prop2Calls++
- this.data1 = this.prop1
- },
- },
- render() {
- return h('div', [
- h('h1', this.prop1),
- h('h1', this.prop2),
- h('h2', this.data1),
- h('h2', this.data2),
- ])
- },
- }),
- ),
- ),
- )
- customElements.define('my-async-watch-element', E)
- render(h('my-async-watch-element'), container)
- await new Promise(r => setTimeout(r))
- const e = container.childNodes[0] as VueElement
- expect(e).toBeInstanceOf(E)
- expect(e._instance).toBeTruthy()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><h1>default1</h1><h1>default2</h1><h2>defaultData1</h2><h2>defaultData2</h2></div>`,
- )
- expect(prop1Calls).toBe(0)
- expect(prop2Calls).toBe(0)
- // patch props
- render(
- h('my-async-watch-element', { prop1: 'newValue1', prop2: 'newValue2' }),
- container,
- )
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><h1>newValue1</h1><h1>newValue2</h1><h2>newValue1</h2><h2>newValue2</h2></div>`,
- )
- expect(prop1Calls).toBe(1)
- expect(prop2Calls).toBe(1)
- // same prop values
- render(
- h('my-async-watch-element', { prop1: 'newValue1', prop2: 'newValue2' }),
- container,
- )
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><h1>newValue1</h1><h1>newValue2</h1><h2>newValue1</h2><h2>newValue2</h2></div>`,
- )
- expect(prop1Calls).toBe(1)
- expect(prop2Calls).toBe(1)
- // update only prop1
- render(
- h('my-async-watch-element', { prop1: 'newValue3', prop2: 'newValue2' }),
- container,
- )
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><h1>newValue3</h1><h1>newValue2</h1><h2>newValue1</h2><h2>newValue2</h2></div>`,
- )
- expect(prop1Calls).toBe(2)
- expect(prop2Calls).toBe(1)
- })
- })
- 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>')
- })
- // https://github.com/vuejs/core/issues/12964
- // Disabled because of missing support for `delegatesFocus` in jsdom
- // https://github.com/jsdom/jsdom/issues/3418
- // oxlint-disable-next-line vitest/no-disabled-tests
- test.skip('shadowRoot should be initialized with delegatesFocus', () => {
- const E = defineCustomElement(
- {
- render() {
- return [h('input', { tabindex: 1 })]
- },
- },
- { shadowRootOptions: { delegatesFocus: true } },
- )
- customElements.define('my-el-with-delegate-focus', E)
- const e = new E()
- container.appendChild(e)
- expect(e.shadowRoot!.delegatesFocus).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>`,
- )
- })
- test('render slot props', async () => {
- const foo = ref('foo')
- const E = defineCustomElement({
- render() {
- return [
- h(
- 'div',
- null,
- renderSlot(this.$slots, 'default', { class: foo.value }),
- ),
- ]
- },
- })
- customElements.define('my-el-slot-props', E)
- container.innerHTML = `<my-el-slot-props><span>hi</span></my-el-slot-props>`
- const e = container.childNodes[0] as VueElement
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><slot class="foo"></slot></div>`,
- )
- foo.value = 'bar'
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe(
- `<div><slot class="bar"></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>`,
- )
- })
- // #13212
- test('inherited from app context within nested elements', async () => {
- const outerValues: (string | undefined)[] = []
- const innerValues: (string | undefined)[] = []
- const innerChildValues: (string | undefined)[] = []
- const Outer = defineCustomElement(
- {
- setup() {
- outerValues.push(
- inject<string>('shared'),
- inject<string>('outer'),
- inject<string>('inner'),
- )
- },
- render() {
- return h('div', [renderSlot(this.$slots, 'default')])
- },
- },
- {
- configureApp(app) {
- app.provide('shared', 'shared')
- app.provide('outer', 'outer')
- },
- },
- )
- const Inner = defineCustomElement(
- {
- setup() {
- // ensure values are not self-injected
- provide('inner', 'inner-child')
- innerValues.push(
- inject<string>('shared'),
- inject<string>('outer'),
- inject<string>('inner'),
- )
- },
- render() {
- return h('div', [renderSlot(this.$slots, 'default')])
- },
- },
- {
- configureApp(app) {
- app.provide('outer', 'override-outer')
- app.provide('inner', 'inner')
- },
- },
- )
- const InnerChild = defineCustomElement({
- setup() {
- innerChildValues.push(
- inject<string>('shared'),
- inject<string>('outer'),
- inject<string>('inner'),
- )
- },
- render() {
- return h('div')
- },
- })
- customElements.define('provide-from-app-outer', Outer)
- customElements.define('provide-from-app-inner', Inner)
- customElements.define('provide-from-app-inner-child', InnerChild)
- container.innerHTML =
- '<provide-from-app-outer>' +
- '<provide-from-app-inner>' +
- '<provide-from-app-inner-child></provide-from-app-inner-child>' +
- '</provide-from-app-inner>' +
- '</provide-from-app-outer>'
- const outer = container.childNodes[0] as VueElement
- expect(outer.shadowRoot!.innerHTML).toBe('<div><slot></slot></div>')
- expect('[Vue warn]: injection "inner" not found.').toHaveBeenWarnedTimes(
- 1,
- )
- expect(
- '[Vue warn]: App already provides property with key "outer" inherited from its parent element. ' +
- 'It will be overwritten with the new value.',
- ).toHaveBeenWarnedTimes(1)
- expect(outerValues).toEqual(['shared', 'outer', undefined])
- expect(innerValues).toEqual(['shared', 'override-outer', 'inner'])
- expect(innerChildValues).toEqual([
- 'shared',
- 'override-outer',
- 'inner-child',
- ])
- })
- })
- 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("child components should not inject styles to root element's shadow root w/ shadowRoot false", async () => {
- const Bar = defineComponent({
- styles: [`div { color: green; }`],
- render() {
- return 'bar'
- },
- })
- const Baz = () => h(Bar)
- const Foo = defineCustomElement(
- {
- render() {
- return [h(Baz)]
- },
- },
- { shadowRoot: false },
- )
- customElements.define('my-foo-with-shadowroot-false', Foo)
- container.innerHTML = `<my-foo-with-shadowroot-false></my-foo-with-shadowroot-false>`
- const el = container.childNodes[0] as VueElement
- const style = el.shadowRoot?.querySelector('style')
- expect(style).toBeUndefined()
- })
- 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()
- })
- test('render two Teleports w/ shadowRoot false', async () => {
- const target1 = document.createElement('div')
- const target2 = document.createElement('span')
- const Child = defineCustomElement(
- {
- render() {
- return [
- h(Teleport, { to: target1 }, [renderSlot(this.$slots, 'header')]),
- h(Teleport, { to: target2 }, [renderSlot(this.$slots, 'body')]),
- ]
- },
- },
- { shadowRoot: false },
- )
- customElements.define('my-el-two-teleport-child', Child)
- const App = {
- render() {
- return h('my-el-two-teleport-child', null, {
- default: () => [
- h('div', { slot: 'header' }, 'header'),
- h('span', { slot: 'body' }, 'body'),
- ],
- })
- },
- }
- const app = createApp(App)
- app.mount(container)
- await nextTick()
- expect(target1.outerHTML).toBe(
- `<div><div slot="header">header</div></div>`,
- )
- expect(target2.outerHTML).toBe(
- `<span><span slot="body">body</span></span>`,
- )
- app.unmount()
- })
- test('render two Teleports w/ shadowRoot false (with disabled)', async () => {
- const target1 = document.createElement('div')
- const target2 = document.createElement('span')
- const Child = defineCustomElement(
- {
- render() {
- return [
- // with disabled: true
- h(Teleport, { to: target1, disabled: true }, [
- renderSlot(this.$slots, 'header'),
- ]),
- h(Teleport, { to: target2 }, [renderSlot(this.$slots, 'body')]),
- ]
- },
- },
- { shadowRoot: false },
- )
- customElements.define('my-el-two-teleport-child-0', Child)
- const App = {
- render() {
- return h('my-el-two-teleport-child-0', null, {
- default: () => [
- h('div', { slot: 'header' }, 'header'),
- h('span', { slot: 'body' }, 'body'),
- ],
- })
- },
- }
- const app = createApp(App)
- app.mount(container)
- await nextTick()
- expect(target1.outerHTML).toBe(`<div></div>`)
- expect(target2.outerHTML).toBe(
- `<span><span slot="body">body</span></span>`,
- )
- app.unmount()
- })
- test('teleport target is ancestor of custom element host', async () => {
- const Child = defineCustomElement(
- {
- render() {
- return [
- h(Teleport, { to: '#t1' }, [renderSlot(this.$slots, 'header')]),
- ]
- },
- },
- { shadowRoot: false },
- )
- customElements.define('my-el-teleport-child-target', Child)
- const App = {
- render() {
- return h('div', { id: 't1' }, [
- h('my-el-teleport-child-target', null, {
- default: () => [h('div', { slot: 'header' }, 'header')],
- }),
- ])
- },
- }
- const app = createApp(App)
- app.mount(container)
- const target1 = document.getElementById('t1')!
- expect(target1.outerHTML).toBe(
- `<div id="t1">` +
- `<my-el-teleport-child-target data-v-app="">` +
- `<!--teleport start--><!--teleport end-->` +
- `</my-el-teleport-child-target>` +
- `<div slot="header">header</div>` +
- `</div>`,
- )
- app.unmount()
- })
- test('toggle nested custom element with shadowRoot: false', async () => {
- customElements.define(
- 'my-el-child-shadow-false',
- defineCustomElement(
- {
- render(ctx: any) {
- return h('div', null, [renderSlot(ctx.$slots, 'default')])
- },
- },
- { shadowRoot: false },
- ),
- )
- const ChildWrapper = {
- render() {
- return h('my-el-child-shadow-false', null, 'child')
- },
- }
- customElements.define(
- 'my-el-parent-shadow-false',
- defineCustomElement(
- {
- props: {
- isShown: { type: Boolean, required: true },
- },
- render(ctx: any, _: any, $props: any) {
- return $props.isShown
- ? h('div', { key: 0 }, [renderSlot(ctx.$slots, 'default')])
- : null
- },
- },
- { shadowRoot: false },
- ),
- )
- const ParentWrapper = {
- props: {
- isShown: { type: Boolean, required: true },
- },
- render(ctx: any, _: any, $props: any) {
- return h('my-el-parent-shadow-false', { isShown: $props.isShown }, [
- renderSlot(ctx.$slots, 'default'),
- ])
- },
- }
- const isShown = ref(true)
- const App = {
- render() {
- return h(ParentWrapper, { isShown: isShown.value } as any, {
- default: () => [h(ChildWrapper)],
- })
- },
- }
- const container = document.createElement('div')
- document.body.appendChild(container)
- const app = createApp(App)
- app.mount(container)
- expect(container.innerHTML).toBe(
- `<my-el-parent-shadow-false is-shown="" data-v-app="">` +
- `<div>` +
- `<my-el-child-shadow-false data-v-app="">` +
- `<div>child</div>` +
- `</my-el-child-shadow-false>` +
- `</div>` +
- `</my-el-parent-shadow-false>`,
- )
- isShown.value = false
- await nextTick()
- expect(container.innerHTML).toBe(
- `<my-el-parent-shadow-false data-v-app=""><!----></my-el-parent-shadow-false>`,
- )
- isShown.value = true
- await nextTick()
- expect(container.innerHTML).toBe(
- `<my-el-parent-shadow-false data-v-app="" is-shown="">` +
- `<div>` +
- `<my-el-child-shadow-false data-v-app="">` +
- `<div>child</div>` +
- `</my-el-child-shadow-false>` +
- `</div>` +
- `</my-el-parent-shadow-false>`,
- )
- })
- })
- 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 w/ options api', async () => {
- const E = defineCustomElement({
- data() {
- return {
- value: 0,
- }
- },
- methods: {
- foo() {
- ;(this as any).value++
- },
- },
- expose: ['foo'],
- render(_ctx: any) {
- return h('div', null, _ctx.value)
- },
- })
- customElements.define('my-el-expose-options-api', E)
- container.innerHTML = `<my-el-expose-options-api></my-el-expose-options-api>`
- const e = container.childNodes[0] as VueElement & {
- foo: () => void
- }
- expect(e.shadowRoot!.innerHTML).toBe(`<div>0</div>`)
- e.foo()
- await nextTick()
- expect(e.shadowRoot!.innerHTML).toBe(`<div>1</div>`)
- })
- 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>')
- })
- // #12448
- test('work with async component', async () => {
- const AsyncComp = defineAsyncComponent(() => {
- return Promise.resolve({
- render() {
- const msg: string | undefined = inject('msg')
- return h('div', {}, msg)
- },
- } as any)
- })
- const E = defineCustomElement(AsyncComp, {
- configureApp(app) {
- app.provide('msg', 'app-injected')
- },
- })
- customElements.define('my-async-element-with-app', E)
- container.innerHTML = `<my-async-element-with-app></my-async-element-with-app>`
- const e = container.childNodes[0] as VueElement
- await new Promise(r => setTimeout(r))
- expect(e.shadowRoot?.innerHTML).toBe('<div>app-injected</div>')
- })
- test('with hmr reload', async () => {
- const __hmrId = '__hmrWithApp'
- const def = defineComponent({
- __hmrId,
- setup() {
- const msg = inject('msg')
- return { msg }
- },
- render(this: any) {
- return h('div', [h('span', this.msg), h('span', this.$foo)])
- },
- })
- const E = defineCustomElement(def, {
- configureApp(app) {
- app.provide('msg', 'app-injected')
- app.config.globalProperties.$foo = 'foo'
- },
- })
- customElements.define('my-element-with-app-hmr', E)
- container.innerHTML = `<my-element-with-app-hmr></my-element-with-app-hmr>`
- const el = container.childNodes[0] as VueElement
- expect(el.shadowRoot?.innerHTML).toBe(
- `<div><span>app-injected</span><span>foo</span></div>`,
- )
- // hmr
- __VUE_HMR_RUNTIME__.reload(__hmrId, def as any)
- await nextTick()
- expect(el.shadowRoot?.innerHTML).toBe(
- `<div><span>app-injected</span><span>foo</span></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>`,
- )
- })
- test('no unexpected mutation of the 1st argument', () => {
- const Foo = {
- name: 'Foo',
- }
- defineCustomElement(Foo, { shadowRoot: false })
- expect(Foo).toEqual({
- name: 'Foo',
- })
- })
- })
|