Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/k6/latest/using-k6-browser/playwright-apis-in-k6.md, or by sending Accept: text/markdown to https://grafana.com/docs/k6/latest/using-k6-browser/playwright-apis-in-k6/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Playwright APIs in k6
The following table shows which Playwright APIs are implemented in k6. k6 tries to match Playwright’s API behavior and signature exactly, but some differences may exist. For more details, refer to the individual API documentation page.
The status column has three different options:
| Status | Description |
|---|---|
| π© | Implemented in k6 Browser |
| π₯ | Not implemented in k6 Browser |
| π§ | k6 Browser only |
Note
If k6 is missing an API from Playwright that you need for your test, you can open an issue in the k6 GitHub repository.
| Object | Method | Status | Alternate |
|---|---|---|---|
| Browser | addListener | π₯ | None |
| Browser | browserType | π₯ | None |
| Browser | close | π© | Only on browsers returned by chromium.connectOverCDP |
| Browser | closeContext | π§ | - |
| Browser | context | π§ | - |
| Browser | contexts | π₯ | browser.context |
| Browser | isConnected | π© | - |
| Browser | newBrowserCDPSession | π₯ | None |
| Browser | newContext | π© | - |
| Browser | newPage | π© | - |
| Browser | off | π₯ | None |
| Browser | on | π₯ | page.on |
| Browser | once | π₯ | None |
| Browser | prependListener | π₯ | None |
| Browser | removeAllListeners | π₯ | None |
| Browser | removeListener | π₯ | None |
| Browser | startTracing | π₯ | None |
| Browser | stopTracing | π₯ | None |
| Browser | userAgent | π© | - |
| Browser | version | π© | - |
| BrowserContext | addCookies | π© | - |
| BrowserContext | addInitScript | π© | - |
| BrowserContext | addListener | π₯ | None |
| BrowserContext | backgroundPages | π₯ | None |
| BrowserContext | browser | π© | - |
| BrowserContext | clearCookies | π© | - |
| BrowserContext | clearPermissions | π© | - |
| BrowserContext | close | π© | - |
| BrowserContext | cookies | π© | - |
| BrowserContext | exposeBinding | π₯ | None |
| BrowserContext | exposeFunction | π₯ | None |
| BrowserContext | grantPermissions | π© | - |
| BrowserContext | newCDPSession | π₯ | None |
| BrowserContext | newPage | π© | - |
| BrowserContext | off | π₯ | None |
| BrowserContext | on | π₯ | page.on |
| BrowserContext | once | π₯ | None |
| BrowserContext | pages | π© | - |
| BrowserContext | prependListener | π₯ | None |
| BrowserContext | removeAllListeners | π₯ | None |
| BrowserContext | removeListener | π₯ | None |
| BrowserContext | route | π₯ | page.route |
| BrowserContext | routeFromHAR | π₯ | None |
| BrowserContext | routeWebSocket | π₯ | None |
| BrowserContext | serviceWorkers | π₯ | None |
| BrowserContext | setDefaultNavigationTimeout | π© | - |
| BrowserContext | setDefaultTimeout | π© | - |
| BrowserContext | setExtraHTTPHeaders | π₯ | page.setExtraHTTPHeaders |
| BrowserContext | setGeolocation | π© | - |
| BrowserContext | setHTTPCredentials | π₯ | None |
| BrowserContext | setOffline | π© | - |
| BrowserContext | storageState | π₯ | None |
| BrowserContext | unroute | π₯ | page.unroute |
| BrowserContext | unrouteAll | π₯ | page.unrouteAll |
| BrowserContext | waitForEvent | π© | - |
| BrowserType | connectOverCDP | π© | - |
| ConsoleMessage | args | π© | - |
| ConsoleMessage | location | π₯ | None |
| ConsoleMessage | page | π© | - |
| ConsoleMessage | text | π© | - |
| ConsoleMessage | type | π© | - |
| Dialog | accept | π₯ | None |
| Dialog | defaultValue | π₯ | None |
| Dialog | dismiss | π₯ | None |
| Dialog | message | π₯ | None |
| Dialog | page | π₯ | None |
| Dialog | type | π₯ | None |
| Download | cancel | π₯ | None |
| Download | createReadStream | π₯ | None |
| Download | delete | π₯ | None |
| Download | failure | π₯ | None |
| Download | page | π₯ | None |
| Download | path | π₯ | None |
| Download | saveAs | π₯ | None |
| Download | suggestedFilename | π₯ | None |
| Download | url | π₯ | None |
| ElementHandle | $ | π© | - |
| ElementHandle | $$ | π© | - |
| ElementHandle | $$eval | π₯ | None |
| ElementHandle | $eval | π₯ | None |
| ElementHandle | asElement | π© | - |
| ElementHandle | boundingBox | π© | - |
| ElementHandle | check | π© | - |
| ElementHandle | click | π© | - |
| ElementHandle | contentFrame | π© | - |
| ElementHandle | dblclick | π© | - |
| ElementHandle | dispatchEvent | π© | - |
| ElementHandle | dispose | π© | - |
| ElementHandle | evaluate | π© | - |
| ElementHandle | evaluateHandle | π© | - |
| ElementHandle | fill | π© | - |
| ElementHandle | focus | π© | - |
| ElementHandle | getAttribute | π© | - |
| ElementHandle | getProperties | π© | - |
| ElementHandle | getProperty | π₯ | elementHandle.getProperties |
| ElementHandle | hover | π© | - |
| ElementHandle | innerHTML | π© | - |
| ElementHandle | innerText | π© | - |
| ElementHandle | inputValue | π© | - |
| ElementHandle | isChecked | π© | - |
| ElementHandle | isDisabled | π© | - |
| ElementHandle | isEditable | π© | - |
| ElementHandle | isEnabled | π© | - |
| ElementHandle | isHidden | π© | - |
| ElementHandle | isVisible | π© | - |
| ElementHandle | jsonValue | π© | - |
| ElementHandle | ownerFrame | π© | - |
| ElementHandle | press | π© | - |
| ElementHandle | screenshot | π© | - |
| ElementHandle | scrollIntoViewIfNeeded | π© | - |
| ElementHandle | selectOption | π© | - |
| ElementHandle | selectText | π© | - |
| ElementHandle | setChecked | π© | - |
| ElementHandle | setInputFiles | π© | - |
| ElementHandle | tap | π© | - |
| ElementHandle | textContent | π© | - |
| ElementHandle | type | π© | - |
| ElementHandle | uncheck | π© | - |
| ElementHandle | waitForElementState | π© | - |
| ElementHandle | waitForSelector | π© | - |
| FileChooser | element | π₯ | None |
| FileChooser | isMultiple | π₯ | None |
| FileChooser | page | π₯ | None |
| FileChooser | setFiles | π₯ | None |
| Frame | $ | π© | - |
| Frame | $$ | π© | - |
| Frame | $$eval | π₯ | None |
| Frame | $eval | π₯ | None |
| Frame | addScriptTag | π₯ | None |
| Frame | addStyleTag | π₯ | None |
| Frame | check | π© | - |
| Frame | childFrames | π© | - |
| Frame | click | π© | - |
| Frame | content | π© | - |
| Frame | dblclick | π© | - |
| Frame | dispatchEvent | π© | - |
| Frame | dragAndDrop | π₯ | None |
| Frame | evaluate | π© | - |
| Frame | evaluateHandle | π© | - |
| Frame | fill | π© | - |
| Frame | focus | π© | - |
| Frame | frameElement | π© | - |
| Frame | frameLocator | π© | - |
| Frame | getAttribute | π© | - |
| Frame | getByAltText | π© | - |
| Frame | getByLabel | π© | - |
| Frame | getByPlaceholder | π© | - |
| Frame | getByRole | π© | - |
| Frame | getByTestId | π© | - |
| Frame | getByText | π© | - |
| Frame | getByTitle | π© | - |
| Frame | goto | π© | - |
| Frame | hover | π© | - |
| Frame | innerHTML | π© | - |
| Frame | innerText | π© | - |
| Frame | inputValue | π© | - |
| Frame | isChecked | π© | - |
| Frame | isDetached | π© | - |
| Frame | isDisabled | π© | - |
| Frame | isEditable | π© | - |
| Frame | isEnabled | π© | - |
| Frame | isHidden | π© | - |
| Frame | isVisible | π© | - |
| Frame | locator | π© | - |
| Frame | name | π© | - |
| Frame | page | π© | - |
| Frame | parentFrame | π© | - |
| Frame | press | π© | - |
| Frame | selectOption | π© | - |
| Frame | setChecked | π© | - |
| Frame | setContent | π© | - |
| Frame | setInputFiles | π© | - |
| Frame | tap | π© | - |
| Frame | textContent | π© | - |
| Frame | title | π© | - |
| Frame | type | π© | - |
| Frame | uncheck | π© | - |
| Frame | url | π© | - |
| Frame | waitForFunction | π© | - |
| Frame | waitForLoadState | π© | - |
| Frame | waitForNavigation | π© | - |
| Frame | waitForSelector | π© | - |
| Frame | waitForTimeout | π© | - |
| Frame | waitForURL | π© | - |
| FrameLocator | first | π₯ | None |
| FrameLocator | frameLocator | π© | - |
| FrameLocator | getByAltText | π© | - |
| FrameLocator | getByLabel | π© | - |
| FrameLocator | getByPlaceholder | π© | - |
| FrameLocator | getByRole | π© | - |
| FrameLocator | getByTestId | π© | - |
| FrameLocator | getByText | π© | - |
| FrameLocator | getByTitle | π© | - |
| FrameLocator | last | π₯ | None |
| FrameLocator | locator | π© | - |
| FrameLocator | nth | π₯ | None |
| FrameLocator | owner | π₯ | None |
| JSHandle | asElement | π© | - |
| JSHandle | dispose | π© | - |
| JSHandle | evaluate | π© | - |
| JSHandle | evaluateHandle | π© | - |
| JSHandle | getProperties | π© | - |
| JSHandle | getProperty | π₯ | jsHandle.getProperties |
| JSHandle | jsonValue | π© | - |
| Keyboard | down | π© | - |
| Keyboard | insertText | π© | - |
| Keyboard | press | π© | - |
| Keyboard | type | π© | - |
| Keyboard | up | π© | - |
| Locator | all | π© | - |
| Locator | allInnerTexts | π₯ | None |
| Locator | allTextContents | π₯ | None |
| Locator | and | π₯ | None |
| Locator | ariaSnapshot | π₯ | None |
| Locator | blur | π₯ | None |
| Locator | boundingBox | π© | - |
| Locator | check | π© | - |
| Locator | clear | π© | - |
| Locator | click | π© | - |
| Locator | contentFrame | π© | - |
| Locator | count | π© | - |
| Locator | dblclick | π© | - |
| Locator | dispatchEvent | π© | - |
| Locator | dragTo | π₯ | None |
| Locator | elementHandle | π₯ | None |
| Locator | elementHandles | π₯ | None |
| Locator | evaluate | π© | - |
| Locator | evaluateAll | π₯ | None |
| Locator | evaluateHandle | π© | - |
| Locator | fill | π© | - |
| Locator | filter | π© | - |
| Locator | first | π© | - |
| Locator | focus | π© | - |
| Locator | frameLocator | π© | - |
| Locator | getAttribute | π© | - |
| Locator | getByAltText | π© | - |
| Locator | getByLabel | π© | - |
| Locator | getByPlaceholder | π© | - |
| Locator | getByRole | π© | - |
| Locator | getByTestId | π© | - |
| Locator | getByText | π© | - |
| Locator | getByTitle | π© | - |
| Locator | highlight | π₯ | None |
| Locator | hover | π© | - |
| Locator | innerHTML | π© | - |
| Locator | innerText | π© | - |
| Locator | inputValue | π© | - |
| Locator | isChecked | π© | - |
| Locator | isDisabled | π© | - |
| Locator | isEditable | π© | - |
| Locator | isEnabled | π© | - |
| Locator | isHidden | π© | - |
| Locator | isVisible | π© | - |
| Locator | last | π© | - |
| Locator | locator | π© | - |
| Locator | nth | π© | - |
| Locator | or | π₯ | None |
| Locator | page | π₯ | None |
| Locator | press | π© | - |
| Locator | pressSequentially | π₯ | None |
| Locator | screenshot | π₯ | None |
| Locator | scrollIntoViewIfNeeded | π₯ | None |
| Locator | selectOption | π© | - |
| Locator | selectText | π₯ | None |
| Locator | setChecked | π© | - |
| Locator | setInputFiles | π₯ | None |
| Locator | tap | π© | - |
| Locator | textContent | π© | - |
| Locator | type | π© | - |
| Locator | uncheck | π© | - |
| Locator | waitFor | π© | - |
| Mouse | click | π© | - |
| Mouse | dblclick | π© | - |
| Mouse | down | π© | - |
| Mouse | move | π© | - |
| Mouse | up | π© | - |
| Mouse | wheel | π₯ | None |
| Page | $ | π© | - |
| Page | $$ | π© | - |
| Page | $$eval | π₯ | None |
| Page | $eval | π₯ | None |
| Page | addInitScript | π₯ | browserContext.addInitScript |
| Page | addListener | π₯ | None |
| Page | addLocatorHandler | π₯ | None |
| Page | addScriptTag | π₯ | None |
| Page | addStyleTag | π₯ | None |
| Page | bringToFront | π© | - |
| Page | check | π© | - |
| Page | click | π© | - |
| Page | close | π© | - |
| Page | content | π© | - |
| Page | context | π© | - |
| Page | dblclick | π© | - |
| Page | dispatchEvent | π© | - |
| Page | dragAndDrop | π₯ | None |
| Page | emulateMedia | π© | - |
| Page | emulateVisionDeficiency | π§ | - |
| Page | evaluate | π© | - |
| Page | evaluateHandle | π© | - |
| Page | exposeBinding | π₯ | None |
| Page | exposeFunction | π₯ | None |
| Page | fill | π© | - |
| Page | focus | π© | - |
| Page | frame | π₯ | None |
| Page | frameLocator | π© | - |
| Page | frames | π© | - |
| Page | getAttribute | π© | - |
| Page | getByAltText | π© | - |
| Page | getByLabel | π© | - |
| Page | getByPlaceholder | π© | - |
| Page | getByRole | π© | - |
| Page | getByTestId | π© | - |
| Page | getByText | π© | - |
| Page | getByTitle | π© | - |
| Page | goBack | π₯ | None |
| Page | goForward | π₯ | None |
| Page | goto | π© | - |
| Page | hover | π© | - |
| Page | innerHTML | π© | - |
| Page | innerText | π© | - |
| Page | inputValue | π© | - |
| Page | isChecked | π© | - |
| Page | isClosed | π© | - |
| Page | isDisabled | π© | - |
| Page | isEditable | π© | - |
| Page | isEnabled | π© | - |
| Page | isHidden | π© | - |
| Page | isVisible | π© | - |
| Page | locator | π© | - |
| Page | mainFrame | π© | - |
| Page | off | π₯ | None |
| Page | on | π© | - |
| Page | once | π₯ | None |
| Page | opener | π© | - |
| Page | pause | π₯ | None |
| Page | π₯ | None | |
| Page | prependListener | π₯ | None |
| Page | press | π© | - |
| Page | reload | π© | - |
| Page | removeAllListeners | π₯ | None |
| Page | removeListener | π₯ | None |
| Page | removeLocatorHandler | π₯ | None |
| Page | requestGC | π₯ | None |
| Page | route | π© | - |
| Page | routeFromHAR | π₯ | None |
| Page | routeWebSocket | π₯ | None |
| Page | screenshot | π© | - |
| Page | selectOption | π© | - |
| Page | setChecked | π© | - |
| Page | setContent | π© | - |
| Page | setDefaultNavigationTimeout | π© | - |
| Page | setDefaultTimeout | π© | - |
| Page | setExtraHTTPHeaders | π© | - |
| Page | setInputFiles | π© | - |
| Page | setViewportSize | π© | - |
| Page | tap | π© | - |
| Page | textContent | π© | - |
| Page | throttleCPU | π§ | - |
| Page | throttleNetwork | π§ | - |
| Page | title | π© | - |
| Page | type | π© | - |
| Page | uncheck | π© | - |
| Page | unroute | π© | - |
| Page | unrouteAll | π© | - |
| Page | url | π© | - |
| Page | video | π₯ | None |
| Page | viewportSize | π© | - |
| Page | waitForEvent | π₯ | None |
| Page | waitForFunction | π© | - |
| Page | waitForLoadState | π© | - |
| Page | waitForNavigation | π© | - |
| Page | waitForRequest | π© | - |
| Page | waitForResponse | π© | - |
| Page | waitForSelector | π© | - |
| Page | waitForTimeout | π© | - |
| Page | waitForURL | π© | - |
| Page | workers | π© | - |
| Request | allHeaders | π© | - |
| Request | failure | π₯ | None |
| Request | frame | π© | - |
| Request | headerValue | π© | - |
| Request | headers | π© | - |
| Request | headersArray | π© | - |
| Request | isNavigationRequest | π© | - |
| Request | method | π© | - |
| Request | postData | π© | - |
| Request | postDataBuffer | π© | - |
| Request | postDataJSON | π₯ | None |
| Request | redirectedFrom | π₯ | None |
| Request | redirectedTo | π₯ | None |
| Request | resourceType | π© | - |
| Request | response | π© | - |
| Request | serviceWorker | π₯ | None |
| Request | size | π§ | - |
| Request | sizes | π₯ | request.size |
| Request | timing | π© | - |
| Request | url | π© | - |
| Response | allHeaders | π© | - |
| Response | body | π© | - |
| Response | finished | π₯ | None |
| Response | frame | π© | - |
| Response | fromServiceWorker | π₯ | None |
| Response | headerValue | π© | - |
| Response | headerValues | π© | - |
| Response | headers | π© | - |
| Response | headersArray | π© | - |
| Response | json | π© | - |
| Response | ok | π© | - |
| Response | request | π© | - |
| Response | securityDetails | π© | - |
| Response | serverAddr | π© | - |
| Response | size | π§ | - |
| Response | status | π© | - |
| Response | statusText | π© | - |
| Response | text | π₯ | None |
| Response | url | π© | - |
| Route | abort | π© | - |
| Route | continue | π© | - |
| Route | fallback | π₯ | None |
| Route | fetch | π₯ | None |
| Route | fulfill | π© | - |
| Route | request | π© | - |
| Touchscreen | tap | π© | - |
| Worker | addListener | π₯ | None |
| Worker | evaluate | π₯ | None |
| Worker | evaluateHandle | π₯ | None |
| Worker | off | π₯ | None |
| Worker | on | π₯ | None |
| Worker | once | π₯ | None |
| Worker | prependListener | π₯ | None |
| Worker | removeListener | π₯ | None |
| Worker | url | π© | - |
Was this page helpful?
Related resources from Grafana Labs

