English · Node.js
Appearance
English · Node.js
Appearance
Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way to find element(s) on the page at any moment. A locator can be created with the page.locator() method.
When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.
INFO
locator.all() does not wait for elements to match the locator, and instead immediately returns whatever is present in the page.
When the list of elements changes dynamically, locator.all() will produce unpredictable and flaky results.
When the list of elements is stable, but loaded dynamically, wait for the full list to finish loading before calling locator.all().
Usage
for (const li of await page.getByRole('listitem').all())
await li.click();Returns
Promise<Array<Locator>>Returns an array of node.innerText values for all matching nodes.
:::warning[Asserting text]
If you need to assert text on the page, prefer locatorAssertions.toHaveText() with useInnerText option to avoid flakiness. See assertions guide for more details. :::
Usage
const texts = await page.getByRole('link').allInnerTexts();Returns
Promise<Array<string>>Returns an array of node.textContent values for all matching nodes.
:::warning[Asserting text]
If you need to assert text on the page, prefer locatorAssertions.toHaveText() to avoid flakiness. See assertions guide for more details. :::
Usage
const texts = await page.getByRole('link').allTextContents();Returns
Promise<Array<string>>Creates a locator that matches both this locator and the argument locator.
Usage
The following example finds a button with a specific title.
const button = page.getByRole('button').and(page.getByTitle('Subscribe'));Arguments
Returns
LocatorCaptures the aria snapshot of the given element. Read more about aria snapshots and locatorAssertions.toMatchAriaSnapshot() for the corresponding assertion.
Usage
await page.getByRole('link').ariaSnapshot();Details
This method captures the aria snapshot of the given element. The snapshot is a string that represents the state of the element and its children. The snapshot can be used to assert the state of the element in the test, or to compare it to state in the future.
The ARIA snapshot is represented using YAML markup language:
text key.Below is the HTML markup and the respective ARIA snapshot:
<ul aria-label="Links">
<li><a href="/">Home</a></li>
<li><a href="/about">About</a></li>
<ul>- list "Links":
- listitem:
- link "Home"
- listitem:
- link "About"An AI-optimized snapshot, controlled by mode, is different from a default snapshot:
[ref=e2]. 2. Does not wait for an element matching the locator, and throws when no elements match. 3. Includes snapshots of <iframe>s inside the target. 4. Can omit names that repeat printed descendants, such as a heading containing a link. Names that identify dialogs, landmarks, groups, tables and table headers are retained.Arguments
boxes boolean (optional) Added in: v1.60
When true, appends each element's bounding box as [box=x,y,width,height] to the snapshot. Coordinates are relative to the viewport, in CSS pixels, as returned by Element.getBoundingClientRect(). Defaults to false.
depth int (optional) Added in: v1.59
When specified, limits the depth of the snapshot.
mode "ai" | "default" (optional) Added in: v1.59
When set to "ai", returns a snapshot optimized for AI consumption. Defaults to "default". See details for more information.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<string>Captures the aria snapshot of the given element as a free form JSON object.
Usage
await page.getByRole('list').ariaSnapshotJSON();Details
This method returns the same tree as locator.ariaSnapshot(), serialized as a JSON value instead of YAML markup. The result is a list of nodes, each node being an object with the following properties:
role Aria role of the element, or "text" for a static text fragment.name Accessible name of the element, if any.text Text content of the element when it is the only child, or the content of a static text fragment.children Child nodes and text fragments.checked, disabled, expanded, active, invalid, level, pressed, required and selected.url for links and placeholder for text boxes.ref Element reference for AI-optimized snapshots.cursor Set to "pointer" for clickable elements in AI-optimized snapshots.box Bounding box of the element when boxes is set.Arguments
When true, includes each element's bounding box as a box property with x, y, width and height. Coordinates are relative to the viewport, in CSS pixels, as returned by Element.getBoundingClientRect(). Defaults to false.
When specified, limits the depth of the snapshot.
mode "ai" | "default" (optional)
When set to "ai", returns a snapshot optimized for AI consumption. Defaults to "default". See details in locator.ariaSnapshot().
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<Serializable>Calls blur on the element.
Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
This method returns the bounding box of the element matching the locator, or null if the element is not visible. The bounding box is calculated relative to the main frame viewport - which is usually the same as the browser window.
Details
Scrolling affects the returned bounding box, similarly to Element.getBoundingClientRect. That means x and/or y may be negative.
Elements from child frames return the bounding box relative to the main frame, unlike the Element.getBoundingClientRect.
Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following snippet should click the center of the element.
Usage
const box = await page.getByRole('button').boundingBox();
await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<null | Object>Ensure that checkbox or radio element is checked.
Details
Performs the following steps:
force option is set.page.mouse to click in the center of the element.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Usage
await page.getByRole('checkbox').check();Arguments
Whether to bypass the actionability checks. Defaults to false.
noWaitAfter boolean (optional)
This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
x floaty floatscroll "auto" | "none" (optional) Added in: v1.62
Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.
Clear the input field.
Details
This method waits for actionability checks, focuses the element, clears it and triggers an input event after clearing.
If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be cleared instead.
Usage
await page.getByRole('textbox').clear();Arguments
Whether to bypass the actionability checks. Defaults to false.
noWaitAfter boolean (optional)
This option has no effect.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Click an element.
Details
This method clicks the element by performing the following steps:
force option is set.page.mouse to click in the center of the element, or the specified position.noWaitAfter option is set.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Usage
Click a button:
await page.getByRole('button').click();Shift-right-click at a specific position on a canvas:
await page.locator('canvas').click({
button: 'right',
modifiers: ['Shift'],
position: { x: 23, y: 32 },
});Arguments
button "left" | "right" | "middle" (optional)
Defaults to left.
defaults to 1. See [UIEvent.detail].
Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
Whether to bypass the actionability checks. Defaults to false.
modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (optional)
Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
noWaitAfter boolean (optional)
Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
x floaty floatscroll "auto" | "none" (optional) Added in: v1.62
Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
steps int (optional) Added in: v1.57
Defaults to 1. Sends n interpolated mousemove events to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a single mousemove event at the destination location.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it. Note that keyboard modifiers will be pressed regardless of trial to allow testing elements which are only visible when those keys are pressed.
Returns a FrameLocator object pointing to the same iframe as this locator.
Useful when you have a Locator object obtained somewhere, and later on would like to interact with the content inside the frame.
For a reverse operation, use frameLocator.owner().
Usage
const locator = page.locator('iframe[name="embedded"]');
// ...
const frameLocator = locator.contentFrame();
await frameLocator.getByRole('button').click();Returns
FrameLocatorReturns the number of elements matching the locator.
:::warning[Asserting count]
If you need to assert the number of elements on the page, prefer locatorAssertions.toHaveCount() to avoid flakiness. See assertions guide for more details. :::
Usage
const count = await page.getByRole('listitem').count();Returns
Promise<int>Double-click an element.
Details
This method double clicks the element by performing the following steps:
force option is set.page.mouse to double click in the center of the element, or the specified position.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
INFO
element.dblclick() dispatches two click events and a single dblclick event.
Arguments
button "left" | "right" | "middle" (optional)
Defaults to left.
Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
Whether to bypass the actionability checks. Defaults to false.
modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (optional)
Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
noWaitAfter boolean (optional)
This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
x floaty floatscroll "auto" | "none" (optional) Added in: v1.62
Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
steps int (optional) Added in: v1.57
Defaults to 1. Sends n interpolated mousemove events to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a single mousemove event at the destination location.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it. Note that keyboard modifiers will be pressed regardless of trial to allow testing elements which are only visible when those keys are pressed.
Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the same element.
Usage
const button = page.getByTestId('btn-sub').describe('Subscribe button');
await button.click();Arguments
Returns
LocatorReturns locator description previously set with locator.describe(). Returns null if no custom description has been set. Prefer locator.toString() for a human-readable representation, as it uses the description when available.
Usage
const button = page.getByRole('button').describe('Subscribe button');
console.log(button.description()); // "Subscribe button"
const input = page.getByRole('textbox');
console.log(input.description()); // nullReturns
null | stringProgrammatically dispatch an event on the matching element.
Usage
await locator.dispatchEvent('click');Details
The snippet above dispatches the click event on the element. Regardless of the visibility state of the element, click is dispatched. This is equivalent to calling element.click().
Under the hood, it creates an instance of an event based on the given type, initializes it with eventInit properties and dispatches it on the element. Events are composed, cancelable and bubble by default.
Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:
You can also specify JSHandle as the property value if you want live objects to be passed into the event:
const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await locator.dispatchEvent('dragstart', { dataTransfer });Arguments
DOM event type: "click", "dragstart", etc.
eventInit EvaluationArgument (optional)
Optional event-specific initialization properties.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Drag the source element towards the target element and drop it.
Details
This method drags the locator to another target locator or target position. It will first move to the source element, perform a mousedown, then move to the target element or position and perform a mouseup.
Usage
const source = page.locator('#source');
const target = page.locator('#target');
await source.dragTo(target);
// or specify exact positions relative to the top-left corners of the elements:
await source.dragTo(target, {
sourcePosition: { x: 34, y: 7 },
targetPosition: { x: 10, y: 20 },
});Arguments
Locator of the element to drag to.
Whether to bypass the actionability checks. Defaults to false.
noWaitAfter boolean (optional)
This option has no effect.
scroll "auto" | "none" (optional) Added in: v1.62
Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
sourcePosition Object (optional)
Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.
x floaty floatsteps int (optional) Added in: v1.57
Defaults to 1. Sends n interpolated mousemove events to represent travel between the mousedown and mouseup of the drag. When set to 1, emits a single mousemove event at the destination location.
targetPosition Object (optional)
Drops on the target element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.
x floaty floatMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.
Simulate an external drag-and-drop of files or clipboard-like data onto this locator.
Details
Dispatches the native dragenter, dragover, and drop events at the center of the target element with a synthetic [DataTransfer] carrying the provided files and/or data entries. Works cross-browser by constructing the [DataTransfer] in the page context.
If the target element's dragover listener does not call preventDefault(), the target is considered to have rejected the drop: Playwright dispatches dragleave and this method throws.
Usage
Drop a file buffer onto an upload area:
await page.locator('#dropzone').drop({
files: { name: 'note.txt', mimeType: 'text/plain', buffer: Buffer.from('hello') },
});Drop plain text and a URL together:
await page.locator('#dropzone').drop({
data: {
'text/plain': 'hello world',
'text/uri-list': 'https://example.com',
},
});Arguments
Data to drop onto the target. Provide files (file paths or in-memory buffers), data (a mime-type → string map for clipboard-like content such as text/plain, text/html, text/uri-list), or both.
files path | Array<path> | Object | Array<Object> (optional)
name string
File name
mimeType string
File type
buffer Buffer
File content
data Object<string, string> (optional)
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
x floaty floatsignal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Discouraged
Always prefer using Locators and web assertions over ElementHandles because latter are inherently racy.
Resolves given locator to the first matching DOM element. If there are no matching elements, waits for one. If multiple elements match the locator, throws.
Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<ElementHandle>Discouraged
Always prefer using Locators and web assertions over ElementHandles because latter are inherently racy.
Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list.
Returns
Promise<Array<ElementHandle>>Execute JavaScript code in the page, taking the matching element as an argument.
Details
Returns the return value of pageFunction, called with the matching element as a first argument, and arg as a second argument.
If pageFunction returns a [Promise], this method will wait for the promise to resolve and return its value.
If pageFunction throws or rejects, this method throws.
Usage
Passing argument to pageFunction:
const result = await page.getByTestId('myId').evaluate((element, [x, y]) => {
return element.textContent + ' ' + x * y;
}, [7, 8]);
console.log(result); // prints "myId text 56"Arguments
pageFunction function() | string
Function to be evaluated in the page context.
arg EvaluationArgument (optional)
Optional argument to pass to pageFunction.
exposeFunctions boolean (optional) Added in: v1.62
When set to true, functions passed inside arg are exposed in the page and can be called from the page function. Calling one returns a [Promise] of its result. Under the hood, each function is exposed via page.exposeFunction(), so it is technically accessible from all frames of the page. Exposed functions are cleared upon the top-level navigation. Defaults to false, in which case functions are not serializable and passing one throws an error.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved, evaluation itself is not limited by the timeout. Defaults to 0 - no timeout.
Returns
Promise<Serializable>Execute JavaScript code in the page, taking all matching elements as an argument.
Details
Returns the return value of pageFunction, called with an array of all matching elements as a first argument, and arg as a second argument.
If pageFunction returns a [Promise], this method will wait for the promise to resolve and return its value.
If pageFunction throws or rejects, this method throws.
Usage
const locator = page.locator('div');
const moreThanTen = await locator.evaluateAll((divs, min) => divs.length > min, 10);Arguments
pageFunction function() | string
Function to be evaluated in the page context.
arg EvaluationArgument (optional)
Optional argument to pass to pageFunction.
Returns
Promise<Serializable>Execute JavaScript code in the page, taking the matching element as an argument, and return a JSHandle with the result.
Details
Returns the return value of pageFunction as aJSHandle, called with the matching element as a first argument, and arg as a second argument.
The only difference between locator.evaluate() and locator.evaluateHandle() is that locator.evaluateHandle() returns JSHandle.
If pageFunction returns a [Promise], this method will wait for the promise to resolve and return its value.
If pageFunction throws or rejects, this method throws.
See page.evaluateHandle() for more details.
Arguments
pageFunction function() | string
Function to be evaluated in the page context.
arg EvaluationArgument (optional)
Optional argument to pass to pageFunction.
exposeFunctions boolean (optional) Added in: v1.62
When set to true, functions passed inside arg are exposed in the page and can be called from the page function. Calling one returns a [Promise] of its result. Under the hood, each function is exposed via page.exposeFunction(), so it is technically accessible from all frames of the page. Exposed functions are cleared upon the top-level navigation. Defaults to false, in which case functions are not serializable and passing one throws an error.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved, evaluation itself is not limited by the timeout. Defaults to 0 - no timeout.
Returns
Promise<JSHandle>Set a value to the input field.
Usage
await page.getByRole('textbox').fill('example value');Details
This method waits for actionability checks, focuses the element, fills it and triggers an input event after filling. Note that you can pass an empty string to clear the input field.
If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be filled instead.
To send fine-grained keyboard events, use locator.pressSequentially().
Arguments
Value to set for the <input>, <textarea> or [contenteditable] element.
Whether to bypass the actionability checks. Defaults to false.
noWaitAfter boolean (optional)
This option has no effect.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
This method narrows existing locator according to the options, for example filters by text. It can be chained to filter multiple times.
Usage
const rowLocator = page.locator('tr');
// ...
await rowLocator
.filter({ hasText: 'text in column 1' })
.filter({ has: page.getByRole('button', { name: 'column 2 button' }) })
.screenshot();Arguments
Narrows down the results of the method to those which contain elements matching this relative locator. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.
Inner locator must be relative to the outer locator and is queried starting with the outer locator match, not the document root. For example, you can find content that has div in <article><content><div>Playwright</div></content></article>. However, looking for content that has article div will fail, because the inner locator must be relative and should not use any elements outside the content.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNot Locator (optional) Added in: v1.33
Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that does not have div matches <article><span>Playwright</span></article>.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNotText string | RegExp (optional) Added in: v1.33
Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring.
hasText string | RegExp (optional)
Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.
visible boolean (optional) Added in: v1.51
Only matches visible or invisible elements. Prefer the locator.visible() shortcut when matching only visible elements.
Returns
LocatorReturns locator to the first matching element.
Returns
LocatorCalls focus on the matching element.
Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When working with iframes, you can create a frame locator that will enter the iframe and allow locating elements in that iframe:
Usage
const locator = page.frameLocator('iframe').getByText('Submit');
await locator.click();Arguments
Returns
FrameLocatorReturns the matching element's attribute value.
:::warning[Asserting attributes]
If you need to assert an element's attribute, prefer locatorAssertions.toHaveAttribute() to avoid flakiness. See assertions guide for more details. :::
Arguments
Attribute name to get the value for.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<null | string>Allows locating elements by their alt text.
Usage
For example, this method will find the image by alt text "Playwright logo":
<img alt='Playwright logo'>await page.getByAltText('Playwright logo').click();Arguments
Text to locate the element for.
Returns
LocatorAllows locating input elements by the text of the associated <label> or aria-labelledby element, or by the aria-label attribute.
Associated <label> elements are also supported for form-associated custom elements.
Usage
For example, this method will find inputs by label "Username" and "Password" in the following DOM:
<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">await page.getByLabel('Username').fill('john');
await page.getByLabel('Password').fill('secret');Arguments
Text to locate the element for.
Returns
LocatorAllows locating input elements by the placeholder text.
Usage
For example, consider the following DOM structure.
<input type="email" placeholder="name@example.com" />You can fill the input after locating it by the placeholder text:
await page
.getByPlaceholder('name@example.com')
.fill('playwright@microsoft.com');Arguments
Text to locate the element for.
Returns
LocatorAllows locating elements by their ARIA role, ARIA attributes and accessible name.
Usage
Consider the following DOM structure.
<h3>Sign up</h3>
<label>
<input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>You can locate each element by its implicit role:
await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();
await page.getByRole('checkbox', { name: 'Subscribe' }).check();
await page.getByRole('button', { name: /submit/i }).click();Details
Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.
Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.
Arguments
role "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"
Required aria role.
An attribute that is usually set by aria-checked or native <input type=checkbox> controls.
Learn more about aria-checked.
description string | RegExp (optional) Added in: v1.60
Option to match the accessible description. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.
Learn more about accessible description.
An attribute that is usually set by aria-disabled or disabled.
INFO
Unlike most other attributes, disabled is inherited through the DOM hierarchy. Learn more about aria-disabled.
exact boolean (optional) Added in: v1.28
Whether name and description are matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when the value is a regular expression. Note that exact match still trims whitespace.
An attribute that is usually set by aria-expanded.
Learn more about aria-expanded.
includeHidden boolean (optional)
Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.
Learn more about aria-hidden.
A number attribute that is usually present for roles heading, listitem, row, treeitem, with default values for <h1>-<h6> elements.
Learn more about aria-level.
name string | RegExp (optional)
Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.
Learn more about accessible name.
An attribute that is usually set by aria-pressed.
Learn more about aria-pressed.
An attribute that is usually set by aria-selected.
Learn more about aria-selected.
Returns
LocatorLocate element by the test id.
Usage
Consider the following DOM structure.
<button data-testid="directions">Itinéraire</button>You can locate the element by its test id:
await page.getByTestId('directions').click();Details
By default, the data-testid attribute is used as a test id. Use selectors.setTestIdAttribute() to configure a different test id attribute if necessary.
// Set custom test id attribute from @playwright/test config:
import { defineConfig } from '@playwright/test';
export default defineConfig({
use: {
testIdAttribute: 'data-pw'
},
});Arguments
Returns
LocatorAllows locating elements that contain given text.
See also locator.filter() that allows to match by another criteria, like an accessible role, and then filter by the text content.
Usage
Consider the following DOM structure:
<div>Hello <span>world</span></div>
<div>Hello</div>You can locate by text substring, exact string, or a regular expression:
// Matches <span>
page.getByText('world');
// Matches first <div>
page.getByText('Hello world');
// Matches second <div>
page.getByText('Hello', { exact: true });
// Matches both <div>s
page.getByText(/Hello/);
// Matches second <div>
page.getByText(/^hello$/i);Details
Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.
Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text "Log in" matches <input type=button value="Log in">.
Arguments
Text to locate the element for.
Returns
LocatorAllows locating elements by their title attribute.
Usage
Consider the following DOM structure.
<span title='Issues count'>25 issues</span>You can check the issues count after locating it by the title text:
await expect(page.getByTitle('Issues count')).toHaveText('25 issues');Arguments
Text to locate the element for.
Returns
LocatorHides the element highlight previously added by locator.highlight().
Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses locator.highlight().
Arguments
Returns
Promise<Disposable>Hover over the matching element.
Usage
await page.getByRole('link').hover();Details
This method hovers over the element by performing the following steps:
force option is set.page.mouse to hover over the center of the element, or the specified position.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Arguments
Whether to bypass the actionability checks. Defaults to false.
modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (optional)
Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
noWaitAfter boolean (optional) Added in: v1.28
This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
x floaty floatscroll "auto" | "none" (optional) Added in: v1.62
Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it. Note that keyboard modifiers will be pressed regardless of trial to allow testing elements which are only visible when those keys are pressed.
Returns the element.innerHTML.
Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<string>Returns the element.innerText.
:::warning[Asserting text]
If you need to assert text on the page, prefer locatorAssertions.toHaveText() with useInnerText option to avoid flakiness. See assertions guide for more details. :::
Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<string>Returns the value for the matching <input> or <textarea> or <select> element.
:::warning[Asserting value]
If you need to assert input value, prefer locatorAssertions.toHaveValue() to avoid flakiness. See assertions guide for more details. :::
Usage
const value = await page.getByRole('textbox').inputValue();Details
Throws elements that are not an input, textarea or a select. However, if the element is inside the <label> element that has an associated control, returns the value of the control.
Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<string>Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
:::warning[Asserting checked state]
If you need to assert that checkbox is checked, prefer locatorAssertions.toBeChecked() to avoid flakiness. See assertions guide for more details. :::
Usage
const checked = await page.getByRole('checkbox').isChecked();Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<boolean>Returns whether the element is disabled, the opposite of enabled.
:::warning[Asserting disabled state]
If you need to assert that an element is disabled, prefer locatorAssertions.toBeDisabled() to avoid flakiness. See assertions guide for more details. :::
Usage
const disabled = await page.getByRole('button').isDisabled();Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<boolean>Returns whether the element is editable. If the target element is not an <input>, <textarea>, <select>, [contenteditable] and does not have a role allowing [aria-readonly], this method throws an error.
:::warning[Asserting editable state]
If you need to assert that an element is editable, prefer locatorAssertions.toBeEditable() to avoid flakiness. See assertions guide for more details. :::
Usage
const editable = await page.getByRole('textbox').isEditable();Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<boolean>Returns whether the element is enabled.
:::warning[Asserting enabled state]
If you need to assert that an element is enabled, prefer locatorAssertions.toBeEnabled() to avoid flakiness. See assertions guide for more details. :::
Usage
const enabled = await page.getByRole('button').isEnabled();Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<boolean>Returns whether the element is hidden, the opposite of visible.
:::warning[Asserting visibility]
If you need to assert that element is hidden, prefer locatorAssertions.toBeHidden() to avoid flakiness. See assertions guide for more details. :::
Usage
const hidden = await page.getByRole('button').isHidden();Arguments
Returns
Promise<boolean>Returns whether the element is visible.
:::warning[Asserting visibility]
If you need to assert that element is visible, prefer locatorAssertions.toBeVisible() to avoid flakiness. See assertions guide for more details. :::
Usage
const visible = await page.getByRole('button').isVisible();Arguments
Returns
Promise<boolean>Returns locator to the last matching element.
Usage
const banana = await page.getByRole('listitem').last();Returns
LocatorThe method finds an element matching the specified selector in the locator's subtree. It also accepts filter options, similar to locator.filter() method.
Arguments
selectorOrLocator string | Locator
A selector or locator to use when resolving DOM element.
Narrows down the results of the method to those which contain elements matching this relative locator. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.
Inner locator must be relative to the outer locator and is queried starting with the outer locator match, not the document root. For example, you can find content that has div in <article><content><div>Playwright</div></content></article>. However, looking for content that has article div will fail, because the inner locator must be relative and should not use any elements outside the content.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNot Locator (optional) Added in: v1.33
Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that does not have div matches <article><span>Playwright</span></article>.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNotText string | RegExp (optional) Added in: v1.33
Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring.
hasText string | RegExp (optional)
Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.
Returns
LocatorReturns a new locator that uses best practices for referencing the matched element, prioritizing test ids, aria roles, and other user-facing attributes over CSS selectors. This is useful for converting implementation-detail selectors into more resilient, human-readable locators.
Usage
An agent can pick an element by its ref from an page.ariaSnapshot() taken in the "ai" mode. Refs only work for the latest snapshot. Normalize the ref locator and convert it to a string to get resilient locator code in your language, the same way codegen does.
Consider the following aria snapshot.
- button "Submit" [ref=e2]You can turn the ref into locator code:
const normalized = await page.getByRef('e2').normalize();
console.log(normalized.toString());
// getByRole('button', { name: 'Submit' })Returns
Promise<Locator>Returns locator to the n-th matching element. It's zero based, nth(0) selects the first element.
Usage
const banana = await page.getByRole('listitem').nth(2);Arguments
Returns
LocatorCreates a locator matching all elements that match one or both of the two locators.
Note that when both locators match something, the resulting locator will have multiple matches, potentially causing a locator strictness violation.
Usage
Consider a scenario where you'd like to click on a "New email" button, but sometimes a security settings dialog shows up instead. In this case, you can wait for either a "New email" button, or a dialog and act accordingly.
INFO
If both "New email" button and security dialog appear on screen, the "or" locator will match both of them, possibly throwing the "strict mode violation" error. In this case, you can use locator.first() to only match one of them.
const newEmail = page.getByRole('button', { name: 'New' });
const dialog = page.getByText('Confirm security settings');
await expect(newEmail.or(dialog).first()).toBeVisible();
if (await dialog.isVisible())
await page.getByRole('button', { name: 'Dismiss' }).click();
await newEmail.click();Arguments
Returns
LocatorA page this locator belongs to.
Returns
PageFocuses the matching element and presses a combination of the keys.
Usage
await page.getByRole('textbox').press('Backspace');Details
Focuses the element, and then uses keyboard.down() and keyboard.up().
key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:
F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.
Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta. ControlOrMeta resolves to Control on Windows and Linux and to Meta on macOS.
Holding down Shift will type the text that corresponds to the key in the upper case.
If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.
Shortcuts such as key: "Control+o", key: "Control++ or key: "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
Arguments
Name of the key to press or a character to generate, such as ArrowLeft or a.
Time to wait between keydown and keyup in milliseconds. Defaults to 0.
noWaitAfter boolean (optional)
Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
TIP
In most cases, you should use locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page.
Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.
To press a special key, like Control or ArrowDown, use locator.press().
Usage
await locator.pressSequentially('Hello'); // Types instantly
await locator.pressSequentially('World', { delay: 100 }); // Types slower, like a userAn example of typing into a text field and then submitting the form:
const locator = page.getByLabel('Password');
await locator.pressSequentially('my password');
await locator.press('Enter');Arguments
String of characters to sequentially press into a focused element.
Time to wait between key presses in milliseconds. Defaults to 0.
noWaitAfter boolean (optional)
This option has no effect.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Take a screenshot of the element matching the locator.
Usage
await page.getByRole('link').screenshot();Disable animations and save screenshot to a file:
await page.getByRole('link').screenshot({ animations: 'disabled', path: 'link.png' });Details
This method captures a screenshot of the page, clipped to the size and position of a particular element matching the locator. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable container, only the currently scrolled content will be visible on the screenshot.
This method waits for the actionability checks, then scrolls element into view before taking a screenshot. If the element is detached from DOM, the method throws an error.
Returns the buffer with the captured screenshot.
Arguments
animations "disabled" | "allow" (optional)
When set to "disabled", stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:
transitionend event.Defaults to "allow" that leaves animations untouched.
caret "hide" | "initial" (optional)
When set to "hide", screenshot will hide text caret. When set to "initial", text caret behavior will not be changed. Defaults to "hide".
mask Array<Locator> (optional)
Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box #FF00FF (customized by maskColor) that completely covers its bounding box. The mask is also applied to invisible elements, see Matching only visible elements to disable that.
maskColor string (optional) Added in: v1.35
Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink #FF00FF.
omitBackground boolean (optional)
Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.
The file path to save the image to. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be saved to the disk.
The quality of the image, between 0-100. Not applicable to png images. For jpeg the default is 80. For webp, a quality of 100 (the default) produces a lossless image, while lower values use lossy compression.
scale "css" | "device" (optional)
When set to "css", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using "device" option will produce a single pixel per each device pixel, so screenshots of high-dpi devices will be twice as large or even larger.
Defaults to "device".
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
style string (optional) Added in: v1.41
Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces the Shadow DOM and applies to the inner frames.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
type "png" | "jpeg" | "webp" (optional)
Specify screenshot type, defaults to png.
Returns
Promise<Buffer>This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver's ratio.
See scrolling for alternative ways to scroll.
Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Selects option or options in <select>.
Details
This method waits for actionability checks, waits until all specified options are present in the <select> element and selects these options.
If the target element is not a <select> element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be used instead.
Returns the array of option values that have been successfully selected.
Triggers a change and input event once all the provided options have been selected.
Usage
<select multiple>
<option value="red">Red</option>
<option value="green">Green</option>
<option value="blue">Blue</option>
</select>// single selection matching the value or label
element.selectOption('blue');
// single selection matching the label
element.selectOption({ label: 'Blue' });
// multiple selection for red, green and blue options
element.selectOption(['red', 'green', 'blue']);Arguments
values null | string | ElementHandle | Array<string> | Object | Array<ElementHandle> | Array<Object>
Options to select. If the <select> has the multiple attribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.
value string (optional)
Matches by option.value. Optional.
label string (optional)
Matches by option.label. Optional.
index int (optional)
Matches by the index. Optional.
Whether to bypass the actionability checks. Defaults to false.
noWaitAfter boolean (optional)
This option has no effect.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<Array<string>>This method waits for actionability checks, then focuses the element and selects all its text content.
If the element is inside the <label> element that has an associated control, focuses and selects text in the control instead.
Arguments
Whether to bypass the actionability checks. Defaults to false.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Set the state of a checkbox or a radio element.
Usage
await page.getByRole('checkbox').setChecked(true);Details
This method checks or unchecks an element by performing the following steps:
force option is set. If the element is detached during the checks, the whole action is retried.page.mouse to click in the center of the element.When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Arguments
Whether to check or uncheck the checkbox.
Whether to bypass the actionability checks. Defaults to false.
noWaitAfter boolean (optional)
This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
x floaty floatscroll "auto" | "none" (optional) Added in: v1.62
Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.
Upload file or multiple files into <input type=file>. For inputs with a [webkitdirectory] attribute, only a single directory path is supported.
Usage
// Select one file
await page.getByLabel('Upload file').setInputFiles(path.join(__dirname, 'myfile.pdf'));
// Select multiple files
await page.getByLabel('Upload files').setInputFiles([
path.join(__dirname, 'file1.txt'),
path.join(__dirname, 'file2.txt'),
]);
// Select a directory
await page.getByLabel('Upload directory').setInputFiles(path.join(__dirname, 'mydir'));
// Remove all the selected files
await page.getByLabel('Upload file').setInputFiles([]);
// Upload buffer from memory
await page.getByLabel('Upload file').setInputFiles({
name: 'file.txt',
mimeType: 'text/plain',
buffer: Buffer.from('this is test')
});Details
Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.
This method expects Locator to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.
Arguments
files path | Array<path> | Object | Array<Object>
name string
File name
mimeType string
File type
buffer Buffer
File content
noWaitAfter boolean (optional)
This option has no effect.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Perform a tap gesture on the element matching the locator. For examples of emulating other gestures by manually dispatching touch events, see the emulating legacy touch events page.
Details
This method taps the element by performing the following steps:
force option is set.page.touchscreen to tap the center of the element, or the specified position.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
INFO
element.tap() requires that the hasTouch option of the browser context be set to true.
Arguments
Whether to bypass the actionability checks. Defaults to false.
modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (optional)
Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
noWaitAfter boolean (optional)
This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
x floaty floatscroll "auto" | "none" (optional) Added in: v1.62
Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it. Note that keyboard modifiers will be pressed regardless of trial to allow testing elements which are only visible when those keys are pressed.
Returns the node.textContent.
:::warning[Asserting text]
If you need to assert text on the page, prefer locatorAssertions.toHaveText() to avoid flakiness. See assertions guide for more details. :::
Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns
Promise<null | string>Returns a human-readable representation of the locator, using the locator.description() if one exists; otherwise, it generates a string based on the locator's selector.
Returns
stringEnsure that checkbox or radio element is unchecked.
Usage
await page.getByRole('checkbox').uncheck();Details
This method unchecks the element by performing the following steps:
force option is set.page.mouse to click in the center of the element.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Arguments
Whether to bypass the actionability checks. Defaults to false.
noWaitAfter boolean (optional)
This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
x floaty floatscroll "auto" | "none" (optional) Added in: v1.62
Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.
Returns a locator that matches only visible elements, ignoring the invisible ones. This is the recommended way to distinguish elements by visibility, as opposed to the :visible CSS pseudo-class.
Note that visibility is checked every time the locator is used, and not at the moment of the locator.visible() call.
Usage
Consider a page with two buttons, the first invisible and the second visible.
<button style='display: none'>Invisible</button>
<button>Visible</button>This will only find the second button, because it is visible, and then click it.
await page.locator('button').visible().click();To match invisible elements instead, use locator.filter() with the visible option set to false.
Returns
LocatorReturns when element specified by locator satisfies the state option.
If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to timeout milliseconds until the condition is met.
Usage
const orderSent = page.locator('#order-sent');
await orderSent.waitFor();Arguments
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
state "attached" | "detached" | "visible" | "hidden" (optional)
Defaults to 'visible'. Can be either:
'attached' - wait for element to be present in DOM.'detached' - wait for element to not be present in DOM.'visible' - wait for element to have non-empty bounding box and no visibility:hidden. Note that element without any content or with display:none has an empty bounding box and is not considered visible.'hidden' - wait for element to be either detached from DOM, or have an empty bounding box or visibility:hidden. This is opposite to the 'visible' option.Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns when pageFunction returns a truthy value, called with the matching element as a first argument, and arg as a second argument.
This is a generic way to wait for an element to reach a custom condition without asserting it. The locator is re-resolved on each retry, so it tolerates the element being re-rendered while waiting.
If pageFunction returns a [Promise], this method will wait for the promise to resolve before checking its value.
If pageFunction throws or rejects, this method throws.
Usage
Wait for an attribute to appear:
const toggle = page.getByRole('button', { name: 'Menu' });
await toggle.click();
await toggle.waitForFunction(element => element.hasAttribute('aria-expanded'));Passing argument to pageFunction:
await page.getByTestId('status').waitForFunction((element, value) => {
return element.textContent === value;
}, 'Ready');Arguments
pageFunction function() | string
Function to be evaluated in the page context.
arg EvaluationArgument (optional)
Optional argument to pass to pageFunction.
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time to wait for in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.
Returns a locator that matches this locator's elements inside each element matched by locator.
Note that relative locators, such as locator.nth() or locator.first(), are resolved separately inside each matched parent. In the example below, page.getByRole('cell').nth(2) picks the third cell of every row, not the third cell in the whole table.
Usage
const thirdColumn = page.getByRole('cell').nth(2).within(page.getByRole('row'));
await expect(thirdColumn).toHaveText(['Apple', 'Banana', 'Cherry']);Arguments
Returns
LocatorDeprecated
In most cases, you should use locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use locator.pressSequentially().
Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.
To press a special key, like Control or ArrowDown, use locator.press().
Usage
Arguments
A text to type into a focused element.
Time to wait between key presses in milliseconds. Defaults to 0.
noWaitAfter boolean (optional)
This option has no effect.
signal AbortSignal (optional) Added in: v1.62
Allows to cancel the operation using an AbortSignal. If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using browserContext.setDefaultTimeout() or page.setDefaultTimeout(); pass timeout: 0 to disable the timeout entirely.
Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout() or page.setDefaultTimeout() methods.