Locator
Added in: v1.14Locators 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.
Methods
Locator.AllAsync()
Added in: v1.29When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.
INFO
Locator.AllAsync() 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.AllAsync() 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.AllAsync().
Usage
foreach (var li in await page.GetByRole("listitem").AllAsync())
await li.ClickAsync();Returns
Array<Locator>
Locator.AllInnerTextsAsync()
Added in: v1.14Returns an array of node.innerText values for all matching nodes.
:::warning[Asserting text]
If you need to assert text on the page, prefer LocatorAssertions.ToHaveTextAsync() with useInnerText option to avoid flakiness. See assertions guide for more details. :::
Usage
var texts = await page.GetByRole(AriaRole.Link).AllInnerTextsAsync();Returns
Array<string>
Locator.AllTextContentsAsync()
Added in: v1.14Returns an array of node.textContent values for all matching nodes.
:::warning[Asserting text]
If you need to assert text on the page, prefer LocatorAssertions.ToHaveTextAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
var texts = await page.GetByRole(AriaRole.Link).AllTextContentsAsync();Returns
Array<string>
Locator.And()
Added in: v1.34Creates a locator that matches both this locator and the argument locator.
Usage
The following example finds a button with a specific title.
var button = page.GetByRole(AriaRole.Button).And(page.GetByTitle("Subscribe"));Arguments
Returns
Locator
Locator.AriaSnapshotAsync()
Added in: v1.49Captures the aria snapshot of the given element. Read more about aria snapshots and LocatorAssertions.ToMatchAriaSnapshotAsync() for the corresponding assertion.
Usage
await page.GetByRole(AriaRole.Link).AriaSnapshotAsync();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:
- The keys of the objects are the roles and optional accessible names of the elements.
- The values are either text content or an array of child elements.
- Generic static text can be represented with the
textkey.
Below is the HTML markup and the respective ARIA snapshot:
<ul aria-label="Links">
<li><a href="/zh/">Home</a></li>
<li><a href="/zh/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:
- Includes element references
[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
boxesboolean(optional) Added in: v1.60When
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 byElement.getBoundingClientRect(). Defaults tofalse.depthint(optional) Added in: v1.59When specified, limits the depth of the snapshot.
mode"ai" | "default"(optional) Added in: v1.59When set to
"ai", returns a snapshot optimized for AI consumption. Defaults to"default". See details for more information.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
string
Locator.BlurAsync()
Added in: v1.28Calls blur on the element.
Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.BoundingBoxAsync()
Added in: v1.14This 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
var box = await page.GetByRole(AriaRole.Button).BoundingBoxAsync();
await page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
null | Object
Locator.CheckAsync()
Added in: v1.14Ensure that checkbox or radio element is checked.
Details
Performs the following steps:
- Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto click in the center of the element. - Ensure that the element is now checked. If not, this method throws.
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(AriaRole.Checkbox).CheckAsync();Arguments
Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(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.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls 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.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.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.
Locator.ClearAsync()
Added in: v1.28Clear 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(AriaRole.Textbox).ClearAsync();Arguments
Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.ClickAsync()
Added in: v1.14Click an element.
Details
This method clicks the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto click in the center of the element, or the specifiedposition. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption 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(AriaRole.Button).ClickAsync();Shift-right-click at a specific position on a canvas:
await page.Locator("canvas").ClickAsync(new() {
Button = MouseButton.Right,
Modifiers = new[] { KeyboardModifier.Shift },
Position = new Position { X = 0, Y = 0 }
});Arguments
button"left" | "right" | "middle"(optional)Defaults to
left.defaults to 1. See [UIEvent.detail].
Time to wait between
mousedownandmouseupin milliseconds. Defaults to 0.Whether to bypass the actionability checks. Defaults to
false.modifiersArray<"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.
noWaitAfterboolean(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.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls 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.stepsint(optional) Added in: v1.57Defaults to 1. Sends
ninterpolatedmousemoveevents to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a singlemousemoveevent at the destination location.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.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 keyboardmodifierswill be pressed regardless oftrialto allow testing elements which are only visible when those keys are pressed.
Locator.ContentFrame()
Added in: v1.43Returns 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
var locator = Page.Locator("iframe[name=\"embedded\"]");
// ...
var frameLocator = locator.ContentFrame;
await frameLocator.GetByRole(AriaRole.Button).ClickAsync();Returns
FrameLocator
Locator.CountAsync()
Added in: v1.14Returns the number of elements matching the locator.
:::warning[Asserting count]
If you need to assert the number of elements on the page, prefer LocatorAssertions.ToHaveCountAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
int count = await page.GetByRole(AriaRole.Listitem).CountAsync();Returns
int
Locator.DblClickAsyncAsync()
Added in: v1.14Double-click an element.
Details
This method double clicks the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto double click in the center of the element, or the specifiedposition.
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
mousedownandmouseupin milliseconds. Defaults to 0.Whether to bypass the actionability checks. Defaults to
false.modifiersArray<"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.
noWaitAfterboolean(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.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls 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.stepsint(optional) Added in: v1.57Defaults to 1. Sends
ninterpolatedmousemoveevents to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a singlemousemoveevent at the destination location.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.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 keyboardmodifierswill be pressed regardless oftrialto allow testing elements which are only visible when those keys are pressed.
Locator.Describe()
Added in: v1.53Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the same element.
Usage
var button = Page.GetByTestId("btn-sub").Describe("Subscribe button");
await button.ClickAsync();Arguments
Returns
Locator
Locator.Description()
Added in: v1.57Returns locator description previously set with Locator.Describe(). Returns null if no custom description has been set.
Usage
var button = Page.GetByRole(AriaRole.Button).Describe("Subscribe button");
Console.WriteLine(button.Description()); // "Subscribe button"
var input = Page.GetByRole(AriaRole.Textbox);
Console.WriteLine(input.Description()); // nullReturns
null | string
Locator.DispatchEventAsync()
Added in: v1.14Programmatically dispatch an event on the matching element.
Usage
await locator.DispatchEventAsync("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:
- DeviceMotionEvent
- DeviceOrientationEvent
- DragEvent
- Event
- FocusEvent
- KeyboardEvent
- MouseEvent
- PointerEvent
- TouchEvent
- WheelEvent
You can also specify JSHandle as the property value if you want live objects to be passed into the event:
var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await locator.DispatchEventAsync("dragstart", new Dictionary<string, object>
{
{ "dataTransfer", dataTransfer }
});Arguments
DOM event type:
"click","dragstart", etc.eventInitEvaluationArgument(optional)Optional event-specific initialization properties.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.DragToAsync()
Added in: v1.18Drag 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
var source = Page.Locator("#source");
var target = Page.Locator("#target");
await source.DragToAsync(target);
// or specify exact positions relative to the top-left corners of the elements:
await source.DragToAsync(target, new()
{
SourcePosition = new() { X = 34, Y = 7 },
TargetPosition = new() { X = 10, Y = 20 },
});Arguments
Locator of the element to drag to.
Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
scroll"auto" | "none"(optional) Added in: v1.62Controls 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.sourcePositionObject(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.
xfloatyfloat
stepsint(optional) Added in: v1.57Defaults to 1. Sends
ninterpolatedmousemoveevents to represent travel between themousedownandmouseupof the drag. When set to 1, emits a singlemousemoveevent at the destination location.targetPositionObject(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.
xfloatyfloat
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.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.
Locator.DropAsync()
Added in: v1.60Simulate 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:
Drop plain text and a URL together:
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 astext/plain,text/html,text/uri-list), or both.filespath | Array<path> | Object | Array<Object>(optional)namestringFile name
mimeTypestringFile type
bufferBufferFile content
dataObject<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.
xfloatyfloat
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.ElementHandleAsync()
Added in: v1.14Discouraged
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
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
ElementHandle
Locator.ElementHandlesAsync()
Added in: v1.14Discouraged
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
Array<ElementHandle>
Locator.EvaluateAsync()
Added in: v1.14Execute JavaScript code in the page, taking the matching element as an argument.
Details
Returns the return value of expression, called with the matching element as a first argument, and arg as a second argument.
If expression returns a [Promise], this method will wait for the promise to resolve and return its value.
If expression throws or rejects, this method throws.
Usage
Passing argument to expression:
var result = await page.GetByTestId("myId").EvaluateAsync<string>("(element, [x, y]) => element.textContent + ' ' + x * y)", new[] { 7, 8 });
Console.WriteLine(result); // prints "myId text 56"Arguments
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
argEvaluationArgument(optional)Optional argument to pass to
expression.
Returns
Serializable
Locator.EvaluateAllAsync()
Added in: v1.14Execute JavaScript code in the page, taking all matching elements as an argument.
Details
Returns the return value of expression, called with an array of all matching elements as a first argument, and arg as a second argument.
If expression returns a [Promise], this method will wait for the promise to resolve and return its value.
If expression throws or rejects, this method throws.
Usage
var locator = page.Locator("div");
var moreThanTen = await locator.EvaluateAllAsync<bool>("(divs, min) => divs.length > min", 10);Arguments
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
argEvaluationArgument(optional)Optional argument to pass to
expression.
Returns
Serializable
Locator.EvaluateHandleAsync()
Added in: v1.14Execute 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 expression as aJSHandle, called with the matching element as a first argument, and arg as a second argument.
The only difference between Locator.EvaluateAsync() and Locator.EvaluateHandleAsync() is that Locator.EvaluateHandleAsync() returns JSHandle.
If expression returns a [Promise], this method will wait for the promise to resolve and return its value.
If expression throws or rejects, this method throws.
See Page.EvaluateHandleAsync() for more details.
Arguments
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
argEvaluationArgument(optional)Optional argument to pass to
expression.
Returns
JSHandle
Locator.FillAsync()
Added in: v1.14Set a value to the input field.
Usage
await page.GetByRole(AriaRole.Textbox).FillAsync("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.PressSequentiallyAsync().
Arguments
Value to set for the
<input>,<textarea>or[contenteditable]element.Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.Filter()
Added in: v1.22This method narrows existing locator according to the options, for example filters by text. It can be chained to filter multiple times.
Usage
var rowLocator = page.Locator("tr");
// ...
await rowLocator
.Filter(new() { HasText = "text in column 1" })
.Filter(new() {
Has = page.GetByRole(AriaRole.Button, new() { Name = "column 2 button" } )
})
.ScreenshotAsync();Arguments
Narrows down the results of the method to those which contain elements matching this relative locator. For example,
articlethat hastext=Playwrightmatches<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
contentthat hasdivin<article><content><div>Playwright</div></content></article>. However, looking forcontentthat hasarticle divwill fail, because the inner locator must be relative and should not use any elements outside thecontent.Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNotLocator(optional) Added in: v1.33Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example,
articlethat does not havedivmatches<article><span>Playwright</span></article>.Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNotTextstring(optional) Added in: v1.33Matches 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.
hasNotTextRegexRegExp(optional) Added in: v1.33Matches 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.
hasNotTextStringstring(optional) Added in: v1.33Matches 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.
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>.hasTextRegexRegExp(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>.hasTextStringstring(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>.visibleboolean(optional) Added in: v1.51Only matches visible or invisible elements. Prefer the
Locator.Visible()shortcut when matching only visible elements.
Returns
Locator
Locator.First()
Added in: v1.14Returns locator to the first matching element.
Returns
Locator
Locator.FocusAsync()
Added in: v1.14Calls focus on the matching element.
Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.FrameLocator()
Added in: v1.17When working with iframes, you can create a frame locator that will enter the iframe and allow locating elements in that iframe:
Usage
var locator = page.FrameLocator("iframe").GetByText("Submit");
await locator.ClickAsync();Arguments
Returns
FrameLocator
Locator.GetAttributeAsync()
Added in: v1.14Returns the matching element's attribute value.
:::warning[Asserting attributes]
If you need to assert an element's attribute, prefer LocatorAssertions.ToHaveAttributeAsync() to avoid flakiness. See assertions guide for more details. :::
Arguments
Attribute name to get the value for.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
null | string
Locator.GetByAltText()
Added in: v1.27Allows 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").ClickAsync();Arguments
Text to locate the element for.
Returns
Locator
Locator.GetByLabel()
Added in: v1.27Allows 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").FillAsync("john");
await page.GetByLabel("Password").FillAsync("secret");Arguments
Text to locate the element for.
Returns
Locator
Locator.GetByPlaceholder()
Added in: v1.27Allows 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")
.FillAsync("playwright@microsoft.com");Arguments
Text to locate the element for.
Returns
Locator
Locator.GetByRole()
Added in: v1.27Allows 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(AriaRole.Heading, new() { Name = "Sign up" }))
.ToBeVisibleAsync();
await page
.GetByRole(AriaRole.Checkbox, new() { Name = "Subscribe" })
.CheckAsync();
await page
.GetByRole(AriaRole.Button, new() {
NameRegex = new Regex("submit", RegexOptions.IgnoreCase)
})
.ClickAsync();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-checkedor native<input type=checkbox>controls.Learn more about
aria-checked.descriptionstring(optional) Added in: v1.60Option to match the accessible description. By default, matching is case-insensitive and searches for a substring, use
exactto control this behavior.Learn more about accessible description.
descriptionRegexRegExp(optional) Added in: v1.60Option to match the accessible description. By default, matching is case-insensitive and searches for a substring, use
exactto control this behavior.Learn more about accessible description.
descriptionStringstring(optional) Added in: v1.60Option to match the accessible description. By default, matching is case-insensitive and searches for a substring, use
exactto control this behavior.Learn more about accessible description.
An attribute that is usually set by
aria-disabledordisabled.INFO
Unlike most other attributes,
disabledis inherited through the DOM hierarchy. Learn more aboutaria-disabled.exactboolean(optional) Added in: v1.28Whether
nameanddescriptionare 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.includeHiddenboolean(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.Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use
exactto control this behavior.Learn more about accessible name.
Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use
exactto control this behavior.Learn more about accessible name.
Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use
exactto 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
Locator
Locator.GetByTestId()
Added in: v1.27Locate 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").ClickAsync();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.
Arguments
Returns
Locator
Locator.GetByText()
Added in: v1.27Allows 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", new() { Exact = true });
// Matches both <div>s
page.GetByText(new Regex("Hello"));
// Matches second <div>
page.GetByText(new Regex("^hello$", RegexOptions.IgnoreCase));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
Locator
Locator.GetByTitle()
Added in: v1.27Allows 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
Locator
Locator.HideHighlightAsync()
Added in: v1.60Hides the element highlight previously added by Locator.HighlightAsync().
Locator.HighlightAsync()
Added in: v1.20Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses Locator.HighlightAsync().
Arguments
Returns
Disposable
Locator.HoverAsync()
Added in: v1.14Hover over the matching element.
Usage
await page.GetByRole(AriaRole.Link).HoverAsync();Details
This method hovers over the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto hover over the center of the element, or the specifiedposition.
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.modifiersArray<"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.
noWaitAfterboolean(optional) Added in: v1.28This 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.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls 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.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.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 keyboardmodifierswill be pressed regardless oftrialto allow testing elements which are only visible when those keys are pressed.
Locator.InnerHTMLAsync()
Added in: v1.14Returns the element.innerHTML.
Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
string
Locator.InnerTextAsync()
Added in: v1.14Returns the element.innerText.
:::warning[Asserting text]
If you need to assert text on the page, prefer LocatorAssertions.ToHaveTextAsync() with useInnerText option to avoid flakiness. See assertions guide for more details. :::
Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
string
Locator.InputValueAsync()
Added in: v1.14Returns the value for the matching <input> or <textarea> or <select> element.
:::warning[Asserting value]
If you need to assert input value, prefer LocatorAssertions.ToHaveValueAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
String value = await page.GetByRole(AriaRole.Textbox).InputValueAsync();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
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
string
Locator.IsCheckedAsync()
Added in: v1.14Returns 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.ToBeCheckedAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
var isChecked = await page.GetByRole(AriaRole.Checkbox).IsCheckedAsync();Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
boolean
Locator.IsDisabledAsync()
Added in: v1.14Returns 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.ToBeDisabledAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
Boolean disabled = await page.GetByRole(AriaRole.Button).IsDisabledAsync();Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
boolean
Locator.IsEditableAsync()
Added in: v1.14Returns 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.ToBeEditableAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
Boolean editable = await page.GetByRole(AriaRole.Textbox).IsEditableAsync();Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
boolean
Locator.IsEnabledAsync()
Added in: v1.14Returns whether the element is enabled.
:::warning[Asserting enabled state]
If you need to assert that an element is enabled, prefer LocatorAssertions.ToBeEnabledAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
Boolean enabled = await page.GetByRole(AriaRole.Button).IsEnabledAsync();Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
boolean
Locator.IsHiddenAsync()
Added in: v1.14Returns whether the element is hidden, the opposite of visible.
:::warning[Asserting visibility]
If you need to assert that element is hidden, prefer LocatorAssertions.ToBeHiddenAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
Boolean hidden = await page.GetByRole(AriaRole.Button).IsHiddenAsync();Arguments
optionsObject(optional)timeoutfloat(optional)
Returns
boolean
Locator.IsVisibleAsync()
Added in: v1.14Returns whether the element is visible.
:::warning[Asserting visibility]
If you need to assert that element is visible, prefer LocatorAssertions.ToBeVisibleAsync() to avoid flakiness. See assertions guide for more details. :::
Usage
Boolean visible = await page.GetByRole(AriaRole.Button).IsVisibleAsync();Arguments
Returns
boolean
Locator.Last()
Added in: v1.14Returns locator to the last matching element.
Usage
var banana = page.GetByRole(AriaRole.Listitem).Last;Returns
Locator
Locator.Locator()
Added in: v1.14The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options, similar to Locator.Filter() method.
Arguments
selectorOrLocatorstring | LocatorA 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,
articlethat hastext=Playwrightmatches<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
contentthat hasdivin<article><content><div>Playwright</div></content></article>. However, looking forcontentthat hasarticle divwill fail, because the inner locator must be relative and should not use any elements outside thecontent.Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNotLocator(optional) Added in: v1.33Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example,
articlethat does not havedivmatches<article><span>Playwright</span></article>.Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNotTextstring(optional) Added in: v1.33Matches 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.
hasNotTextRegexRegExp(optional) Added in: v1.33Matches 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.
hasNotTextStringstring(optional) Added in: v1.33Matches 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.
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>.hasTextRegexRegExp(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>.hasTextStringstring(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
Locator
Locator.NormalizeAsync()
Added in: v1.59Returns 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.AriaSnapshotAsync() 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:
var normalized = await page.GetByRef("e2").NormalizeAsync();
Console.WriteLine(normalized.ToString());
// GetByRole(AriaRole.Button, new() { Name = "Submit" })Returns
Locator
Locator.Nth()
Added in: v1.14Returns locator to the n-th matching element. It's zero based, nth(0) selects the first element.
Usage
var banana = await page.GetByRole(AriaRole.Listitem).Nth(2);Arguments
Returns
Locator
Locator.Or()
Added in: v1.33Creates 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.
var newEmail = page.GetByRole(AriaRole.Button, new() { Name = "New" });
var dialog = page.GetByText("Confirm security settings");
await Expect(newEmail.Or(dialog).First).ToBeVisibleAsync();
if (await dialog.IsVisibleAsync())
await page.GetByRole(AriaRole.Button, new() { Name = "Dismiss" }).ClickAsync();
await newEmail.ClickAsync();Arguments
Returns
Locator
Locator.Page()
Added in: v1.19A page this locator belongs to.
Returns
Page
Locator.PressAsync()
Added in: v1.14Focuses the matching element and presses a combination of the keys.
Usage
await page.GetByRole(AriaRole.Textbox).PressAsync("Backspace");Details
Focuses the element, and then uses Keyboard.DownAsync() and Keyboard.UpAsync().
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
ArrowLeftora.Time to wait between
keydownandkeyupin milliseconds. Defaults to 0.noWaitAfterboolean(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.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.PressSequentiallyAsync()
Added in: v1.38TIP
In most cases, you should use Locator.FillAsync() 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.PressAsync().
Usage
await locator.PressSequentiallyAsync("Hello"); // Types instantly
await locator.PressSequentiallyAsync("World", new() { Delay = 100 }); // Types slower, like a userAn example of typing into a text field and then submitting the form:
var locator = page.GetByLabel("Password");
await locator.PressSequentiallyAsync("my password");
await locator.PressAsync("Enter");Arguments
String of characters to sequentially press into a focused element.
Time to wait between key presses in milliseconds. Defaults to 0.
noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.ScreenshotAsync()
Added in: v1.14Take a screenshot of the element matching the locator.
Usage
await page.GetByRole(AriaRole.Link).ScreenshotAsync();Disable animations and save screenshot to a file:
await page.GetByRole(AriaRole.Link).ScreenshotAsync(new() {
Animations = ScreenshotAnimations.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:- finite animations are fast-forwarded to completion, so they'll fire
transitionendevent. - infinite animations are canceled to initial state, and then played over after the screenshot.
Defaults to
"allow"that leaves animations untouched.- finite animations are fast-forwarded to completion, so they'll fire
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".maskArray<Locator>(optional)Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box
#FF00FF(customized bymaskColor) that completely covers its bounding box. The mask is also applied to invisible elements, see Matching only visible elements to disable that.maskColorstring(optional) Added in: v1.35Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink
#FF00FF.omitBackgroundboolean(optional)Hides default white background and allows capturing screenshots with transparency. Not applicable to
jpegimages. Defaults tofalse.The file path to save the image to. The screenshot type will be inferred from file extension. If
pathis 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
pngimages. Forjpegthe default is80. Forwebp, a quality of100(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".stylestring(optional) Added in: v1.41Text 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
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.type"png" | "jpeg" | "webp"(optional)Specify screenshot type, defaults to
png.
Returns
Buffer
Locator.ScrollIntoViewIfNeededAsync()
Added in: v1.14This 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
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.SelectOptionAsync()
Added in: v1.14Selects 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
await element.SelectOptionAsync(new[] { "blue" });
// single selection matching the label
await element.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection for blue, red and second option
await element.SelectOptionAsync(new[] { "red", "green", "blue" });Arguments
valuesnull | string | ElementHandle | Array<string> | Object | Array<ElementHandle> | Array<Object>Options to select. If the
<select>has themultipleattribute, 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.valuestring(optional)Matches by
option.value. Optional.labelstring(optional)Matches by
option.label. Optional.indexint(optional)Matches by the index. Optional.
Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
Array<string>
Locator.SelectTextAsync()
Added in: v1.14This 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.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.SetCheckedAsync()
Added in: v1.15Set the state of a checkbox or a radio element.
Usage
await page.GetByRole(AriaRole.Checkbox).SetCheckedAsync(true);Details
This method checks or unchecks an element by performing the following steps:
- Ensure that matched element is a checkbox or a radio input. If not, this method throws.
- If the element already has the right checked state, this method returns immediately.
- Wait for actionability checks on the matched element, unless
forceoption is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use
Page.Mouseto click in the center of the element. - Ensure that the element is now checked or unchecked. If not, 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 check or uncheck the checkbox.
Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(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.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls 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.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.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.
Locator.SetInputFilesAsync()
Added in: v1.14Upload 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").SetInputFilesAsync("myfile.pdf");
// Select multiple files
await page.GetByLabel("Upload files").SetInputFilesAsync(new[] { "file1.txt", "file12.txt" });
// Select a directory
await page.GetByLabel("Upload directory").SetInputFilesAsync("mydir");
// Remove all the selected files
await page.GetByLabel("Upload file").SetInputFilesAsync(new[] {});
// Upload buffer from memory
await page.GetByLabel("Upload file").SetInputFilesAsync(new FilePayload
{
Name = "file.txt",
MimeType = "text/plain",
Buffer = System.Text.Encoding.UTF8.GetBytes("this is a 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
filespath | Array<path> | Object | Array<Object>namestringFile name
mimeTypestringFile type
bufferBufferFile content
noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.TapAsync()
Added in: v1.14Perform 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:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Touchscreento tap the center of the element, or the specifiedposition.
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.modifiersArray<"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.
noWaitAfterboolean(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.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls 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.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.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 keyboardmodifierswill be pressed regardless oftrialto allow testing elements which are only visible when those keys are pressed.
Locator.TextContentAsync()
Added in: v1.14Returns the node.textContent.
:::warning[Asserting text]
If you need to assert text on the page, prefer LocatorAssertions.ToHaveTextAsync() to avoid flakiness. See assertions guide for more details. :::
Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
null | string
Locator.UncheckAsync()
Added in: v1.14Ensure that checkbox or radio element is unchecked.
Usage
await page.GetByRole(AriaRole.Checkbox).UncheckAsync();Details
This method unchecks the element by performing the following steps:
- Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto click in the center of the element. - Ensure that the element is now unchecked. If not, this method throws.
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.noWaitAfterboolean(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.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls 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.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.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.
Locator.Visible()
Added in: v1.63Returns 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.ClickAsync();To match invisible elements instead, use Locator.Filter() with the visible option set to false.
Returns
Locator
Locator.WaitForAsync()
Added in: v1.16Returns 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
var orderSent = page.Locator("#order-sent");
orderSent.WaitForAsync();Arguments
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 novisibility:hidden. Note that element without any content or withdisplay:nonehas 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 orvisibility:hidden. This is opposite to the'visible'option.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.WaitForFunctionAsync()
Added in: v1.62Returns when expression 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 expression returns a [Promise], this method will wait for the promise to resolve before checking its value.
If expression throws or rejects, this method throws.
Usage
Wait for an attribute to appear:
Passing argument to expression:
Arguments
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
argEvaluationArgument(optional)Optional argument to pass to
expression.Maximum time to wait for in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Locator.Within()
Added in: v1.64Returns 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
var thirdColumn = page.GetByRole(AriaRole.Cell).Nth(2).Within(page.GetByRole(AriaRole.Row));
await Expect(thirdColumn).ToHaveTextAsync(new[] { "Apple", "Banana", "Cherry" });Arguments
Returns
Locator
Deprecated
Locator.TypeAsync()
Added in: v1.14Deprecated
In most cases, you should use Locator.FillAsync() instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use Locator.PressSequentiallyAsync().
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.PressAsync().
Usage
Arguments
A text to type into a focused element.
Time to wait between key presses in milliseconds. Defaults to 0.
noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.