Skip to content

Commit 195449e

Browse files
committed
fix: remove preventDefault from options
fixes #211
1 parent 84749c4 commit 195449e

File tree

18 files changed

+21
-86
lines changed

18 files changed

+21
-86
lines changed

docs/en/api/wrapper/trigger.md

-7
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@ Triggers an event on the `Wrapper` DOM node.
44

55
`trigger` takes an optional `options` object. The properties in the `options` object are added to the Event.
66

7-
You can run `preventDefault` on the event by passing `preventDefault: true` in `options`.
8-
97
- **Arguments:**
108
- `{string} eventName`
119
- `{Object} options`
12-
- `{boolean} preventDefault`
1310

1411
- **Example:**
1512

@@ -30,10 +27,6 @@ wrapper.trigger('click', {
3027
button: 0
3128
})
3229

33-
wrapper.trigger('click', {
34-
preventDefault: true
35-
})
36-
3730
expect(clickHandler.called).toBe(true)
3831
```
3932
- **Setting the event target:**

docs/en/guides/dom-events.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ wrapper.find('button').trigger('click')
2222

2323
The `trigger` method takes an optional `options` object. The properties in the `options` object are added to the Event.
2424

25-
You can run `preventDefault` on the event by passing `preventDefault: true` in `options`.
25+
Note that target cannot be added in the `options` object.
2626

2727
```js
2828
const wrapper = mount(MyButton)
2929

30-
wrapper.trigger('click', { preventDefault: true })
30+
wrapper.trigger('click', { button: 0 })
3131
```
3232

3333

docs/fr/api/wrapper/trigger.md

-6
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@
44

55
`trigger` takes an optional `options` object. The properties in the `options` object are added to the Event.
66

7-
You can run `preventDefault` on the event by passing `preventDefault: true` in `options`.
87

98
- **Arguments:**
109
- `{string} eventName`
1110
- `{Object} options`
12-
- `{boolean} preventDefault`
1311

1412
- **Example:**
1513

@@ -30,9 +28,5 @@ wrapper.trigger('click', {
3028
button: 0
3129
})
3230

33-
wrapper.trigger('click', {
34-
preventDefault: true
35-
})
36-
3731
expect(clickHandler.called).toBe(true)
3832
```

docs/fr/guides/dom-events.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,10 @@ wrapper.find('button').trigger('click')
2323

2424
La méthode `trigger` prend en paramètre optionnel l'objet `options`. Les propriétés de l'objet `options` sont ajoutées à l'évènement.
2525

26-
Vous pouvez utiliser `preventDefault` sur l'évènement en passant `preventDefault: true` dans le paramètre `options`.
27-
2826
```js
2927
const wrapper = mount(MyButton)
3028

31-
wrapper.trigger('click', { preventDefault: true })
29+
wrapper.trigger('click', { button: 0 })
3230
```
3331

3432

docs/ja/api/wrapper/trigger.md

+1-8
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@
44

55
Triggerは `options` オブジェクト形式で行います。`options` オブジェクトのプロパティがイベントに追加されます。
66

7-
`options``preventDefault: true` とすることで、イベントに対して preventDefault を実行することができます。
8-
97
- **引数:**
108
- `{string} eventName`
11-
- `{Object} options`
12-
- `{boolean} preventDefault`
9+
- `{Object} options`
1310

1411
- **例:**
1512

@@ -30,10 +27,6 @@ wrapper.trigger('click', {
3027
button: 0
3128
})
3229

33-
wrapper.trigger('click', {
34-
preventDefault: true
35-
})
36-
3730
expect(clickHandler.called).toBe(true)
3831
```
3932

docs/ja/guides/dom-events.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,10 @@ wrapper.find('button').trigger('click')
2222

2323
`trigger` メソッドはオプションで `options` オブジェクトを引数として取ります。`options` オブジェクトのプロパティはイベントオブジェクトのプロパティに追加されます。
2424

25-
`preventDefault: true``options` に渡すと、 `event.preventDefault()` を実行することができます。
26-
2725
```js
2826
const wrapper = mount(MyButton)
2927

