Skip to content

feat(v-bind): add support for kebab-case update events #8004 #8033

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/compiler/parser/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { parseHTML } from './html-parser'
import { parseText } from './text-parser'
import { parseFilters } from './filter-parser'
import { genAssignmentCode } from '../directives/model'
import { extend, cached, no, camelize } from 'shared/util'
import { extend, cached, no, camelize, hyphenate } from 'shared/util'
import { isIE, isEdge, isServerRendering } from 'core/util/env'

import {
Expand Down Expand Up @@ -538,10 +538,16 @@ function processAttrs (el) {
name = camelize(name)
}
if (modifiers.sync) {
const assignmentCode = genAssignmentCode(value, `$event`)
addHandler(
el,
`update:${camelize(name)}`,
genAssignmentCode(value, `$event`)
assignmentCode
)
addHandler(
el,
`update:${hyphenate(name)}`,
assignmentCode
)
}
}
Expand Down
5 changes: 4 additions & 1 deletion src/core/instance/render-helpers/bind-object-props.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* @flow */

import config from 'core/config'
import { hyphenate } from 'shared/util'

import {
warn,
Expand Down Expand Up @@ -48,9 +49,11 @@ export function bindObjectProps (

if (isSync) {
const on = data.on || (data.on = {})
on[`update:${key}`] = function ($event) {
const onUpdate = function ($event) {
value[key] = $event
}
on[`update:${key}`] = onUpdate
on[`update:${hyphenate(key)}`] = onUpdate
}
}
}
Expand Down
55 changes: 53 additions & 2 deletions test/unit/features/directives/bind.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ describe('Directive v-bind', () => {
expect(vm.$el.getAttribute('viewBox')).toBe('0 0 1 1')
})

it('.sync modifier', done => {
it('.sync modifier: camelCase update event', done => {
const vm = new Vue({
template: `<test :foo-bar.sync="bar"/>`,
data: {
Expand All @@ -164,6 +164,27 @@ describe('Directive v-bind', () => {
}).then(done)
})

it('.sync modifier: kebab-case update event', done => {
const vm = new Vue({
template: `<test :foo-bar.sync="bar"/>`,
data: {
bar: 1
},
components: {
test: {
props: ['fooBar'],
template: `<div @click="$emit('update:foo-bar', 2)">{{ fooBar }}</div>`
}
}
}).$mount()

expect(vm.$el.textContent).toBe('1')
triggerEvent(vm.$el, 'click')
waitForUpdate(() => {
expect(vm.$el.textContent).toBe('2')
}).then(done)
})

it('bind object', done => {
const vm = new Vue({
template: '<input v-bind="test">',
Expand All @@ -187,7 +208,7 @@ describe('Directive v-bind', () => {
}).then(done)
})

it('.sync modifier with bind object', done => {
it('.sync modifier with bind object: camelCase update event', done => {
const vm = new Vue({
template: `<test v-bind.sync="test"/>`,
data: {
Expand Down Expand Up @@ -217,6 +238,36 @@ describe('Directive v-bind', () => {
}).then(done)
})

it('.sync modifier with bind object: kebab-case update event', done => {
const vm = new Vue({
template: `<test v-bind.sync="test"/>`,
data: {
test: {
fooBar: 1
}
},
components: {
test: {
props: ['fooBar'],
template: `<div @click="handleUpdate">{{ fooBar }}</div>`,
methods: {
handleUpdate () {
this.$emit('update:foo-bar', 2)
}
}
}
}
}).$mount()
expect(vm.$el.textContent).toBe('1')
triggerEvent(vm.$el, 'click')
waitForUpdate(() => {
expect(vm.$el.textContent).toBe('2')
vm.test.fooBar = 3
}).then(() => {
expect(vm.$el.textContent).toBe('3')
}).then(done)
})

it('bind object with overwrite', done => {
const vm = new Vue({
template: '<input v-bind="test" id="foo" :class="test.value">',
Expand Down