mirror of
https://github.com/vitest-dev/vitest.git
synced 2025-12-08 18:26:03 +00:00
88 lines
2.7 KiB
Markdown
88 lines
2.7 KiB
Markdown
---
|
|
title: Context | Browser Mode
|
|
---
|
|
|
|
# Context
|
|
|
|
Vitest exposes a context module via `@vitest/browser/context` entry point. As of 2.0, it exposes a small set of utilities that might be useful to you in tests.
|
|
|
|
```ts
|
|
export const server: {
|
|
/**
|
|
* Platform the Vitest server is running on.
|
|
* The same as calling `process.platform` on the server.
|
|
*/
|
|
platform: Platform
|
|
/**
|
|
* Runtime version of the Vitest server.
|
|
* The same as calling `process.version` on the server.
|
|
*/
|
|
version: string
|
|
/**
|
|
* Name of the browser provider.
|
|
*/
|
|
provider: string
|
|
/**
|
|
* Name of the current browser.
|
|
*/
|
|
browser: string
|
|
/**
|
|
* Available commands for the browser.
|
|
*/
|
|
commands: BrowserCommands
|
|
}
|
|
|
|
/**
|
|
* Handler for user interactions. The support is implemented by the browser provider (`playwright` or `webdriverio`).
|
|
* If used with `preview` provider, fallbacks to simulated events via `@testing-library/user-event`.
|
|
* @experimental
|
|
*/
|
|
export const userEvent: {
|
|
setup: () => UserEvent
|
|
click: (element: Element, options?: UserEventClickOptions) => Promise<void>
|
|
dblClick: (element: Element, options?: UserEventDoubleClickOptions) => Promise<void>
|
|
tripleClick: (element: Element, options?: UserEventTripleClickOptions) => Promise<void>
|
|
selectOptions: (
|
|
element: Element,
|
|
values: HTMLElement | HTMLElement[] | string | string[],
|
|
options?: UserEventSelectOptions,
|
|
) => Promise<void>
|
|
keyboard: (text: string) => Promise<void>
|
|
type: (element: Element, text: string, options?: UserEventTypeOptions) => Promise<void>
|
|
clear: (element: Element) => Promise<void>
|
|
tab: (options?: UserEventTabOptions) => Promise<void>
|
|
hover: (element: Element, options?: UserEventHoverOptions) => Promise<void>
|
|
unhover: (element: Element, options?: UserEventHoverOptions) => Promise<void>
|
|
fill: (element: Element, text: string, options?: UserEventFillOptions) => Promise<void>
|
|
dragAndDrop: (source: Element, target: Element, options?: UserEventDragAndDropOptions) => Promise<void>
|
|
}
|
|
|
|
/**
|
|
* Available commands for the browser.
|
|
* A shortcut to `server.commands`.
|
|
*/
|
|
export const commands: BrowserCommands
|
|
|
|
export const page: {
|
|
/**
|
|
* Serialized test config.
|
|
*/
|
|
config: SerializedConfig
|
|
/**
|
|
* Change the size of iframe's viewport.
|
|
*/
|
|
viewport(width: number, height: number): Promise<void>
|
|
/**
|
|
* Make a screenshot of the test iframe or a specific element.
|
|
* @returns Path to the screenshot file or path and base64.
|
|
*/
|
|
screenshot(options: Omit<ScreenshotOptions, 'base64'> & { base64: true }): Promise<{
|
|
path: string
|
|
base64: string
|
|
}>
|
|
screenshot(options?: ScreenshotOptions): Promise<string>
|
|
}
|
|
|
|
export const cdp: () => CDPSession
|
|
```
|