Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(runtime-dom): custom-element: should set default prop when attribute is not initialized #7097

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 17 additions & 4 deletions packages/runtime-dom/__tests__/customElement.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,12 +135,15 @@ describe('defineCustomElement', () => {
test('attribute -> prop type casting', async () => {
const E = defineCustomElement({
props: {
foo: { type: Number, default: 0 },
fooBar: Number, // test casting of camelCase prop names
bar: Boolean,
baz: String
},
render() {
return [
this.foo,
typeof this.foo,
this.fooBar,
typeof this.fooBar,
this.bar,
Expand All @@ -154,22 +157,32 @@ describe('defineCustomElement', () => {
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`
`0 number 1 number false boolean 12345 string`
)

e.setAttribute('foo', '3')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(
`3 number 1 number false boolean 12345 string`
)

e.setAttribute('bar', '')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(`1 number true boolean 12345 string`)
expect(e.shadowRoot!.innerHTML).toBe(
`3 number 1 number true boolean 12345 string`
)

e.setAttribute('foo-bar', '2e1')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(
`20 number true boolean 12345 string`
`3 number 20 number true boolean 12345 string`
)

e.setAttribute('baz', '2e1')
await nextTick()
expect(e.shadowRoot!.innerHTML).toBe(`20 number true boolean 2e1 string`)
expect(e.shadowRoot!.innerHTML).toBe(
`3 number 20 number true boolean 2e1 string`
)
})

// #4772
Expand Down
18 changes: 17 additions & 1 deletion packages/runtime-dom/src/apiCustomElement.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,14 @@ import {
ComponentOptions,
ComponentInjectOptions
} from '@vue/runtime-core'
import { camelize, extend, hyphenate, isArray, toNumber } from '@vue/shared'
import {
camelize,
extend,
hyphenate,
isArray,
toNumber,
hasOwn
} from '@vue/shared'
import { hydrate, render } from '.'

export type VueElementConstructor<P = {}> = {
Expand Down Expand Up @@ -232,6 +239,15 @@ export class VueElement extends BaseClass {
const hasOptions = !isArray(props)
const rawKeys = props ? (hasOptions ? Object.keys(props) : props) : []

// set default prop
rawKeys.forEach(key => {
if (!props[key]) return
const defaultProp = props[key].default
if (!hasOwn(this._props, key) && defaultProp !== undefined) {
this._setProp(key, defaultProp)
}
})

// cast Number-type props set before resolve
let numberProps
if (hasOptions) {
Expand Down