Skip to content

fix: support for .passive modifier #72

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

Merged
merged 1 commit into from
Jul 23, 2019
Merged
Show file tree
Hide file tree
Changes from all 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
22 changes: 17 additions & 5 deletions packages/babel-sugar-v-on/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -183,17 +183,29 @@ export default function(babel) {
.reduce((acc, item) => (acc ? or(acc, item) : item)),
),
)
} else if (key === 'capture') {
event = '!' + event
} else if (key === 'once') {
event = '~' + event
} else if (key === 'capture' || key === 'once' || key === 'passive') {
continue
} else if (key === 'native') {
isNative = true
} else {
keys.push(key)
}
}

// vue has special order of capture/once/passive with
// modifier markers
// SEE
// https://github.com/vuejs/vue/blob/4c98f9de39e18703ec3dbd05b596a1bbc3d0c8e3/src/compiler/helpers.js#L111
if (modifiers.indexOf('capture') > -1) {
event = '!' + event
}
if (modifiers.indexOf('once') > -1) {
event = '~' + event
}
if (modifiers.indexOf('passive') > -1) {
event = '&' + event
}

if (keys.length) {
code.push(genKeyFilter(keys))
}
Expand Down Expand Up @@ -251,7 +263,7 @@ export default function(babel) {
}

function addEvent(event, expression, isNative, attributes) {
if (event[0] !== '~' && event[0] !== '!') {
if (event[0] !== '~' && event[0] !== '!' && event[0] !== '&') {
attributes.push(
t.jSXAttribute(
t.jSXIdentifier(`${isNative ? 'nativeOn' : 'on'}-${event}`),
Expand Down
100 changes: 100 additions & 0 deletions packages/babel-sugar-v-on/test/functional.js
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,106 @@ test('should support once and other modifiers', t => {
t.is(stub.calls.length, 1)
})

test('should support passive', t => {
const arr = []
const wrapper = mount({
methods: {
foo(e) {
arr.push(e.defaultPrevented) // will be false
e.preventDefault()
arr.push(e.defaultPrevented) // will be true
},
bar(e) {
arr.push(e.defaultPrevented) // will be false
e.preventDefault() // does nothing since the listener is passive
arr.push(e.defaultPrevented) // still false
},
},
render(h) {
return (
<section>
<div vOn:click={this.foo} />
<div vOn:click_passive={this.bar} />
</section>
)
},
})
const divs = wrapper.findAll('div')
divs.at(0).trigger('click')
divs.at(1).trigger('click')
t.deepEqual(arr, [false, true, false, false])
})

test('should support passive and once', t => {
const arr = []
const wrapper = mount({
methods: {
bar(e) {
arr.push(e.defaultPrevented) // will be false
e.preventDefault() // does nothing since the listener is passive
arr.push(e.defaultPrevented) // still false
},
},
render(h) {
return <div vOn:click_passive_once={this.bar} />
},
})

wrapper.trigger('click')
t.deepEqual(arr, [false, false])

wrapper.trigger('click')
t.deepEqual(arr, [false, false])
})

test('should support passive and other modifiers', t => {
const arr = []
const wrapper = mount({
methods: {
bar(e) {
arr.push(e.defaultPrevented) // will be false
e.preventDefault() // does nothing since the listener is passive
arr.push(e.defaultPrevented) // still false
},
},
render(h) {
return (
<section vOn:click_passive_self={this.bar}>
<div />
</section>
)
},
})

wrapper.trigger('click')
t.deepEqual(arr, [false, false])

wrapper.find('div').trigger('click')
t.deepEqual(arr, [false, false])
})

test("should respect vue' order on special modifer markers", t => {
// This test is especially for `.passive` working with other modifiers
const fn = t.context.stub()
const FC = h => (
<section>
<div vOn:click_once_passive={fn} />
<div vOn:click_passive_once={fn} />
<div vOn:click_passive_capture={fn} />
<div vOn:click_capture_passive={fn} />
</section>
)

const mockCreateElement = (tag, props, children) => {
if (tag === 'div') {
// `&` is always the first if `.passive` present
t.is(Object.keys(props.on)[0].indexOf('&'), 0)
}
}

FC(mockCreateElement)
})

test('should support keyCode', t => {
const stub = t.context.stub()
const wrapper = mount({
Expand Down