Skip to content

Commit 2df74c7

Browse files
38elementseddyerburgh
authored andcommitted
docs: update docs/en/guides/dom-events.md (#247)
* Add test for key code * Update dom-events.md * Fix trigger.spec.js * Update README.md * Update README.md
1 parent 0e0c94d commit 2df74c7

File tree

8 files changed

+61
-14
lines changed

8 files changed

+61
-14
lines changed

docs/en/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,24 @@
2626
- [attrs](api/options.md#attrs)
2727
- [listeners](api/options.md#listeners)
2828
- [clone](api/options.md#clone)
29+
- [provide](api/options.md#provide)
2930
* [Wrapper](api/wrapper/README.md)
31+
* [attributes](api/wrapper/attributes.md)
32+
* [classes](api/wrapper/classes.md)
3033
* [contains](api/wrapper/contains.md)
3134
* [emitted](api/wrapper/emitted.md)
3235
* [emittedByOrder](api/wrapper/emittedByOrder.md)
3336
* [exists](api/wrapper/exists.md)
3437
* [destroy](api/wrapper/destroy.md)
3538
* [find](api/wrapper/find.md)
3639
* [findAll](api/wrapper/findAll.md)
37-
* [hasAttribute](api/wrapper/hasAttribute.md)
38-
* [hasClass](api/wrapper/hasClass.md)
39-
* [hasProp](api/wrapper/hasProp.md)
4040
* [hasStyle](api/wrapper/hasStyle.md)
4141
* [html](api/wrapper/html.md)
4242
* [is](api/wrapper/is.md)
4343
* [isEmpty](api/wrapper/isEmpty.md)
4444
* [isVueInstance](api/wrapper/isVueInstance.md)
4545
* [name](api/wrapper/name.md)
46+
* [props](api/wrapper/props.md)
4647
* [setComputed](api/wrapper/setComputed.md)
4748
* [setData](api/wrapper/setData.md)
4849
* [setMethods](api/wrapper/setMethods.md)
@@ -55,9 +56,6 @@
5556
* [contains](api/wrapper-array/contains.md)
5657
* [exists](api/wrapper/exists.md)
5758
* [destroy](api/wrapper-array/destroy.md)
58-
* [hasAttribute](api/wrapper-array/hasAttribute.md)
59-
* [hasClass](api/wrapper-array/hasClass.md)
60-
* [hasProp](api/wrapper-array/hasProp.md)
6159
* [hasStyle](api/wrapper-array/hasStyle.md)
6260
* [is](api/wrapper-array/is.md)
6361
* [isEmpty](api/wrapper-array/isEmpty.md)

docs/en/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
- [attrs](api/options.md#attrs)
2323
- [listeners](api/options.md#listeners)
2424
- [clone](api/options.md#clone)
25+
- [provide](api/options.md#provide)
2526
* [Wrapper](api/wrapper/README.md)
2627
* [attributes](api/wrapper/attributes.md)
2728
* [classes](api/wrapper/classes.md)

docs/en/api/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@
1212
- [attrs](./options.md#attrs)
1313
- [listeners](./options.md#listeners)
1414
- [clone](./options.md#clone)
15+
- [provide](./options.md#provide)
1516
* [Wrapper](./wrapper/README.md)
17+
* [attributes](./wrapper/attributes.md)
18+
* [classes](./wrapper/classes.md)
1619
* [contains](./wrapper/contains.md)
1720
* [emitted](./wrapper/emitted.md)
1821
* [emittedByOrder](./wrapper/emittedByOrder.md)
@@ -29,6 +32,7 @@
2932
* [isEmpty](./wrapper/isEmpty.md)
3033
* [isVueInstance](./wrapper/isVueInstance.md)
3134
* [name](./wrapper/name.md)
35+
* [props](./wrapper/props.md)
3236
* [setComputed](./wrapper/setComputed.md)
3337
* [setData](./wrapper/setData.md)
3438
* [setMethods](./wrapper/setMethods.md)
@@ -41,9 +45,6 @@
4145
* [contains](./wrapper-array/contains.md)
4246
* [exists](./wrapper/exists.md)
4347
* [destroy](./wrapper-array/destroy.md)
44-
* [hasAttribute](./wrapper-array/hasAttribute.md)
45-
* [hasClass](./wrapper-array/hasClass.md)
46-
* [hasProp](./wrapper-array/hasProp.md)
4748
* [hasStyle](./wrapper-array/hasStyle.md)
4849
* [is](./wrapper-array/is.md)
4950
* [isEmpty](./wrapper-array/isEmpty.md)

docs/en/api/options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Vue options are passed to the component when a new instance is created. , e.g. `
1313
- [`localVue`](#localvue)
1414
- [`attachToDocument`](#attachtodocument)
1515
- [`attrs`](#attrs)
16-
- [`provide`](#provide)
1716
- [`listeners`](#listeners)
1817
- [`clone`](#clone)
18+
- [`provide`](#provide)
1919

2020
### `context`
2121

docs/en/guides/dom-events.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,23 @@ describe('Key event tests', () => {
189189

190190
A key name after the dot `keydown.up` is translated to a `keyCode`. This is supported for the following names:
191191

192-
* `enter`, `tab`, `delete`, `esc`, `space`, `up`, `down`, `left`, `right`
192+
| key name | key code |
193+
| --- | --- |
194+
| enter | 13 |
195+
| esc | 27 |
196+
| tab | 9 |
197+
| space | 32 |
198+
| delete | 46 |
199+
| backspace | 8 |
200+
| insert | 45 |
201+
| up | 38 |
202+
| down | 40 |
203+
| left | 37 |
204+
| right | 39 |
205+
| end | 35 |
206+
| home | 36 |
207+
| pageup | 33 |
208+
| pagedown | 34 |
193209

194210
## Important
195211

src/lib/find-vue-components.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ function findAllVueComponentsFromVm (vm: Component, components: Array<Component>
1010
}
1111

1212
function findAllVueComponentsFromVnode (vnode: Component, components: Array<Component> = []): Array<Component> {
13-
debugger
1413
if (vnode.child) {
1514
components.push(vnode.child)
1615
}
@@ -30,7 +29,6 @@ export function vmCtorMatchesName (vm: Component, name: string): boolean {
3029
}
3130

3231
export default function findVueComponents (root: Component, componentName: string): Array<Component> {
33-
debugger
3432
const components = root._isVue ? findAllVueComponentsFromVm(root) : findAllVueComponentsFromVnode(root)
3533
return components.filter((component) => {
3634
if (!component.$vnode) {

test/resources/components/component-with-events.vue

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<button class="click" @click="clickHandler" id="button" />
44
<button class="left-click" @mousedown="mousedownHandler" />
55
<div @click="toggleActive" v-bind:class="{ toggle: true, active: isActive }" />
6-
<input class="keydown" type="text" @keydown="keydownHandler" />
6+
<input class="keydown" type="text" @keyup="keyupHandler" @keydown="keydownHandler" />
77
<input class="keydown-enter" type="text" @keydown.enter="keydownHandler" />
88
</div>
99
</template>
@@ -16,6 +16,10 @@
1616
type: Function,
1717
default: () => {}
1818
},
19+
keyupHandler: {
20+
type: Function,
21+
default: () => {}
22+
},
1923
keydownHandler: {
2024
type: Function,
2125
default: () => {}

test/unit/specs/mount/Wrapper/trigger.spec.js

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,35 @@ describe('trigger', () => {
4343
expect(keydownHandler.calledOnce).to.equal(true)
4444
})
4545

46+
it('convert a registered key name to a key code', () => {
47+
const modifiers = {
48+
enter: 13,
49+
esc: 27,
50+
tab: 9,
51+
space: 32,
52+
delete: 46,
53+
backspace: 8,
54+
insert: 45,
55+
up: 38,
56+
down: 40,
57+
left: 37,
58+
right: 39,
59+
end: 35,
60+
home: 36,
61+
pageup: 33,
62+
pagedown: 34
63+
}
64+
const keyupHandler = sinon.stub()
65+
const wrapper = mount(ComponentWithEvents, {
66+
propsData: { keyupHandler }
67+
})
68+
for (const keyName in modifiers) {
69+
const keyCode = modifiers[keyName]
70+
wrapper.find('.keydown').trigger(`keyup.${keyName}`)
71+
expect(keyupHandler.lastCall.args[0].keyCode).to.equal(keyCode)
72+
}
73+
})
74+
4675
it('causes DOM to update after clickHandler method that changes components data is called', () => {
4776
const wrapper = mount(ComponentWithEvents)
4877
const toggle = wrapper.find('.toggle')

0 commit comments

Comments
 (0)