When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.
NOTE 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 an array of node.innerText values for all matching nodes.
NOTE If you need to assert text on the page, prefer
expect(locator).toHaveText(expected[, options])
with useInnerText option to avoid flakiness. See assertions guide for more details.
Usage
const texts = await page.getByRole('link').allInnerTexts();
Returns an array of node.textContent values for all matching nodes.
NOTE If you need to assert text on the page, prefer expect(locator).toHaveText(expected[, options]) to avoid flakiness. See assertions guide for more details.
Usage
const texts = await page.getByRole('link').allTextContents();
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'));
Additional locator to match.
Calls blur on the element.
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) 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);
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Ensure that checkbox or radio element is checked.
Details
Performs the following steps:
force option is set.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
await page.getByRole('checkbox').check();
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions 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.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen 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();
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions 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.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Click an element.
Details
This method clicks the element by performing the following steps:
force option is set.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 },
});
Optional options: { Optional
Optional button?: "left" | "right" | "middle"Defaults to left.
Optional clickdefaults to 1. See [UIEvent.detail].
Optional delay?: numberTime to wait between mousedown and mouseup in milliseconds. Defaults to 0.
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]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.
Optional noActions 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.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen 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 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 the number of elements matching the locator.
NOTE If you need to assert the number of elements on the page, prefer expect(locator).toHaveCount(count[, options]) to avoid flakiness. See assertions guide for more details.
Usage
const count = await page.getByRole('listitem').count();
Double-click an element.
Details
This method double clicks the element by performing the following steps:
force option is set.position.noWaitAfter option is set. Note that if
the first click of the dblclick() triggers a navigation event, this method will throw.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.
NOTE element.dblclick() dispatches two click events and a single dblclick event.
Optional options: { Optional
Optional button?: "left" | "right" | "middle"Defaults to left.
Optional delay?: numberTime to wait between mousedown and mouseup in milliseconds. Defaults to 0.
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]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.
Optional noActions 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.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen 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.
Programmatically 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:
// Note you can only create DataTransfer in Chromium and Firefox
const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await locator.dispatchEvent('dragstart', { dataTransfer });
DOM event type: "click", "dragstart", etc.
Optional eventInit: EvaluationArgumentOptional event-specific initialization properties.
Optional Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) 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 },
});
Locator of the element to drag to.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions 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.
Optional sourceClicks 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.
Optional targetDrops 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.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen 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 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.
Optional options: { Optional
Optional timeout?: numberNOTE 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.
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
const tweets = page.locator('.tweet .retweets');
expect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
Optional options: { Optional
Optional timeout?: numberExecute 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
const tweets = page.locator('.tweet .retweets');
expect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');
Function to be evaluated in the page context.
Optional options: { Optional
Optional timeout?: numberExecute 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);
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
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);
Function to be evaluated in the page context.
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(pageFunction[, arg, options]) and locator.evaluateHandle(pageFunction[, arg, options]) is that locator.evaluateHandle(pageFunction[, arg, options]) 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(pageFunction[, arg]) for more details.
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
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(pageFunction[, arg, options]) and locator.evaluateHandle(pageFunction[, arg, options]) is that locator.evaluateHandle(pageFunction[, arg, options]) 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(pageFunction[, arg]) for more details.
Function to be evaluated in the page context.
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(text[, options]).
Value to set for the <input>, <textarea> or [contenteditable] element.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions 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.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) 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();
Optional options: { Optional
Optional has?: LocatorNarrows 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.
Optional hasMatches 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.
Optional hasMatches 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.
Optional hasMatches 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>.
Calls focus on the matching element.
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) 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();
A selector to use when resolving DOM element.
Returns the matching element's attribute value.
NOTE If you need to assert an element's attribute, prefer expect(locator).toHaveAttribute(name, value[, options]) to avoid flakiness. See assertions guide for more details.
Attribute name to get the value for.
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
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();
Text to locate the element for.
Optional options: { Optional
Optional exact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
Allows locating input elements by the text of the associated <label> or aria-labelledby element, or by the
aria-label attribute.
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');
Text to locate the element for.
Optional options: { Optional
Optional exact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
Allows 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');
Text to locate the element for.
Optional options: { Optional
Optional exact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
Allows 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 it's 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.
Required aria role.
Optional options: { Optional
Optional checked?: booleanAn attribute that is usually set by aria-checked or native <input type=checkbox> controls.
Learn more about aria-checked.
Optional disabled?: booleanAn attribute that is usually set by aria-disabled or disabled.
NOTE Unlike most other attributes, disabled is inherited through the DOM hierarchy. Learn more about
aria-disabled.
Optional exact?: booleanWhether name is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when name is a
regular expression. Note that exact match still trims whitespace.
Optional expanded?: booleanAn attribute that is usually set by aria-expanded.
Learn more about aria-expanded.
Optional includeOption 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.
Optional level?: numberA number attribute that is usually present for roles heading, listitem, row, treeitem, with default values
for <h1>-<h6> elements.
Learn more about aria-level.
Optional name?: string | RegExpOption 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.
Optional pressed?: booleanAn attribute that is usually set by aria-pressed.
Learn more about aria-pressed.
Optional selected?: booleanAn attribute that is usually set by aria-selected.
Learn more about aria-selected.
Locate element by the test id.
Usage
Consider the following DOM structure.
<button data-testid="directions">Itinéraire</button>
You can locate the element by it's test id:
await page.getByTestId('directions').click();
Details
By default, the data-testid attribute is used as a test id. Use
selectors.setTestIdAttribute(attributeName)
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'
},
});
Id to locate the element by.
Allows locating elements that contain given text.
See also locator.filter([options]) 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">.
Text to locate the element for.
Optional options: { Optional
Optional exact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
Allows 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');
Text to locate the element for.
Optional options: { Optional
Optional exact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses locator.highlight().
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.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.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]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.
Optional noActions 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.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen 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 the element.innerHTML.
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Returns the element.innerText.
NOTE If you need to assert text on the page, prefer
expect(locator).toHaveText(expected[, options])
with useInnerText option to avoid flakiness. See assertions guide for more details.
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Returns the value for the matching <input> or <textarea> or <select> element.
NOTE If you need to assert input value, prefer expect(locator).toHaveValue(value[, options]) 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.
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
NOTE If you need to assert that checkbox is checked, prefer expect(locator).toBeChecked([options]) to avoid flakiness. See assertions guide for more details.
Usage
const checked = await page.getByRole('checkbox').isChecked();
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Returns whether the element is disabled, the opposite of enabled.
NOTE If you need to assert that an element is disabled, prefer expect(locator).toBeDisabled([options]) to avoid flakiness. See assertions guide for more details.
Usage
const disabled = await page.getByRole('button').isDisabled();
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Returns whether the element is editable.
NOTE If you need to assert that an element is editable, prefer expect(locator).toBeEditable([options]) to avoid flakiness. See assertions guide for more details.
Usage
const editable = await page.getByRole('textbox').isEditable();
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Returns whether the element is enabled.
NOTE If you need to assert that an element is enabled, prefer expect(locator).toBeEnabled([options]) to avoid flakiness. See assertions guide for more details.
Usage
const enabled = await page.getByRole('button').isEnabled();
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Returns whether the element is hidden, the opposite of visible.
NOTE If you need to assert that element is hidden, prefer expect(locator).toBeHidden([options]) to avoid flakiness. See assertions guide for more details.
Usage
const hidden = await page.getByRole('button').isHidden();
Optional options: { Optional
Optional timeout?: numberThis option is ignored. locator.isHidden([options]) does not wait for the element to become hidden and returns immediately.
Returns whether the element is visible.
NOTE If you need to assert that element is visible, prefer expect(locator).toBeVisible([options]) to avoid flakiness. See assertions guide for more details.
Usage
const visible = await page.getByRole('button').isVisible();
Optional options: { Optional
Optional timeout?: numberThis option is ignored. locator.isVisible([options]) does not wait for the element to become visible and returns immediately.
The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options, similar to locator.filter([options]) method.
A selector or locator to use when resolving DOM element.
Optional options: { Optional
Optional has?: LocatorNarrows 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.
Optional hasMatches 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.
Optional hasMatches 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.
Optional hasMatches 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>.
Creates a locator that matches either of the two locators.
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.
const newEmail = page.getByRole('button', { name: 'New' });
const dialog = page.getByText('Confirm security settings');
await expect(newEmail.or(dialog)).toBeVisible();
if (await dialog.isVisible())
await page.getByRole('button', { name: 'Dismiss' }).click();
await newEmail.click();
Alternative locator to match.
Focuses 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(key) and keyboard.up(key).
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.
Name of the key to press or a character to generate, such as ArrowLeft or a.
Optional options: { Optional
Optional delay?: numberTime to wait between keydown and keyup in milliseconds. Defaults to 0.
Optional noActions 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.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE In most cases, you should use locator.fill(value[, options]) 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(key[, options]).
Usage
await locator.pressSequentially('Hello'); // Types instantly
await locator.pressSequentially('World', { delay: 100 }); // Types slower, like a user
An 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');
String of characters to sequentially press into a focused element.
Optional options: { Optional
Optional delay?: numberTime to wait between key presses in milliseconds. Defaults to 0.
Optional noActions 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.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) 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.
Optional options: LocatorScreenshotOptionsOptional This method waits for actionability checks, then tries to scroll element into view, unless
it is completely visible as defined by
IntersectionObserver's ratio.
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) 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</div>
<option value="green">Green</div>
<option value="blue">Blue</div>
</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']);
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.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions 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.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
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.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) 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.noWaitAfter option is set.When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Whether to check or uncheck the checkbox.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions 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.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen 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>.
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'),
]);
// 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.
Optional options: { Optional
Optional noActions 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.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Perform a tap gesture on the element matching the locator.
Details
This method taps the element by performing the following steps:
force option is set.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.
NOTE element.tap() requires that the hasTouch option of the browser context be set to true.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]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.
Optional noActions 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.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen 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 the node.textContent.
NOTE If you need to assert text on the page, prefer expect(locator).toHaveText(expected[, options]) to avoid flakiness. See assertions guide for more details.
Optional options: { Optional
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
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(key[, options]).
Usage
A text to type into a focused element.
Optional options: { Optional
Optional delay?: numberTime to wait between key presses in milliseconds. Defaults to 0.
Optional noActions 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.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
In most cases, you should use locator.fill(value[, options]) 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(text[, options]).
Ensure 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.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.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions 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.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen 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 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();
Optional options: { Optional
Optional state?: "hidden" | "attached" | "detached" | "visible"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.Optional timeout?: numberMaximum 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(timeout)
or page.setDefaultTimeout(timeout) methods.
Generated using TypeDoc
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(selector[, options]) method.
Learn more about locators.