Skip to content

Commit

Permalink
fix(runtime-dom): avoid unnecessary prop patch for checkbox (#11657)
Browse files Browse the repository at this point in the history
close #11647
  • Loading branch information
Mini-ghost authored Sep 3, 2024
1 parent fe07f70 commit c3ce9fe
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 2 deletions.
45 changes: 44 additions & 1 deletion packages/runtime-dom/__tests__/patchProps.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
import { patchProp } from '../src/patchProp'
import { h, nextTick, ref, render } from '../src'
import {
h,
nextTick,
ref,
render,
vModelCheckbox,
withDirectives,
} from '../src'

describe('runtime-dom: props patching', () => {
test('basic', () => {
Expand Down Expand Up @@ -351,4 +358,40 @@ describe('runtime-dom: props patching', () => {
expect(el.translate).toBeFalsy()
expect(el.getAttribute('translate')).toBe('no')
})

// #11647
test('should not trigger input mutation when `value` is `undefined`', async () => {
const fn = vi.fn()
const comp = {
setup() {
const checked = ref()
return () =>
withDirectives(
h('input', {
type: 'checkbox',
value: undefined,
'onUpdate:modelValue': (value: any) => {
checked.value = value
},
}),
[[vModelCheckbox, checked.value]],
)
},
}

const root = document.createElement('div')
render(h(comp), root)
document.body.append(root)

const el = root.children[0] as HTMLInputElement
const observer = new MutationObserver(fn)
observer.observe(el, {
attributes: true,
})

el.click()
await nextTick()

expect(fn).toBeCalledTimes(0)
})
})
9 changes: 8 additions & 1 deletion packages/runtime-dom/src/modules/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,14 @@ export function patchDOMProp(
// compare against its attribute value instead.
const oldValue =
tag === 'OPTION' ? el.getAttribute('value') || '' : el.value
const newValue = value == null ? '' : String(value)
const newValue =
value == null
? // #11647: value should be set as empty string for null and undefined,
// but <input type="checkbox"> should be set as 'on'.
el.type === 'checkbox'
? 'on'
: ''
: String(value)
if (oldValue !== newValue || !('_value' in el)) {
el.value = newValue
}
Expand Down

0 comments on commit c3ce9fe

Please sign in to comment.