This is documentation for the next version of Grafana k6 documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/browserbreadcrumb arrow Pagebreadcrumb arrow dispatchEvent(selector, type, eventInit[, options])
Open source

dispatchEvent(selector, type, eventInit[, options])

Warning

Use locator-based locator.dispatchEvent(type, eventInit[, options]) instead.

Dispatches HTML DOM event types e.g. 'click'.

ParameterTypeDefaultsDescription
selectorstring''A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
typestring''DOM event type e.g. 'click'.
eventInitobjectnullOptional event specific properties. See eventInit for more details.
optionsobjectnull
options.strictbooleanfalseWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
options.timeoutnumber30000Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on BrowserContext or Page.

eventInit

Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:

Returns

TypeDescription
Promise<void>A Promise that fulfills when the event is dispatched.

Example

JavaScript 
import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  await page.goto('https://test.k6.io/browser.php');
  await page.dispatchEvent('#counter-button', 'click');
}