Skip to content
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

Jump to bottom

docs: comparison of functions with v1 #2175

Merged
merged 2 commits into from
Sep 5, 2023
Merged

docs: comparison of functions with v1 #2175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
122c009
docs: comparison of functions with v1
freakzlike Aug 30, 2023
3bf4097
update docs
freakzlike Aug 31, 2023
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
40 changes: 40 additions & 0 deletions docs/migration/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,3 +290,43 @@ If you use snapshot testing and comment nodes are leaking into your snapshots, n
}
```
- Via `@vue/test-utils` [`mountingOptions.global.config`](https://test-utils.vuejs.org/api/#global) either globally or on per-test basis.

## Comparison with v1

This is table for those coming from VTU 1, comparing the two APIs.

### Mounting Options

| option | notes |
|------------------|-----------------------------------------------------------------------------------|
| mocks | nested in `global` |
| propsData | now called `props` |
| provide | nested in `global` |
| mixins | nested in `global` |
| plugins | nested in `global` |
| component | nested in `global` |
| directives | nested in `global` |
| attachToDocument | renamed `attachTo`. See [here](https://github.com/vuejs/vue-test-utils/pull/1492) |
| scopedSlots | removed. ScopedSlots are merged with `slots` in Vue 3 |
| context | removed. Different from Vue 2, does not make sense anymore. |
| localVue | removed. No longer required - in Vue 3 there is no global Vue instance to mutate. |
| listeners | removed. No longer exists in Vue 3 |
| parentComponent | removed |

### Wrapper API (mount)

| method | notes |
|----------------|---------------------------------------------------------------------------------------------|
| find | only `querySelector` syntax is supported. Use `findComponent(Comp)` to find a Vue component |
| setValue | works for select, checkbox, radio button, input, textarea. Returns `nextTick`. |
| trigger | returns `nextTick`. You can do `await wrapper.find('button').trigger('click')` |
| destroy | renamed to `unmount` to match Vue 3 lifecycle hook name. |
| contains | removed. Use `find` |
| emittedByOrder | removed. Use `emitted` |
| setSelected | removed. Now part of `setValue` |
| setChecked | removed. Now part of `setValue` |
| is | removed |
| isEmpty | removed. Use matchers such as [this](https://github.com/testing-library/jest-dom#tobeempty) |
| isVueInstance | removed |
| name | removed |
| setMethods | removed |
freakzlike marked this conversation as resolved.
Show resolved Hide resolved