Frame
At every point of time, page exposes its current frame tree via the Page.MainFrame and Frame.ChildFrames methods.
Frame object's lifecycle is controlled by three events, dispatched on the page object:
- Page.FrameAttached - fired when the frame gets attached to the page. A Frame can be attached to the page only once.
- Page.FrameNavigated - fired when the frame commits navigation to a different URL.
- Page.FrameDetached - fired when the frame gets detached from the page. A Frame can be detached from the page only once.
An example of dumping frame tree:
using Microsoft.Playwright;
using System;
using System.Threading.Tasks;
class FrameExamples
{
public static async Task Main()
{
using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Firefox.LaunchAsync();
var page = await browser.NewPageAsync();
await page.GotoAsync("https://www.bing.com");
DumpFrameTree(page.MainFrame, string.Empty);
}
private static void DumpFrameTree(IFrame frame, string indent)
{
Console.WriteLine($"{indent}{frame.Url}");
foreach (var child in frame.ChildFrames)
DumpFrameTree(child, indent + " ");
}
}
Methods
AddScriptTagAsync
Added before v1.9Returns the added tag when the script's onload fires or when the script content was injected into frame.
Adds a <script>
tag into the page with the desired url or content.
Usage
await Frame.AddScriptTagAsync(options);
Arguments
options
FrameAddScriptTagOptions?
(optional)-
Raw JavaScript content to be injected into frame.
-
Path to the JavaScript file to be injected into frame. If
path
is a relative path, then it is resolved relative to the current working directory. -
Script type. Use 'module' in order to load a JavaScript ES6 module. See script for more details.
-
URL of a script to be added.
-
Returns
AddStyleTagAsync
Added before v1.9Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
Adds a <link rel="stylesheet">
tag into the page with the desired url or a <style type="text/css">
tag with the content.
Usage
await Frame.AddStyleTagAsync(options);
Arguments
options
FrameAddStyleTagOptions?
(optional)
Returns
ChildFrames
Added before v1.9Usage
Frame.ChildFrames
Returns
ContentAsync
Added before v1.9Gets the full HTML contents of the frame, including the doctype.
Usage
await Frame.ContentAsync();
Returns
DragAndDropAsync
Added in: v1.13Usage
await Frame.DragAndDropAsync(source, target, options);
Arguments
-
A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will be used.
-
A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameDragAndDropOptions?
(optional)-
Whether to bypass the actionability checks. Defaults to
false
. -
Deprecated
This option has no effect.
This option has no effect.
-
SourcePosition
SourcePosition? (optional) Added in: v1.14#-
X
[float] -
Y
[float]
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.
-
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
TargetPosition
TargetPosition? (optional) Added in: v1.14#-
X
[float] -
Y
[float]
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.
-
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods. -
When set, this method only performs the actionability checks and skips the action. Defaults to
false
. Useful to wait until the element is ready for the action without performing it.
-
Returns
EvaluateAsync
Added before v1.9Returns the return value of expression.
If the function passed to the Frame.EvaluateAsync() returns a Promise, then Frame.EvaluateAsync() would wait for the promise to resolve and return its value.
If the function passed to the Frame.EvaluateAsync() returns a non-Serializable value, then Frame.EvaluateAsync() returns undefined
. Playwright also supports transferring some additional values that are not serializable by JSON
: -0
, NaN
, Infinity
, -Infinity
.
Usage
var result = await frame.EvaluateAsync<int>("([x, y]) => Promise.resolve(x * y)", new[] { 7, 8 });
Console.WriteLine(result);
A string can also be passed in instead of a function.
Console.WriteLine(await frame.EvaluateAsync<int>("1 + 2")); // prints "3"
ElementHandle instances can be passed as an argument to the Frame.EvaluateAsync():
var bodyHandle = await frame.EvaluateAsync("document.body");
var html = await frame.EvaluateAsync<string>("([body, suffix]) => body.innerHTML + suffix", new object [] { bodyHandle, "hello" });
await bodyHandle.DisposeAsync();
Arguments
-
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
-
arg
EvaluationArgument? (optional)#Optional argument to pass to expression.
Returns
- [object]#
EvaluateHandleAsync
Added before v1.9Returns the return value of expression as a JSHandle.
The only difference between Frame.EvaluateAsync() and Frame.EvaluateHandleAsync() is that Frame.EvaluateHandleAsync() returns JSHandle.
If the function, passed to the Frame.EvaluateHandleAsync(), returns a Promise, then Frame.EvaluateHandleAsync() would wait for the promise to resolve and return its value.
Usage
// Handle for the window object.
var aWindowHandle = await frame.EvaluateHandleAsync("() => Promise.resolve(window)");
A string can also be passed in instead of a function.
var docHandle = await frame.EvaluateHandleAsync("document"); // Handle for the `document`
JSHandle instances can be passed as an argument to the Frame.EvaluateHandleAsync():
var handle = await frame.EvaluateHandleAsync("() => document.body");
var resultHandle = await frame.EvaluateHandleAsync("([body, suffix]) => body.innerHTML + suffix", new object[] { handle, "hello" });
Console.WriteLine(await resultHandle.JsonValueAsync<string>());
await resultHandle.DisposeAsync();
Arguments
-
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
-
arg
EvaluationArgument? (optional)#Optional argument to pass to expression.
Returns
FrameElementAsync
Added before v1.9Returns the frame
or iframe
element handle which corresponds to this frame.
This is an inverse of ElementHandle.ContentFrameAsync(). Note that returned handle actually belongs to the parent frame.
This method throws an error if the frame has been detached before frameElement()
returns.
Usage
var frameElement = await frame.FrameElementAsync();
var contentFrame = await frameElement.ContentFrameAsync();
Console.WriteLine(frame == contentFrame); // -> True
Returns
FrameLocator
Added in: v1.17When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in that iframe.
Usage
Following snippet locates element with text "Submit" in the iframe with id my-frame
, like <iframe id="my-frame">
:
var locator = frame.FrameLocator("#my-iframe").GetByText("Submit");
await locator.ClickAsync();
Arguments
Returns
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.
-
options
FrameGetByAltTextOptions?
(optional)
Returns
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.
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.
-
options
FrameGetByLabelOptions?
(optional)
Returns
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.
-
options
FrameGetByPlaceholderOptions?
(optional)
Returns
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 it's 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();
Arguments
-
role
enum AriaRole { 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.
-
options
FrameGetByRoleOptions?
(optional)-
An attribute that is usually set by
aria-checked
or native<input type=checkbox>
controls.Learn more about
aria-checked
. -
An attribute that is usually set by
aria-disabled
ordisabled
.noteUnlike most other attributes,
disabled
is inherited through the DOM hierarchy. Learn more aboutaria-disabled
. -
Exact
bool? (optional) Added in: v1.28#Whether Name|NameRegex is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when Name|NameRegex is a regular expression. Note that exact match still trims whitespace.
-
An attribute that is usually set by
aria-expanded
.Learn more about
aria-expanded
. -
IncludeHidden
bool? (optional)#Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.
Learn more about
aria-hidden
. -
A number attribute that is usually present for roles
heading
,listitem
,row
,treeitem
, with default values for<h1>-<h6>
elements.Learn more about
aria-level
. -
Name|NameRegex
string? | Regex? (optional)#Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use Exact to control this behavior.
Learn more about accessible name.
-
An attribute that is usually set by
aria-pressed
.Learn more about
aria-pressed
. -
An attribute that is usually set by
aria-selected
.Learn more about
aria-selected
.
-
Returns
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.
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 it's test id:
await page.GetByTestId("directions").ClickAsync();
Arguments
Returns
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.
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));
Arguments
-
Text to locate the element for.
-
options
FrameGetByTextOptions?
(optional)
Returns
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">
.
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.
-
options
FrameGetByTitleOptions?
(optional)
Returns
GotoAsync
Added before v1.9Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
The method will throw an error if:
- there's an SSL error (e.g. in case of self-signed certificates).
- target URL is invalid.
- the Timeout is exceeded during navigation.
- the remote server does not respond or is unreachable.
- the main resource failed to load.
The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling Response.Status.
The method either throws an error or returns a main resource response. The only exceptions are navigation to about:blank
or navigation to the same URL with a different hash, which would succeed and return null
.
Headless mode doesn't support navigation to a PDF document. See the upstream issue.
Usage
await Frame.GotoAsync(url, options);
Arguments
-
URL to navigate frame to. The url should include scheme, e.g.
https://
. -
options
FrameGotoOptions?
(optional)-
Referer header value. If provided it will take preference over the referer header value set by Page.SetExtraHTTPHeadersAsync().
-
Timeout
[float]? (optional)#Maximum operation time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultNavigationTimeout(), BrowserContext.SetDefaultTimeout(), Page.SetDefaultNavigationTimeout() or Page.SetDefaultTimeout() methods. -
WaitUntil
enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?
(optional)#When to consider operation succeeded, defaults to
load
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- DISCOURAGED consider operation to be finished when there are no network connections for at least500
ms. Don't use this method for testing, rely on web assertions to assess readiness instead.'commit'
- consider operation to be finished when network response is received and the document started loading.
-
Returns
IsDetached
Added before v1.9Returns true
if the frame has been detached, or false
otherwise.
Usage
Frame.IsDetached
Returns
IsEnabledAsync
Added before v1.9Returns whether the element is enabled.
Usage
await Frame.IsEnabledAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameIsEnabledOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
Locator
Added in: v1.14The method returns an element locator that can be used to perform actions on this page / frame. Locator is resolved to the element immediately before performing an action, so a series of actions on the same locator can in fact be performed on different DOM elements. That would happen if the DOM structure between those actions has changed.
Usage
Frame.Locator(selector, options);
Arguments
-
A selector to use when resolving DOM element.
-
options
FrameLocatorOptions?
(optional)-
Narrows down the results of the method to those which contain elements matching this relative locator. For example,
article
that hastext=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 hasdiv
in<article><content><div>Playwright</div></content></article>
. However, looking forcontent
that hasarticle div
will 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.
-
HasNot
Locator? (optional) Added in: v1.33#Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example,
article
that does not havediv
matches<article><span>Playwright</span></article>
.Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
-
HasNotText|HasNotTextRegex
string? | Regex? (optional) Added in: v1.33#Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element. When passed a string, matching is case-insensitive and searches for a substring.
-
HasText|HasTextRegex
string? | Regex? (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
Name
Added before v1.9Returns frame's name attribute as specified in the tag.
If the name is empty, returns the id attribute instead.
This value is calculated once when the frame is created, and will not update if the attribute is changed later.
Usage
Frame.Name
Returns
Page
Added before v1.9Returns the page containing this frame.
Usage
Frame.Page
Returns
ParentFrame
Added before v1.9Parent frame, if any. Detached frames and main frames return null
.
Usage
Frame.ParentFrame
Returns
SetContentAsync
Added before v1.9This method internally calls document.write(), inheriting all its specific characteristics and behaviors.
Usage
await Frame.SetContentAsync(html, options);
Arguments
-
HTML markup to assign to the page.
-
options
FrameSetContentOptions?
(optional)-
Timeout
[float]? (optional)#Maximum operation time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultNavigationTimeout(), BrowserContext.SetDefaultTimeout(), Page.SetDefaultNavigationTimeout() or Page.SetDefaultTimeout() methods. -
WaitUntil
enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?
(optional)#When to consider operation succeeded, defaults to
load
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- DISCOURAGED consider operation to be finished when there are no network connections for at least500
ms. Don't use this method for testing, rely on web assertions to assess readiness instead.'commit'
- consider operation to be finished when network response is received and the document started loading.
-
Returns
TitleAsync
Added before v1.9Returns the page title.
Usage
await Frame.TitleAsync();
Returns
Url
Added before v1.9Returns frame's url.
Usage
Frame.Url
Returns
WaitForFunctionAsync
Added before v1.9Returns when the expression returns a truthy value, returns that value.
Usage
The Frame.WaitForFunctionAsync() can be used to observe viewport size change:
using Microsoft.Playwright;
using System.Threading.Tasks;
class FrameExamples
{
public static async Task Main()
{
using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Firefox.LaunchAsync();
var page = await browser.NewPageAsync();
await page.SetViewportSizeAsync(50, 50);
await page.MainFrame.WaitForFunctionAsync("window.innerWidth < 100");
}
}
To pass an argument to the predicate of frame.waitForFunction
function:
var selector = ".foo";
await page.MainFrame.WaitForFunctionAsync("selector => !!document.querySelector(selector)", selector);
Arguments
-
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
-
arg
EvaluationArgument? (optional)#Optional argument to pass to expression.
-
options
FrameWaitForFunctionOptions?
(optional)-
PollingInterval
[float]? (optional)#If specified, then it is treated as an interval in milliseconds at which the function would be executed. By default if the option is not specified expression is executed in
requestAnimationFrame
callback. -
Timeout
[float]? (optional)#Maximum time to wait for in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
WaitForLoadStateAsync
Added before v1.9Waits for the required load state to be reached.
This returns when the frame reaches a required load state, load
by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.
Most of the time, this method is not needed because Playwright auto-waits before every action.
Usage
await frame.ClickAsync("button");
await frame.WaitForLoadStateAsync(); // Defaults to LoadState.Load
Arguments
-
state
enum LoadState { Load, DOMContentLoaded, NetworkIdle }?
(optional)#Optional load state to wait for, defaults to
load
. If the state has been already reached while loading current document, the method resolves immediately. Can be one of:'load'
- wait for theload
event to be fired.'domcontentloaded'
- wait for theDOMContentLoaded
event to be fired.'networkidle'
- DISCOURAGED wait until there are no network connections for at least500
ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
-
options
FrameWaitForLoadStateOptions?
(optional)-
Timeout
[float]? (optional)#Maximum operation time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultNavigationTimeout(), BrowserContext.SetDefaultTimeout(), Page.SetDefaultNavigationTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
WaitForURLAsync
Added in: v1.11Waits for the frame to navigate to the given URL.
Usage
await frame.ClickAsync("a.delayed-navigation"); // clicking the link will indirectly cause a navigation
await frame.WaitForURLAsync("**/target.html");
Arguments
-
url
string | Regex | Func<string, bool>#A glob pattern, regex pattern or predicate receiving URL to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.
-
options
FrameWaitForURLOptions?
(optional)-
Timeout
[float]? (optional)#Maximum operation time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultNavigationTimeout(), BrowserContext.SetDefaultTimeout(), Page.SetDefaultNavigationTimeout() or Page.SetDefaultTimeout() methods. -
WaitUntil
enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?
(optional)#When to consider operation succeeded, defaults to
load
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- DISCOURAGED consider operation to be finished when there are no network connections for at least500
ms. Don't use this method for testing, rely on web assertions to assess readiness instead.'commit'
- consider operation to be finished when network response is received and the document started loading.
-
Returns
Deprecated
CheckAsync
Added before v1.9Use locator-based Locator.CheckAsync() instead. Read more about locators.
This method checks an element matching selector by performing the following steps:
- Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
- Ensure that matched 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 matched element, unless Force option is set. If the element is detached during the checks, the whole action is retried.
- Scroll the element into view if needed.
- Use Page.Mouse to click in the center of the element.
- Ensure that the element is now checked. 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.
Usage
await Frame.CheckAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameCheckOptions?
(optional)-
Whether to bypass the actionability checks. Defaults to
false
. -
Deprecated
This option has no effect.
This option has no effect.
-
Position
Position? (optional) Added in: v1.11#-
X
[float] -
Y
[float]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
-
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods. -
Trial
bool? (optional) Added in: v1.11#When set, this method only performs the actionability checks and skips the action. Defaults to
false
. Useful to wait until the element is ready for the action without performing it.
-
Returns
ClickAsync
Added before v1.9Use locator-based Locator.ClickAsync() instead. Read more about locators.
This method clicks an element matching selector by performing the following steps:
- Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
- Wait for actionability checks on the matched element, unless Force option is set. If the element is detached during the checks, the whole action is retried.
- Scroll the element into view if needed.
- Use Page.Mouse to click in the center of the element, or the specified Position.
- Wait for initiated navigations to either succeed or fail, unless 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.
Usage
await Frame.ClickAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameClickOptions?
(optional)-
Button
enum MouseButton { Left, Right, Middle }?
(optional)#Defaults to
left
. -
defaults to 1. See UIEvent.detail.
-
Delay
[float]? (optional)#Time to wait between
mousedown
andmouseup
in milliseconds. Defaults to 0. -
Whether to bypass the actionability checks. Defaults to
false
. -
Modifiers
IEnumerable?<enum KeyboardModifier { 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.
-
Deprecated
This option will default to
true
in the future.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
. -
Position
Position? (optional)#-
X
[float] -
Y
[float]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
-
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods. -
Trial
bool? (optional) Added in: v1.11#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 keyboardmodifiers
will be pressed regardless oftrial
to allow testing elements which are only visible when those keys are pressed.
-
Returns
DblClickAsync
Added before v1.9Use locator-based Locator.DblClickAsync() instead. Read more about locators.
This method double clicks an element matching selector by performing the following steps:
- Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
- Wait for actionability checks on the matched element, unless Force option is set. If the element is detached during the checks, the whole action is retried.
- Scroll the element into view if needed.
- Use Page.Mouse to double click in the center of the element, or the specified Position. if the first click of the
dblclick()
triggers a navigation event, this method will throw.
When all steps combined have not finished during the specified Timeout, this method throws a TimeoutError. Passing zero timeout disables this.
frame.dblclick()
dispatches two click
events and a single dblclick
event.
Usage
await Frame.DblClickAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameDblClickOptions?
(optional)-
Button
enum MouseButton { Left, Right, Middle }?
(optional)#Defaults to
left
. -
Delay
[float]? (optional)#Time to wait between
mousedown
andmouseup
in milliseconds. Defaults to 0. -
Whether to bypass the actionability checks. Defaults to
false
. -
Modifiers
IEnumerable?<enum KeyboardModifier { 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.
-
Deprecated
This option has no effect.
This option has no effect.
-
Position
Position? (optional)#-
X
[float] -
Y
[float]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
-
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods. -
Trial
bool? (optional) Added in: v1.11#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 keyboardmodifiers
will be pressed regardless oftrial
to allow testing elements which are only visible when those keys are pressed.
-
Returns
DispatchEventAsync
Added before v1.9Use locator-based Locator.DispatchEventAsync() instead. Read more about locators.
The snippet below 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().
Usage
await frame.DispatchEventAsync("button#submit", "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:
// Note you can only create DataTransfer in Chromium and Firefox
var dataTransfer = await frame.EvaluateHandleAsync("() => new DataTransfer()");
await frame.DispatchEventAsync("#source", "dragstart", new { dataTransfer });
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
DOM event type:
"click"
,"dragstart"
, etc. -
eventInit
EvaluationArgument? (optional)#Optional event-specific initialization properties.
-
options
FrameDispatchEventOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
EvalOnSelectorAsync
Added in: v1.9This method does not wait for the element to pass the actionability checks and therefore can lead to the flaky tests. Use Locator.EvaluateAsync(), other Locator helper methods or web-first assertions instead.
Returns the return value of expression.
The method finds an element matching the specified selector within the frame and passes it as a first argument to expression. If no elements match the selector, the method throws an error.
If expression returns a Promise, then Frame.EvalOnSelectorAsync() would wait for the promise to resolve and return its value.
Usage
var searchValue = await frame.EvalOnSelectorAsync<string>("#search", "el => el.value");
var preloadHref = await frame.EvalOnSelectorAsync<string>("link[rel=preload]", "el => el.href");
var html = await frame.EvalOnSelectorAsync(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");
Arguments
-
A selector to query for.
-
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
-
arg
EvaluationArgument? (optional)#Optional argument to pass to expression.
-
options
FrameEvalOnSelectorOptions?
(optional)
Returns
- [object]#
EvalOnSelectorAllAsync
Added in: v1.9In most cases, Locator.EvaluateAllAsync(), other Locator helper methods and web-first assertions do a better job.
Returns the return value of expression.
The method finds all elements matching the specified selector within the frame and passes an array of matched elements as a first argument to expression.
If expression returns a Promise, then Frame.EvalOnSelectorAllAsync() would wait for the promise to resolve and return its value.
Usage
var divsCount = await frame.EvalOnSelectorAllAsync<bool>("div", "(divs, min) => divs.length >= min", 10);
Arguments
-
A selector to query for.
-
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
-
arg
EvaluationArgument? (optional)#Optional argument to pass to expression.
Returns
- [object]#
FillAsync
Added before v1.9Use locator-based Locator.FillAsync() instead. Read more about locators.
This method waits for an element matching selector, 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().
Usage
await Frame.FillAsync(selector, value, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
Value to fill for the
<input>
,<textarea>
or[contenteditable]
element. -
options
FrameFillOptions?
(optional)-
Force
bool? (optional) Added in: v1.13#Whether to bypass the actionability checks. Defaults to
false
. -
Deprecated
This option has no effect.
This option has no effect.
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
FocusAsync
Added before v1.9Use locator-based Locator.FocusAsync() instead. Read more about locators.
This method fetches an element with selector and focuses it. If there's no element matching selector, the method waits until a matching element appears in the DOM.
Usage
await Frame.FocusAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameFocusOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
GetAttributeAsync
Added before v1.9Use locator-based Locator.GetAttributeAsync() instead. Read more about locators.
Returns element attribute value.
Usage
await Frame.GetAttributeAsync(selector, name, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
Attribute name to get the value for.
-
options
FrameGetAttributeOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
HoverAsync
Added before v1.9Use locator-based Locator.HoverAsync() instead. Read more about locators.
This method hovers over an element matching selector by performing the following steps:
- Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
- Wait for actionability checks on the matched element, unless Force option is set. If the element is detached during the checks, the whole action is retried.
- Scroll the element into view if needed.
- Use Page.Mouse to hover over the center of the element, or the specified Position.
When all steps combined have not finished during the specified Timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Usage
await Frame.HoverAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameHoverOptions?
(optional)-
Whether to bypass the actionability checks. Defaults to
false
. -
Modifiers
IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }
> (optional)#Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
-
NoWaitAfter
bool? (optional) Added in: v1.28#DeprecatedThis option has no effect.
This option has no effect.
-
Position
Position? (optional)#-
X
[float] -
Y
[float]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
-
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods. -
Trial
bool? (optional) Added in: v1.11#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 keyboardmodifiers
will be pressed regardless oftrial
to allow testing elements which are only visible when those keys are pressed.
-
Returns
InnerHTMLAsync
Added before v1.9Use locator-based Locator.InnerHTMLAsync() instead. Read more about locators.
Returns element.innerHTML
.
Usage
await Frame.InnerHTMLAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameInnerHTMLOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
InnerTextAsync
Added before v1.9Use locator-based Locator.InnerTextAsync() instead. Read more about locators.
Returns element.innerText
.
Usage
await Frame.InnerTextAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameInnerTextOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
InputValueAsync
Added in: v1.13Use locator-based Locator.InputValueAsync() instead. Read more about locators.
Returns input.value
for the selected <input>
or <textarea>
or <select>
element.
Throws for non-input elements. However, if the element is inside the <label>
element that has an associated control, returns the value of the control.
Usage
await Frame.InputValueAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameInputValueOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
IsCheckedAsync
Added before v1.9Use locator-based Locator.IsCheckedAsync() instead. Read more about locators.
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
Usage
await Frame.IsCheckedAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameIsCheckedOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
IsDisabledAsync
Added before v1.9Use locator-based Locator.IsDisabledAsync() instead. Read more about locators.
Returns whether the element is disabled, the opposite of enabled.
Usage
await Frame.IsDisabledAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameIsDisabledOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
IsEditableAsync
Added before v1.9Use locator-based Locator.IsEditableAsync() instead. Read more about locators.
Returns whether the element is editable.
Usage
await Frame.IsEditableAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameIsEditableOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
IsHiddenAsync
Added before v1.9Use locator-based Locator.IsHiddenAsync() instead. Read more about locators.
Returns whether the element is hidden, the opposite of visible. selector that does not match any elements is considered hidden.
Usage
await Frame.IsHiddenAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameIsHiddenOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#DeprecatedThis option is ignored. Frame.IsHiddenAsync() does not wait for the element to become hidden and returns immediately.
-
Returns
IsVisibleAsync
Added before v1.9Use locator-based Locator.IsVisibleAsync() instead. Read more about locators.
Returns whether the element is visible. selector that does not match any elements is considered not visible.
Usage
await Frame.IsVisibleAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameIsVisibleOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#DeprecatedThis option is ignored. Frame.IsVisibleAsync() does not wait for the element to become visible and returns immediately.
-
Returns
PressAsync
Added before v1.9Use locator-based Locator.PressAsync() instead. Read more about locators.
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.
Usage
await Frame.PressAsync(selector, key, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
Name of the key to press or a character to generate, such as
ArrowLeft
ora
. -
options
FramePressOptions?
(optional)-
Delay
[float]? (optional)#Time to wait between
keydown
andkeyup
in milliseconds. Defaults to 0. -
Deprecated
This option will default to
true
in the future.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
. -
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
QuerySelectorAsync
Added in: v1.9Use locator-based Frame.Locator() instead. Read more about locators.
Returns the ElementHandle pointing to the frame element.
The use of ElementHandle is discouraged, use Locator objects and web-first assertions instead.
The method finds an element matching the specified selector within the frame. If no elements match the selector, returns null
.
Usage
await Frame.QuerySelectorAsync(selector, options);
Arguments
-
A selector to query for.
-
options
FrameQuerySelectorOptions?
(optional)
Returns
QuerySelectorAllAsync
Added in: v1.9Use locator-based Frame.Locator() instead. Read more about locators.
Returns the ElementHandles pointing to the frame elements.
The use of ElementHandle is discouraged, use Locator objects instead.
The method finds all elements matching the specified selector within the frame. If no elements match the selector, returns empty array.
Usage
await Frame.QuerySelectorAllAsync(selector);
Arguments
Returns
RunAndWaitForNavigationAsync
Added before v1.9This method is inherently racy, please use Frame.WaitForURLAsync() instead.
Waits for the frame navigation and returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with null
.
Usage
This method waits for the frame to navigate to a new URL. It is useful for when you run code which will indirectly cause the frame to navigate. Consider this example:
await frame.RunAndWaitForNavigationAsync(async () =>
{
// Clicking the link will indirectly cause a navigation.
await frame.ClickAsync("a.delayed-navigation");
});
// Resolves after navigation has finished
Usage of the History API to change the URL is considered a navigation.
Arguments
-
action
Func<Task> Added in: v1.12#Action that triggers the event.
-
options
FrameRunAndWaitForNavigationOptions?
(optional)-
Timeout
[float]? (optional)#Maximum operation time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultNavigationTimeout(), BrowserContext.SetDefaultTimeout(), Page.SetDefaultNavigationTimeout() or Page.SetDefaultTimeout() methods. -
Url|UrlRegex|UrlFunc
string? | Regex? | Func<string?, bool> (optional)#A glob pattern, regex pattern or predicate receiving URL to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.
-
WaitUntil
enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?
(optional)#When to consider operation succeeded, defaults to
load
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- DISCOURAGED consider operation to be finished when there are no network connections for at least500
ms. Don't use this method for testing, rely on web assertions to assess readiness instead.'commit'
- consider operation to be finished when network response is received and the document started loading.
-
Returns
WaitForNavigationAsync
Added before v1.9This method is inherently racy, please use Frame.WaitForURLAsync() instead.
Waits for the frame navigation and returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with null
.
Usage
This method waits for the frame to navigate to a new URL. It is useful for when you run code which will indirectly cause the frame to navigate. Consider this example:
await frame.RunAndWaitForNavigationAsync(async () =>
{
// Clicking the link will indirectly cause a navigation.
await frame.ClickAsync("a.delayed-navigation");
});
// Resolves after navigation has finished
Usage of the History API to change the URL is considered a navigation.
Arguments
options
FrameRunAndWaitForNavigationOptions?
(optional)-
Timeout
[float]? (optional)#Maximum operation time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultNavigationTimeout(), BrowserContext.SetDefaultTimeout(), Page.SetDefaultNavigationTimeout() or Page.SetDefaultTimeout() methods. -
Url|UrlRegex|UrlFunc
string? | Regex? | Func<string?, bool> (optional)#A glob pattern, regex pattern or predicate receiving URL to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.
-
WaitUntil
enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?
(optional)#When to consider operation succeeded, defaults to
load
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- DISCOURAGED consider operation to be finished when there are no network connections for at least500
ms. Don't use this method for testing, rely on web assertions to assess readiness instead.'commit'
- consider operation to be finished when network response is received and the document started loading.
-
Returns
SelectOptionAsync
Added before v1.9Use locator-based Locator.SelectOptionAsync() instead. Read more about locators.
This method waits for an element matching selector, 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
// Single selection matching the value or label
await frame.SelectOptionAsync("select#colors", new[] { "blue" });
// single selection matching both the value and the label
await frame.SelectOptionAsync("select#colors", new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection
await frame.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" });
Arguments
-
A selector to query for.
-
values
string | ElementHandle | IEnumerable |SelectOption
| IEnumerable | IEnumerable?#-
Value
string? (optional)Matches by
option.value
. Optional. -
Label
string? (optional)Matches by
option.label
. Optional. -
Index
int? (optional)Matches by the index. Optional.
Options to select. If the
<select>
has themultiple
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. -
-
options
FrameSelectOptionOptions?
(optional)-
Force
bool? (optional) Added in: v1.13#Whether to bypass the actionability checks. Defaults to
false
. -
Deprecated
This option has no effect.
This option has no effect.
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
SetCheckedAsync
Added in: v1.15Use locator-based Locator.SetCheckedAsync() instead. Read more about locators.
This method checks or unchecks an element matching selector by performing the following steps:
- Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
- 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 Force option is set. If the element is detached during the checks, the whole action is retried.
- Scroll the element into view if needed.
- Use Page.Mouse to 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.
Usage
await Frame.SetCheckedAsync(selector, checked, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
Whether to check or uncheck the checkbox.
-
options
FrameSetCheckedOptions?
(optional)-
Whether to bypass the actionability checks. Defaults to
false
. -
Deprecated
This option has no effect.
This option has no effect.
-
Position
Position? (optional)#-
X
[float] -
Y
[float]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
-
-
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods. -
When set, this method only performs the actionability checks and skips the action. Defaults to
false
. Useful to wait until the element is ready for the action without performing it.
-
Returns
SetInputFilesAsync
Added before v1.9Use locator-based Locator.SetInputFilesAsync() instead. Read more about locators.
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 selector to point to an input element. However, if the element is inside the <label>
element that has an associated control, targets the control instead.
Usage
await Frame.SetInputFilesAsync(selector, files, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
files
string | IEnumerable<string> |FilePayload
| IEnumerable<FilePayload
># -
options
FrameSetInputFilesOptions?
(optional)-
Deprecated
This option has no effect.
This option has no effect.
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
TapAsync
Added before v1.9Use locator-based Locator.TapAsync() instead. Read more about locators.
This method taps an element matching selector by performing the following steps:
- Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
- Wait for actionability checks on the matched element, unless Force option is set. If the element is detached during the checks, the whole action is retried.
- Scroll the element into view if needed.
- Use Page.Touchscreen to tap the center of the element, or the specified Position.
When all steps combined have not finished during the specified Timeout, this method throws a TimeoutError. Passing zero timeout disables this.
frame.tap()
requires that the hasTouch
option of the browser context be set to true.
Usage
await Frame.TapAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameTapOptions?
(optional)-
Whether to bypass the actionability checks. Defaults to
false
. -
Modifiers
IEnumerable?<enum KeyboardModifier { 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.
-
Deprecated
This option has no effect.
This option has no effect.
-
Position
Position? (optional)#-
X
[float] -
Y
[float]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
-
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods. -
Trial
bool? (optional) Added in: v1.11#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 keyboardmodifiers
will be pressed regardless oftrial
to allow testing elements which are only visible when those keys are pressed.
-
Returns
TextContentAsync
Added before v1.9Use locator-based Locator.TextContentAsync() instead. Read more about locators.
Returns element.textContent
.
Usage
await Frame.TextContentAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameTextContentOptions?
(optional)-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
TypeAsync
Added before v1.9In 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().
Sends a keydown
, keypress
/input
, and keyup
event for each character in the text. frame.type
can be used to send fine-grained keyboard events. To fill values in form fields, use Frame.FillAsync().
To press a special key, like Control
or ArrowDown
, use Keyboard.PressAsync().
Usage
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
A text to type into a focused element.
-
options
FrameTypeOptions?
(optional)-
Delay
[float]? (optional)#Time to wait between key presses in milliseconds. Defaults to 0.
-
Deprecated
This option has no effect.
This option has no effect.
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
UncheckAsync
Added before v1.9Use locator-based Locator.UncheckAsync() instead. Read more about locators.
This method checks an element matching selector by performing the following steps:
- Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
- Ensure that matched 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 matched element, unless Force option is set. If the element is detached during the checks, the whole action is retried.
- Scroll the element into view if needed.
- Use Page.Mouse to click in the center of the element.
- Ensure that the element is now 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.
Usage
await Frame.UncheckAsync(selector, options);
Arguments
-
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
-
options
FrameUncheckOptions?
(optional)-
Whether to bypass the actionability checks. Defaults to
false
. -
Deprecated
This option has no effect.
This option has no effect.
-
Position
Position? (optional) Added in: v1.11#-
X
[float] -
Y
[float]
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
-
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods. -
Trial
bool? (optional) Added in: v1.11#When set, this method only performs the actionability checks and skips the action. Defaults to
false
. Useful to wait until the element is ready for the action without performing it.
-
Returns
WaitForSelectorAsync
Added before v1.9Use web assertions that assert visibility or a locator-based Locator.WaitForAsync() instead. Read more about locators.
Returns when element specified by selector satisfies State option. Returns null
if waiting for hidden
or detached
.
Playwright automatically waits for element to be ready before performing an action. Using Locator objects and web-first assertions make the code wait-for-selector-free.
Wait for the selector to satisfy State option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the Timeout milliseconds, the function will throw.
Usage
This method works across navigations:
using Microsoft.Playwright;
using System;
using System.Threading.Tasks;
class FrameExamples
{
public static async Task Main()
{
using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Chromium.LaunchAsync();
var page = await browser.NewPageAsync();
foreach (var currentUrl in new[] { "https://www.google.com", "https://bbc.com" })
{
await page.GotoAsync(currentUrl);
element = await page.MainFrame.WaitForSelectorAsync("img");
Console.WriteLine($"Loaded image: {await element.GetAttributeAsync("src")}");
}
}
}
Arguments
-
A selector to query for.
-
options
FrameWaitForSelectorOptions?
(optional)-
State
enum WaitForSelectorState { 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: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 orvisibility:hidden
. This is opposite to the'visible'
option.
-
Strict
bool? (optional) Added in: v1.14#When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
-
Timeout
[float]? (optional)#Maximum time in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout() or Page.SetDefaultTimeout() methods.
-
Returns
WaitForTimeoutAsync
Added before v1.9Never wait for timeout in production. Tests that wait for time are inherently flaky. Use Locator actions and web assertions that wait automatically.
Waits for the given timeout in milliseconds.
Note that frame.waitForTimeout()
should only be used for debugging. Tests using the timer in production are going to be flaky. Use signals such as network events, selectors becoming visible and others instead.
Usage
await Frame.WaitForTimeoutAsync(timeout);
Arguments
-
timeout
[float]#A timeout to wait for
Returns