Interface UserEvent

packages/browser/context.d.ts:189–371

}

export interface UserEvent {
  /**
   * Creates a new user event instance. This is useful if you need to keep the
   * state of keyboard to press and release buttons correctly.
   *
   * **Note:** Unlike `@testing-library/user-event`, the default `userEvent` instance
   * from `vitest/browser` is created once, not every time its methods are called!
   * @see {@link https:class="cm">//vitest.dev/api/browser/interactivity.html#userevent-setup}
   */
  setup: () => UserEvent
  /**
   * Cleans up the user event instance, releasing any resources or state it holds,
   * such as keyboard press state. For the default `userEvent` instance, this method
   * is automatically called after each test case.
   */
  cleanup: () => Promise<void>
  /**
   * Click on an element. Uses provider's API under the hood and supports all its options.
   * @see {@link https:class="cm">//playwright.dev/docs/api/class-locator#locator-click} Playwright API
   * @see {@link https:class="cm">//webdriver.io/docs/api/element/click/} WebdriverIO API
   * @see {@link https:class="cm">//testing-library.com/docs/user-event/convenience/#click} testing-library API
   */
  click: (element: Element | Locator, options?: UserEventClickOptions) => Promise<void>
  /**
   * Triggers a double click event on an element. Uses provider's API under the hood.
   * @see {@link https:class="cm">//playwright.dev/docs/api/class-locator#locator-dblclick} Playwright API
   * @see {@link https:class="cm">//webdriver.io/docs/api/element/doubleClick/} WebdriverIO API
   * @see {@link https:class="cm">//testing-library.com/docs/user-event/convenience/#dblClick} testing-library API
   */
  dblClick: (element: Element | Locator, options?: UserEventDoubleClickOptions) => Promise<void>
  /**
   * Triggers a triple click event on an element. Uses provider's API under the hood.
   * @see {@link https:class="cm">//playwright.dev/docs/api/class-locator#locator-click} Playwright API: using `click` with `clickCount: 3`
   * @see {@link https:class="cm">//webdriver.io/docs/api/browser/actions/} WebdriverIO API: using actions api with `move` plus three `down + up + pause` events in a row
   * @see {@link https:class="cm">//testing-library.com/docs/user-event/convenience/#tripleclick} testing-library API
   */
  tripleClick: (element: Element | Locator, options?: UserEventTripleClickOptions) => Promise<void>
  /**
   * Triggers a {@link https:class="cm">//developer.mozilla.org/en-US/docs/Web/API/Element/wheel_event|`wheel` event} on an element.
   *
   * @param element - The target element to receive wheel events.
   * @param options - Scroll configuration using `delta` or `direction`.
   * @returns A promise that resolves when all wheel events have been dispatched.
   *
   * @since 4.1.0
   * @see {@link https:class="cm">//vitest.dev/api/browser/interactivity#userevent-wheel}
   *
   * @example
   * class="cm">// Scroll down by 100 pixels
   * await userEvent.wheel(container, { delta: { y: 100 } })
   *
   * @example
   * class="cm">// Scroll up 5 times
   * await userEvent.wheel(container, { direction: class="st">'up', times: 5 })
   */
  wheel(element: Element | Locator, options: UserEventWheelOptions): Promise<void>
  /**
   * Choose one or more values from a select element. Uses provider's API under the hood.