30-
wrapper.trigger('click', { preventDefault: true })
28+
wrapper.trigger('click', { button: 0 })
3129
```
3230

3331

@@ -187,7 +185,7 @@ describe('Key event tests', () => {
187185

188186
**制限事項**
189187

190-
`.` の後のキー名( `keydown.up` の場合 `up` )は `keyCode` に変換されます。以下のキー名が変換されます。
188+
`.` の後のキー名( `keydown.up` の場合 `up` )は `keyCode` に変換されます。以下のキー名が変換されます。
191189

192190
| キー名 | キーコード |
193191
| --- | --- |

docs/kr/api/wrapper/trigger.md

-7
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@
44

55
트리거는 선택적으로 `options` 객체를 가질 수 있습니다. `options` 객체의 속성이 이벤트에 추가됩니다.
66

7-
`options에 `preventDefault: true로 설정하면 preventDefault를 실행합니다.
8-
97
- **전달인자:**
108
- `{string} eventName`
119
- `{Object} options`
12-
- `{boolean} preventDefault`
1310

1411
- **예제:**
1512

@@ -30,9 +27,5 @@ wrapper.trigger('click', {
3027
button: 0
3128
})
3229

33-
wrapper.trigger('click', {
34-
preventDefault: true
35-
})
36-
3730
expect(clickHandler.called).toBe(true)
3831
```

docs/kr/guides/dom-events.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,10 @@ wrapper.find('button').trigger('click')
2222

2323
트리거 메소드는 선택적으로 `options` 객체를 가질 수 있습니다. 이 `options` 객체의 속성이 이벤트에 추가됩니다.
2424

25-
`options``preventDefault: true`를 전달하여 이벤트에서 preventDefault를 실행할 수 있습니다.
26-
2725
```js
2826
const wrapper = mount(MyButton)
2927

30-
wrapper.trigger('click', { preventDefault: true })
28+
wrapper.trigger('click', { button: 0 })
3129
```
3230

3331

docs/pt-br/api/wrapper/trigger.md

-7
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@ Aciona um evento do elemento do wrapper.
44

55
O método `trigger` usa o objeto opicional `options`, essas opções serão adicionadas ao evento.
66

7-
Você pode rodar o preventDefault em um evento passando `preventDefault: true` no objeto de `options`.
8-
97
- **Argumentos:**
108
- `{String} eventName`
119
- `{Object} options`
12-
- `{Boolean} preventDefault`
1310

1411
- **Exemplo:**
1512

@@ -30,9 +27,5 @@ wrapper.trigger('click', {
3027
botao: 0
3128
})
3229

33-
wrapper.trigger('click', {
34-
preventDefault: true
35-
})
36-
3730
expect(clickHandler.called).toBe(true)
3831
```

docs/pt-br/guides/dom-events.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,10 @@ wrapper.find('button').trigger('click')
2222

2323
O método `trigger` pode receber um objeto `options` opcional. As propriedades no objeto `options` serão adicionadas no evento.
2424

25-
Você pode executar `preventDefault` no evento passando `preventDefault: true` no objeto `options`:
26-
2725
```js
2826
const wrapper = mount(MeuBotao)
2927

30-
wrapper.trigger('click', { preventDefault: true })
28+
wrapper.trigger('click', { button: 0 })
3129
```
3230

3331
## Exemplo de clique no mouse

docs/ru/api/wrapper/trigger.md

-7
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@
44

55
В `trigger` также можно передать опциональный объект `options`. Свойства объекта `options` будут добавлены к Event.
66

7-
Вы можете вызвать `preventDefault` на событие передав `preventDefault: true` в `options`.
8-
97
- **Принимает:**
108
- `{string} eventName`
119
- `{Object} options`
12-
- `{boolean} preventDefault`
1310

1411
- **Пример:**
1512

@@ -30,9 +27,5 @@ wrapper.trigger('click', {
3027
button: 0
3128
})
3229

33-
wrapper.trigger('click', {
34-
preventDefault: true
35-
})
36-
3730
expect(clickHandler.called).toBe(true)
3831
```

