Skip to content

docs(Vue Testing Library): update @vue/test-utils link urls in api page to vue3 #1501

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.

Sign up for GitHub

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 4 commits into from
Sep 6, 2025
+9 −10
Merged

docs(Vue Testing Library): update @vue/test-utils link urls in api page to vue3 #1501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f5ec431
docs(Vue Testing Library): update `@vue/test-utils` link urls in api …
ytak-sagit Sep 3, 2025
7c31536
docs(Vue Testing Library): update `@vue/test-utils` link urls in faq …
ytak-sagit Sep 6, 2025
5537ca5
docs(Vue Testing Library): update stubs-example link branch name from…
ytak-sagit Sep 6, 2025
5de7aff
docs(Vue Testing Library): update stubs key name to `global.stubs` in…
ytak-sagit Sep 6, 2025
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
11 changes: 5 additions & 6 deletions docs/vue-testing-library/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The valid Vue Component to be tested.
#### Options

An object containing additional information to be passed to `@vue/test-utils`
[mount](https://vue-test-utils.vuejs.org/api/options.html#mounting-options).
[mount](https://test-utils.vuejs.org/api/#mount).

Additionally, the following options can also be provided:

Expand Down Expand Up @@ -171,22 +171,21 @@ This is a simple wrapper around `prettyDOM` which is also exposed and comes from
#### `unmount()`

An alias for `@vue/test-utils`
[destroy](https://vue-test-utils.vuejs.org/api/wrapper/#destroy).
[unmount](https://test-utils.vuejs.org/api/#unmount).

#### `html()`

An alias for `@vue/test-utils`
[html](https://vue-test-utils.vuejs.org/api/wrapper/#html).
An alias for `@vue/test-utils` [html](https://test-utils.vuejs.org/api/#html).

#### `emitted()`

An alias for `@vue/test-utils`
[emitted](https://vue-test-utils.vuejs.org/api/wrapper/#emitted).
[emitted](https://test-utils.vuejs.org/api/#emitted).

#### `rerender(props)`

An alias for `@vue/test-utils`
[setProps](https://test-utils.vuejs.org/api/#setprops).
[setProps](https://test-utils.vuejs.org/api/#setProps).

It returns a Promise through so you can `await rerender(...)`.

Expand Down
8 changes: 4 additions & 4 deletions docs/vue-testing-library/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ In general, you should avoid mocking out components (see

However if you need to, you can either use Jest's
[mocking feature](https://facebook.github.io/jest/docs/en/manual-mocks.html) or
the [`stubs`][stubs] key provided by @vue/test-utils.
the [`global.stubs`][stubs] key provided by @vue/test-utils.

```js
import {render} from '@testing-library/vue'
Expand Down Expand Up @@ -156,8 +156,8 @@ Links:
<!-- prettier-ignore-start -->

[vue-test-utils]: https://github.com/vuejs/vue-test-utils
[mount]: https://vue-test-utils.vuejs.org/api/#mount
[stubs]: https://vue-test-utils.vuejs.org/api/options.html#stubs
[stubs-example]: https://github.com/testing-library/vue-testing-library/blob/master/src/__tests__/stubs.js
[mount]: https://test-utils.vuejs.org/api/#mount
[stubs]: https://test-utils.vuejs.org/api/#global-stubs
[stubs-example]: https://github.com/testing-library/vue-testing-library/blob/main/src/__tests__/stubs.js

<!-- prettier-ignore-end -->