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(v-model): vModelSelect work with custom getter and setter edge case #12428

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions packages/runtime-dom/__tests__/directives/vModel.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {
type VNode,
computed,
defineComponent,
h,
nextTick,
Expand Down Expand Up @@ -1409,6 +1410,51 @@ describe('vModel', () => {
expect(bar.selected).toEqual(true)
})

it('multiple select (v-model has custom setter)', async () => {
const selected = ref([])

const multipleSelected = computed({
get() {
return selected.value
},
set(newVal) {
selected.value = newVal.slice(0, 1)
},
})
const setValue = (v: any) => {
multipleSelected.value = v
}
const component = defineComponent({
render() {
return [
withVModel(
h(
'select',
{
multiple: true,
'onUpdate:modelValue': setValue,
},
[h('option', { value: '1' }), h('option', { value: '2' })],
),
multipleSelected.value,
),
]
},
})
render(h(component), root)

await nextTick()
const select = root.querySelector('select')
const [foo, bar] = root.querySelectorAll('option')
foo.selected = true
bar.selected = true
triggerEvent('change', select)
await nextTick()
expect(selected.value).toEqual(['1'])
expect(foo.selected).toEqual(true)
expect(bar.selected).toEqual(false)
})

// #10503
test('equal value with a leading 0 should trigger update.', async () => {
const setNum = function (this: any, value: any) {
Expand Down
30 changes: 18 additions & 12 deletions packages/runtime-dom/src/directives/vModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
type ObjectDirective,
type VNode,
nextTick,
toRaw,
warn,
} from '@vue/runtime-core'
import { addEventListener } from '../modules/events'
Expand Down Expand Up @@ -38,9 +39,15 @@ function onCompositionEnd(e: Event) {
}

const assignKey: unique symbol = Symbol('_assign')
const assignValueKey: unique symbol = Symbol('_value')
const assigningKey: unique symbol = Symbol('_assigning')

type ModelDirective<T, Modifiers extends string = string> = ObjectDirective<
T & { [assignKey]: AssignerFn; _assigning?: boolean },
T & {
[assignKey]: AssignerFn
[assignValueKey]: any
[assigningKey]?: boolean
},
any,
Modifiers
>
Expand Down Expand Up @@ -202,24 +209,23 @@ export const vModelRadio: ModelDirective<HTMLInputElement> = {
export const vModelSelect: ModelDirective<HTMLSelectElement, 'number'> = {
// <select multiple> value need to be deep traversed
deep: true,
created(el, { value, modifiers: { number } }, vnode) {
created(el, { value, oldValue, modifiers: { number } }, vnode) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think oldValue is unused.

const isSetModel = isSet(value)
addEventListener(el, 'change', () => {
const selectedVal = Array.prototype.filter
.call(el.options, (o: HTMLOptionElement) => o.selected)
.map((o: HTMLOptionElement) =>
number ? looseToNumber(getValue(o)) : getValue(o),
)
el[assignKey](
el.multiple
? isSetModel
? new Set(selectedVal)
: selectedVal
: selectedVal[0],
)
el._assigning = true
const value = (el[assignValueKey] = el.multiple
? isSetModel
? new Set(selectedVal)
: selectedVal
: selectedVal[0])
el[assignKey](value)
el[assigningKey] = true
nextTick(() => {
el._assigning = false
el[assigningKey] = false
})
})
el[assignKey] = getModelAssigner(vnode)
Expand All @@ -233,7 +239,7 @@ export const vModelSelect: ModelDirective<HTMLSelectElement, 'number'> = {
el[assignKey] = getModelAssigner(vnode)
},
updated(el, { value }) {
if (!el._assigning) {
if (!el[assigningKey] || toRaw(value) !== el[assignValueKey]) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using an equality check might be problematic if the collection is modified, rather than replaced.

For example:

I'm not sure how important handling cases like these is. The change doesn't make them any worse.

setSelected(el, value)
}
},
Expand Down