docs/ru/guides/dom-events.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,10 @@ wrapper.find('button').trigger('click')
2222

2323
Метод `trigger` также может опционально принимать объект `options`. Свойства объекта `options` добавятся к Event.
2424

25-
Вы можете запустить `preventDefault` для события, передав `preventDefault: true` в `options`.
26-
2725
```js
2826
const wrapper = mount(MyButton)
2927

30-
wrapper.trigger('click', { preventDefault: true })
28+
wrapper.trigger('click', { button: 0 })
3129
```
3230

3331

@@ -193,4 +191,4 @@ describe('Тестирование событий клавиш', () => {
193191

194192
## Важно
195193

196-
`vue-test-utils` генерирует событие синхронно. Следовательно, `Vue.nextTick` не требуется.
194+
`vue-test-utils` генерирует событие синхронно. Следовательно, `Vue.nextTick` не требуется.

docs/zh-cn/api/wrapper/trigger.md

-7
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@
44

55
`trigger` 带有一个可选的 `options` 对象。`options` 对象内的属性会被添加到事件上。
66

7-
你可以通过在 `options` 里传入 `preventDefault: true` 来运行事件上的 `preventDefault`
8-
97
- **参数:**
108
- `{string} eventName`
119
- `{Object} options`
12-
- `{boolean} preventDefault`
1310

1411
- **示例:**
1512

@@ -30,9 +27,5 @@ wrapper.trigger('click', {
3027
button: 0
3128
})
3229

33-
wrapper.trigger('click', {
34-
preventDefault: true
35-
})
36-
3730
expect(clickHandler.called).toBe(true)
3831
```

docs/zh-cn/guides/dom-events.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,11 @@ wrapper.find('button').trigger('click')
2222

2323
`trigger` 方法接受一个可选的 `options` 对象。这个 `options` 对象里的属性会被添加到事件中。
2424

25-
你可以通过在 `options` 里传入 `preventDefault: true` 来运行事件上的 `preventDefault`
2625

2726
```js
2827
const wrapper = mount(MyButton)
2928

30-
wrapper.trigger('click', { preventDefault: true })
29+
wrapper.trigger('click', { button: 0 })
3130
```
3231

3332

package-lock.json

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/wrappers/wrapper.js

-4
Original file line numberDiff line numberDiff line change
@@ -568,10 +568,6 @@ export default class Wrapper implements BaseWrapper {
568568
eventObject.initEvent(event[0], true, true)
569569
}
570570

571-
if (options && options.preventDefault) {
572-
eventObject.preventDefault()
573-
}
574-
575571
if (options) {
576572
Object.keys(options).forEach(key => {
577573
// $FlowIgnore

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

+6-8
Original file line numberDiff line numberDiff line change
@@ -93,14 +93,12 @@ describe('trigger', () => {
9393
expect(clickHandler.calledOnce).to.equal(true)
9494
})
9595

96-
it('prevents default on event when pass preventDefault as true', () => {
97-
const wrapper = mount(ComponentWithEvents)
98-
const button = wrapper.find('.left-click')
99-
button.trigger('mousedown', {
100-
preventDefault: true,
101-
button: 0
102-
})
103-
expect(info.calledWith(true)).to.equal(true)
96+
it('handles .prevent', () => {
97+
const TestComponent = {
98+
template: '<input @keydown.enter.prevent="enter">'
99+
}
100+
const wrapper = mount(TestComponent)
101+
wrapper.trigger('keydown')
104102
})
105103

106104
it('throws error if options contains a target value', () => {

types/test/wrapper.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ wrapper.setData({ foo: 'bar' })
3535
wrapper.setMethods({checked: true})
3636
wrapper.setProps({ checked: true })
3737
wrapper.trigger('mousedown.enter', {
38-
preventDefault: true
38+
button: 0
3939
})
4040

4141
/**

0 commit comments

Comments
 (0)