Skip to content

Commit ef5bc3c

Browse files
eddyerburghkazupon
authored andcommitted
docs: remove sync mode from docs (#1142)
* docs: remove sync mode * docs: remove TransitionGroupStub and TransitionStub pages * refactor: remove dist dir * docs: tweak
1 parent b05c9d0 commit ef5bc3c

38 files changed

+5
-382
lines changed

docs/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ Vue Test Utils is the official unit testing utility library for Vue.js.
3232
- [listeners](api/options.md#listeners)
3333
- [parentComponent](api/options.md#parentComponent)
3434
- [provide](api/options.md#provide)
35-
- [sync](api/options.md#sync)
3635
- [other options](api/options.md#other-options)
3736
- [Wrapper](api/wrapper/)
3837
- [attributes](api/wrapper/attributes.md)
@@ -76,8 +75,6 @@ Vue Test Utils is the official unit testing utility library for Vue.js.
7675
- [trigger](api/wrapper-array/trigger.md)
7776
- [isVisible](api/wrapper-array/isVisible.md)
7877
- [components](api/components/)
79-
- [TransitionStub](api/components/TransitionStub.md)
80-
- [TransitionGroupStub](api/components/TransitionGroupStub.md)
8178
- [RouterLinkStub](api/components/RouterLinkStub.md)
8279
- [Selectors](api/selectors.md)
8380
- [createWrapper](api/createWrapper.md)

docs/api/components/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@
33
Vue Test Utils includes utility components you can use to stub components.
44

55
!!!include(docs/api/components/RouterLinkStub.md)!!!
6-
!!!include(docs/api/components/TransitionStub.md)!!!
7-
!!!include(docs/api/components/TransitionGroupStub.md)!!!

docs/api/components/TransitionGroupStub.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/api/components/TransitionStub.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/api/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Vue Test Utils includes a config object to defined options used by Vue Test Util
77
### `stubs`
88

99
- type: `{ [name: string]: Component | boolean | string }`
10-
- default: `{ transition: TransitionStub, 'transition-group': TransitionGroupStub }`
10+
- default: `{}`
1111

1212
The stub stored in `config.stubs` is used by default.
1313
Stubs to use in components. These are overwritten by `stubs` passed in the mounting options.

docs/api/createWrapper.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
- `{vm|HTMLElement} node`
66
- `{Object} options`
7-
- `{Boolean} sync`
87
- `{Boolean} attachedToDocument`
98

109
- **Returns:**

docs/api/options.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ These options will be merged with the component's existing options when mounted
2121
- [`listeners`](#listeners)
2222
- [`parentComponent`](#parentcomponent)
2323
- [`provide`](#provide)
24-
- [`sync`](#sync)
2524

2625
## context
2726

@@ -290,14 +289,6 @@ const wrapper = shallowMount(Component, {
290289
expect(wrapper.text()).toBe('fooValue')
291290
```
292291

293-
## sync
294-
295-
- type: `boolean`
296-
- default: `true`
297-
298-
When `sync` is `true`, the Vue component is rendered synchronously.
299-
When `sync` is `false`, the Vue component is rendered asynchronously.
300-
301292
## Other options
302293

303294
When the options for `mount` and `shallowMount` contain the options other than the mounting options, the component options are overwritten with those using [extends](https://vuejs.org/v2/api/#extends).

docs/api/wrapper/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@ A `Wrapper` is an object that contains a mounted component or vnode and methods
2020

2121
`Boolean` (read-only): True if component is attached to document when rendered.
2222

23-
#### `options.sync`
24-
25-
`Boolean` (read-only): True if `sync` in mounting options was not `false`
26-
2723
## Methods
2824

2925
!!!include(docs/api/wrapper/attributes.md)!!!

docs/ja/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232
- [listeners](api/options.md#listeners)
3333
- [parentComponent](api/options.md#parentcomponent)
3434
- [provide](api/options.md#provide)
35-
- [sync](api/options.md#sync)
3635
- [その他のオプション](api/options.md#その他のオプション)
3736
- [Wrapper](api/wrapper/)
3837
- [attributes](api/wrapper/attributes.md)
@@ -76,8 +75,6 @@
7675
- [trigger](api/wrapper-array/trigger.md)
7776
- [isVisible](api/wrapper-array/isVisible.md)
7877
- [コンポーネント](api/components/)
79-
- [TransitionStub](api/components/TransitionStub.md)
80-
- [TransitionGroupStub](api/components/TransitionGroupStub.md)
8178
- [RouterLinkStub](api/components/RouterLinkStub.md)
8279
- [セレクタ](api/selectors.md)
8380
- [createWrapper](api/createWrapper.md)

docs/ja/api/components/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@
33
vue-test-utils にはコンポーネントをスタブするためのユーティリティコンポーネントがあります。
44

55
!!!include(docs/ja/api/components/RouterLinkStub.md)!!!
6-
!!!include(docs/ja/api/components/TransitionStub.md)!!!
7-
!!!include(docs/ja/api/components/TransitionGroupStub.md)!!!

0 commit comments

Comments
 (0)