Skip to content

Commit 53f4858

Browse files
committed
docs: remove wrapper section from README
Keep detailed wrapper documentation in the canonical vitest.dev docs.
1 parent aa65bc7 commit 53f4858

1 file changed

Lines changed: 0 additions & 42 deletions

File tree

README.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -70,48 +70,6 @@ config.global.mocks = {
7070
}
7171
```
7272

73-
### Wrapper
74-
75-
Pass a Vue component as the `wrapper` option to render it around the component under test. The wrapper must expose a default slot. This is useful for reusable provider setup (for example `UApp`, `ElConfigProvider`, or your own context providers).
76-
77-
Per-render `wrapper` takes precedence over the value set via `configureRender`.
78-
79-
```ts
80-
import { render } from 'vitest-browser-vue'
81-
import { ThemeProvider } from 'my-ui-lib'
82-
83-
const screen = await render(MyComponent, {
84-
wrapper: ThemeProvider,
85-
props: {
86-
title: 'Hello',
87-
},
88-
})
89-
90-
await screen.rerender({ title: 'Updated' })
91-
```
92-
93-
You can also configure a default wrapper globally in your Vitest setup file:
94-
95-
```ts
96-
import { configureRender } from 'vitest-browser-vue/pure'
97-
import { ThemeProvider } from 'my-ui-lib'
98-
99-
configureRender({
100-
wrapper: ThemeProvider,
101-
})
102-
```
103-
104-
When using a global wrapper in tests, reset it in `afterEach` to avoid leaking configuration across test files:
105-
106-
```ts
107-
import { afterEach } from 'vitest'
108-
import { configureRender } from 'vitest-browser-vue/pure'
109-
110-
afterEach(() => {
111-
configureRender({ wrapper: undefined })
112-
})
113-
```
114-
11573
## Special thanks
11674

11775
- Powered by [`@vue/test-utils`](https://github.com/vuejs/test-utils/)

0 commit comments

Comments
 (0)