Frame

在任何时刻，页面都会通过 Page.MainFrame 和 Frame.ChildFrames 方法公开其当前的框架树。

Frame 对象的生命周期由在页面对象上派发的三个事件控制：

Page.FrameAttached - 当框架附加到页面时触发。一个框架只能附加到页面一次。
Page.FrameNavigated - 当框架提交导航到不同的 URL 时触发。
Page.FrameDetached - 当框架从页面分离时触发。一个框架只能从页面分离一次。

转储框架树的示例：

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 + " ");
    }
}

方法

AddScriptTagAsync

在 v1.9 之前添加

frame.AddScriptTagAsync

当脚本的 onload 触发或脚本内容注入到框架中时，返回添加的标签。

将带有所需 URL 或内容的 <script> 标签添加到页面中。

用法

await Frame.AddScriptTagAsync(options);

参数

options FrameAddScriptTagOptions?（可选）
- Content string?（可选）#
  
  要注入到框架中的原始 JavaScript 内容。
- Path string?（可选）#
  
  要注入到框架中的 JavaScript 文件的路径。如果 path 是相对路径，则相对于当前工作目录进行解析。
- Type string?（可选）#
  
  脚本类型。若要加载 JavaScript ES6 模块，请使用“module”。更多详细信息，请参阅 script。
- Url string?（可选）#
  
  要添加的脚本的 URL。

返回值

ElementHandle #

AddStyleTagAsync

在 v1.9 之前添加

frame.AddStyleTagAsync

当样式表的 onload 触发或 CSS 内容被注入到框架中时，返回添加的标签。

向页面添加一个带有所需 url 的 <link rel="stylesheet"> 标签，或添加一个带有内容的 <style type="text/css"> 标签。

用法

await Frame.AddStyleTagAsync(options);

参数

options FrameAddStyleTagOptions?（可选）
- Content string?（可选）#
  
  要注入到框架中的原始 CSS 内容。
- Path string?（可选）#
  
  要注入到框架中的 CSS 文件路径。如果 path 是相对路径，则相对于当前工作目录进行解析。
- Url string?（可选）#
  
  <link> 标签的 URL。

返回值

ElementHandle #

ChildFrames

在 v1.9 之前添加

frame.ChildFrames

用法

Frame.ChildFrames

返回值

IReadOnlyList<Frame>#

ContentAsync

在 v1.9 之前添加

frame.ContentAsync

获取框架的完整 HTML 内容，包括文档类型声明。

用法

await Frame.ContentAsync();

返回值

string #

DragAndDropAsync

添加于：v1.13

frame.DragAndDropAsync

用法

await Frame.DragAndDropAsync(source, target, options);

参数

source string #

用于搜索要拖动元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
target string #

用于搜索要放置到的元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameDragAndDropOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- SourcePosition SourcePosition?（可选）新增于：v1.14#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角的此点，点击源元素。如果未指定，则使用元素的某个可见点。
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，此调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，调用将抛出异常。
- TargetPosition TargetPosition?（可选）新增于：v1.14#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角的此点，放置到目标元素上。如果未指定，则使用元素的某个可见点。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作很有用。

返回值

void #

EvaluateAsync

在 v1.9 之前添加

frame.EvaluateAsync

返回 expression 的返回值。

如果传递给 Frame.EvaluateAsync() 的函数返回一个 Promise，则 Frame.EvaluateAsync() 将等待该 Promise 解决并返回其值。

如果传递给 Frame.EvaluateAsync() 的函数返回一个不可 [序列化] 的值，则 Frame.EvaluateAsync() 返回 undefined。Playwright 还支持传输一些 JSON 无法序列化的额外值：-0、NaN、Infinity、-Infinity。

用法

var result = await frame.EvaluateAsync<int>("([x, y]) => Promise.resolve(x * y)", new[] { 7, 8 });
Console.WriteLine(result);

也可以传入一个字符串，而不是函数。

Console.WriteLine(await frame.EvaluateAsync<int>("1 + 2")); // 输出 "3"

ElementHandle 实例可以作为参数传递给 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();

参数

expression string #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则该函数会自动调用。
arg EvaluationArgument?（可选）#

传递给 expression 的可选参数。

返回值

[object]#

EvaluateHandleAsync

在 v1.9 之前添加

frame.EvaluateHandleAsync

以 JSHandle 的形式返回 expression 的返回值。

Frame.EvaluateAsync() 和 Frame.EvaluateHandleAsync() 之间的唯一区别在于，Frame.EvaluateHandleAsync() 返回 JSHandle。

如果传递给 Frame.EvaluateHandleAsync() 的函数返回一个 Promise，则 Frame.EvaluateHandleAsync() 将等待该 Promise 解决并返回其值。

用法

// window 对象的句柄。
var aWindowHandle = await frame.EvaluateHandleAsync("() => Promise.resolve(window)");

也可以传入字符串，而非函数。

var docHandle = await frame.EvaluateHandleAsync("document"); // `document` 的句柄

JSHandle 实例可以作为参数传递给 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();

参数

expression string # 在浏览器上下文中要计算的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。
arg EvaluationArgument?（可选）# 传递给 expression 的可选参数。

返回值

JSHandle #

FrameElementAsync

在 v1.9 之前添加

frame.FrameElementAsync

返回与此框架对应的 frame 或 iframe 元素句柄。

这是 ElementHandle.ContentFrameAsync() 的反向操作。请注意，返回的句柄实际上属于父框架。

如果在 frameElement() 返回之前框架已分离，则此方法会抛出错误。

用法

var frameElement = await frame.FrameElementAsync();
var contentFrame = await frameElement.ContentFrameAsync();
Console.WriteLine(frame == contentFrame); // -> True

返回值

ElementHandle #

FrameLocator

添加于：v1.17

frame.FrameLocator

在处理 iframe 时，可以创建一个框架定位器，它将进入 iframe 并允许在该 iframe 中选择元素。

用法

以下代码片段在 id 为 my-frame 的 iframe 中定位文本为 "Submit" 的元素，例如 <iframe id="my-frame">：

var locator = frame.FrameLocator("#my-iframe").GetByText("Submit");
await locator.ClickAsync();

参数

selector string #

解析 DOM 元素时使用的选择器。

返回值

FrameLocator #

GetByAltText

新增于：v1.27

frame.GetByAltText

允许通过元素的替代文本（alt text）来定位元素。

用法

例如，此方法将通过替代文本“Playwright logo”找到图像：

<img alt='Playwright logo'>

await page.GetByAltText("Playwright logo").ClickAsync();

参数

text string | Regex #

用于定位元素的文本。
options FrameGetByAltTextOptions?（可选）
- Exact bool?（可选）#
  
  是否查找完全匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，完全匹配仍会修剪空白字符。

返回值

Locator #

GetByLabel

新增于：v1.27

frame.GetByLabel

允许通过关联的 <label> 或 aria-labelledby 元素的文本，或通过 aria-label 属性来定位输入元素。

用法

例如，此方法将在以下 DOM 中通过标签“Username”和“Password”找到输入框：

<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");

参数

text string | Regex #

用于定位元素的文本。
options FrameGetByLabelOptions?（可选）
- Exact bool?（可选）#
  
  是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会修剪空白字符。

返回值

Locator #

GetByPlaceholder

新增于：v1.27

frame.GetByPlaceholder

允许通过占位符文本定位输入元素。

用法

例如，考虑以下 DOM 结构。

<input type="email" placeholder="name@example.com" />

你可以在通过占位符文本定位到输入框后填充内容：

await page
    .GetByPlaceholder("name@example.com")
    .FillAsync("playwright@microsoft.com");

参数

text string | Regex #

用于定位元素的文本。
options FrameGetByPlaceholderOptions?（可选）
- Exact bool?（可选）#
  
  是否查找完全匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，完全匹配仍会修剪空白字符。

返回值

Locator #

GetByRole

新增于：v1.27

frame.GetByRole

允许通过 ARIA 角色、ARIA 属性和可访问名称来定位元素。

用法

考虑以下 DOM 结构。

<h3>注册</h3>
<label>
  <input type="checkbox" /> 订阅
</label>
<br/>
<button>提交</button>

你可以通过每个元素的隐式角色来定位它们：

await Expect(Page
    .GetByRole(AriaRole.Heading, new() { Name = "注册" }))
    .ToBeVisibleAsync();

await page
    .GetByRole(AriaRole.Checkbox, new() { Name = "订阅" })
    .CheckAsync();

await page
    .GetByRole(AriaRole.Button, new() {
        NameRegex = new Regex("提交", RegexOptions.IgnoreCase)
    })
    .ClickAsync();

参数

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 }#

必需的 ARIA 角色。
options FrameGetByRoleOptions?（可选）
- Checked bool?（可选）#
  
  通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。
  
  了解更多关于 aria-checked 的信息。
- Disabled bool?（可选）#
  
  通常由 aria-disabled 或 disabled 设置的属性。
  
  备注
  与大多数其他属性不同，disabled 会通过 DOM 层次结构继承。了解更多关于 aria-disabled 的信息。
- Exact bool?（可选）添加于：v1.28#
  
  Name|NameRegex 是否完全匹配：区分大小写且匹配整个字符串。默认为 false。当 Name|NameRegex 是正则表达式时，此选项将被忽略。请注意，完全匹配仍会修剪空白字符。
- Expanded bool?（可选）#
  
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded 的信息。
- IncludeHidden bool?（可选）#
  
  控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（如 ARIA 定义）会被角色选择器匹配。
  
  了解更多关于 aria-hidden 的信息。
- Level int?（可选）#
  
  通常用于 heading、listitem、row、treeitem 角色的数字属性，对于 <h1>-<h6> 元素有默认值。
  
  了解更多关于 aria-level 的信息。
- Name|NameRegex string? | Regex?（可选）#
  
  用于匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 Exact 来控制此行为。
  
  了解更多关于可访问名称的信息。
- Pressed bool?（可选）#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- Selected bool?（可选）#
  
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected 的信息。

返回值

Locator #

详细信息

角色选择器不会替代可访问性审计和一致性测试，而是提供有关 ARIA 指南的早期反馈。

许多 HTML 元素都有一个隐式的定义角色，角色选择器可以识别该角色。你可以在此处找到所有支持的角色。ARIA 指南不建议通过将 role 和 / 或 aria-* 属性设置为默认值来重复隐式角色和属性。

GetByTestId

新增于：v1.27

frame.GetByTestId

通过测试 ID 定位元素。

用法

考虑以下 DOM 结构。

<button data-testid="directions">Itinéraire</button>

你可以通过其测试 ID 定位该元素：

await page.GetByTestId("directions").ClickAsync();

参数

testId string | Regex #

用于定位元素的 ID。

返回值

Locator #

详细信息

默认情况下，data-testid 属性用作测试 ID。如有必要，可使用 Selectors.SetTestIdAttribute() 配置不同的测试 ID 属性。

GetByText

添加于：v1.27

frame.GetByText

允许定位包含给定文本的元素。

另请参阅 Locator.Filter()，它允许通过其他条件（如可访问角色）进行匹配，然后按文本内容进行筛选。

用法

考虑以下 DOM 结构：

<div>Hello <span>world</span></div>
<div>Hello</div>

你可以通过文本子字符串、精确字符串或正则表达式进行定位：

// 匹配 <span>
page.GetByText("world");

// 匹配第一个 <div>
page.GetByText("Hello world");

// 匹配第二个 <div>
page.GetByText("Hello", new() { Exact = true });

// 匹配两个 <div>
page.GetByText(new Regex("Hello"));

// 匹配第二个 <div>
page.GetByText(new Regex("^hello$", RegexOptions.IgnoreCase));

参数

text string | Regex #

用于定位元素的文本。
options FrameGetByTextOptions?（可选）
- Exact bool?（可选）#
  
  是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会修剪空白字符。

返回值

Locator #

详细信息

即使是精确匹配，按文本匹配也总会对空白字符进行规范化处理。例如，将多个空格合并为一个，将换行符转换为空格，并忽略前导和尾随的空白字符。

类型为 button 和 submit 的输入元素是通过其 value 而不是文本内容进行匹配的。例如，通过文本 "登录" 定位会匹配 <input type=button value="登录">。

GetByTitle

添加于：v1.27

frame.GetByTitle

允许通过元素的 title 属性定位元素。

用法

考虑以下 DOM 结构。

<span title='问题数量'>25 个问题</span>

通过标题文本定位后，你可以检查问题数量：

await Expect(Page.GetByTitle("问题数量")).toHaveText("25 个问题");

参数

text string | Regex #

用于定位元素的文本。
options FrameGetByTitleOptions?（可选）
- Exact bool?（可选）#
  
  是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会去除空白字符。

返回值

Locator #

GotoAsync

在 v1.9 之前添加

frame.GotoAsync

返回主资源响应。如果存在多个重定向，导航将使用最后一个重定向的响应来解析。

在以下情况下，该方法将抛出错误：

存在 SSL 错误（例如自签名证书的情况）。
目标 URL 无效。
导航期间超过 Timeout。
远程服务器无响应或无法访问。
主资源加载失败。

当远程服务器返回任何有效的 HTTP 状态码时，包括 404 “未找到” 和 500 “内部服务器错误”，该方法不会抛出错误。此类响应的状态码可以通过调用 Response.Status 来获取。

备注

该方法要么抛出错误，要么返回主资源响应。唯一的例外是导航到 about:blank 或导航到具有不同哈希值的相同 URL，这两种情况将成功并返回 null。

备注

无头模式不支持导航到 PDF 文档。请参阅上游问题。

用法

await Frame.GotoAsync(url, options);

参数

url string #

要导航到的框架的 URL。该 URL 应包含协议，例如 https://。
options FrameGotoOptions?（可选）
- Referer string?（可选）#
  
  引用页（Referer）标头值。如果提供了该值，它将优先于通过 Page.SetExtraHTTPHeadersAsync() 设置的引用页标头值。
- Timeout [float]?（可选）#
  
  最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#
  
  何时认为操作成功，默认为 load。事件可以是：
  - 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
  - 'load' - 当 load 事件触发时，认为操作完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作完成。不要在测试中使用此方法，应依赖 Web 断言来评估就绪状态。
  - 'commit' - 当接收到网络响应且文档开始加载时，认为操作完成。

返回值

Response?#

IsDetached

在 v1.9 之前添加

frame.IsDetached

如果框架已分离，则返回 true，否则返回 false。

用法

Frame.IsDetached

返回值

bool #

IsEnabledAsync

在 v1.9 之前添加

frame.IsEnabledAsync

返回元素是否启用。

用法

await Frame.IsEnabledAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameIsEnabledOptions?（可选）
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，此调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

bool #

Locator

添加于：v1.14

frame.Locator

该方法返回一个元素定位器（element locator），可用于在此页面/框架上执行操作。定位器会在执行操作前立即解析为元素，因此对同一定位器执行的一系列操作实际上可能在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构发生了变化，就会出现这种情况。

详细了解定位器。

用法

Frame.Locator(selector, options);

参数

selector string #

解析 DOM 元素时使用的选择器。
options FrameLocatorOptions?（可选）
- Has Locator?（可选）#
  
  将该方法的结果范围缩小到包含与这个相对定位器匹配的元素。例如，有 text=Playwright 的 article 与 <article><div>Playwright</div></article> 匹配。
  
  内部定位器 必须相对于 外部定位器，并且从外部定位器匹配的位置开始查询，而不是从文档根开始。例如，在 <article><content><div>Playwright</div></content></article> 中，你可以找到有 div 的 content。但是，查找有 article div 的 content 会失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator。
- HasNot Locator? 新增于：v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器是相对于外部定位器进行查询的。例如，没有 div 的 article 与 <article><span>Playwright</span></article> 匹配。
  
  请注意，外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator。
- HasNotText|HasNotTextRegex string? | Regex?（可选）新增于：v1.33#
  
  匹配内部（可能在子元素或后代元素中）某个位置不包含指定文本的元素。传入 string 时，匹配不区分大小写，并搜索子字符串。
- HasText|HasTextRegex string? | Regex?（可选）#
  
  匹配内部（可能在子元素或后代元素中）某个位置包含指定文本的元素。传入 string 时，匹配不区分大小写，并搜索子字符串。例如，"Playwright" 与 <article><div>Playwright</div></article> 匹配。

返回值

Locator #

Name

在 v1.9 之前添加

frame.Name

返回 <frame> 或 <iframe> 标签中指定的框架 name 属性。

如果 name 为空，则返回 id 属性。

备注

此值在框架创建时计算一次，后续属性更改时不会更新。

用法

Frame.Name

返回值

string #

Page

在 v1.9 之前添加

frame.Page

返回包含此框架的页面。

用法

Frame.Page

返回值

Page #

ParentFrame

在 v1.9 之前添加

frame.ParentFrame

父框架（如果有）。分离的框架和主框架返回 null。

用法

Frame.ParentFrame

返回值

Frame?#

SetContentAsync

在 v1.9 之前添加

frame.SetContentAsync

此方法内部调用 document.write()，继承其所有特定特征和行为。

用法

await Frame.SetContentAsync(html, options);

参数

html string #

要分配给页面的 HTML 标记。
options FrameSetContentOptions?（可选）
- Timeout [float]?（可选）#
  
  最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#
  
  何时视为操作成功，默认为 load。事件可以是：
  - 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，视为操作完成。
  - 'load' - 当触发 load 事件时，视为操作完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。不要在测试中使用此方法，应依赖 Web 断言来评估准备情况。
  - 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值

void #

TitleAsync

在 v1.9 之前添加

frame.TitleAsync

返回页面标题。

用法

await Frame.TitleAsync();

返回值

string #

Url

在 v1.9 之前添加

frame.Url

返回框架的 URL。

用法

Frame.Url

返回值

string #

WaitForFunctionAsync

在 v1.9 之前添加

frame.WaitForFunctionAsync

当 expression 返回真值时返回，并返回该值。

用法

Frame.WaitForFunctionAsync() 可用于观察视口大小变化：

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");
    }
}

要将参数传递给 frame.waitForFunction 函数的断言：

var selector = ".foo";
await page.MainFrame.WaitForFunctionAsync("selector => !!document.querySelector(selector)", selector);

参数

expression string #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则会自动调用该函数。
arg EvaluationArgument?（可选）#

传递给 expression 的可选参数。
options FrameWaitForFunctionOptions?（可选）
- PollingInterval [float]?（可选）#
  
  如果指定，则将其视为函数执行的时间间隔（以毫秒为单位）。默认情况下，如果未指定此选项，expression 将在 requestAnimationFrame 回调中执行。
- Timeout [float]?（可选）#
  
  最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

返回值

JSHandle #

WaitForLoadStateAsync

在 v1.9 之前添加

frame.WaitForLoadStateAsync

等待达到所需的加载状态。

当框架达到所需的加载状态（默认为 load）时，此方法返回。调用此方法时，导航必须已经提交。如果当前文档已经达到所需状态，则立即解析。

备注

大多数情况下，不需要此方法，因为 Playwright 在每次操作前自动等待。

用法

await frame.ClickAsync("button");
await frame.WaitForLoadStateAsync(); // 默认为 LoadState.Load

参数

state enum LoadState { Load, DOMContentLoaded, NetworkIdle }?（可选）#

等待的可选加载状态，默认为 load。如果在加载当前文档时已经达到该状态，此方法将立即解析。可以是以下值之一：
- 'load' - 等待 load 事件触发。
- 'domcontentloaded' - 等待 DOMContentLoaded 事件触发。
- 'networkidle' - 不推荐 等待至少 500 毫秒内没有网络连接。不要在测试中使用此方法，应依靠 Web 断言来评估准备情况。
options FrameWaitForLoadStateOptions?（可选）
- Timeout [float]?（可选）#
  
  最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

WaitForURLAsync

新增于：v1.11

frame.WaitForURLAsync

等待框架导航到给定的 URL。

用法

await frame.ClickAsync("a.delayed-navigation"); // 点击链接将间接导致导航
await frame.WaitForURLAsync("**/target.html");

参数

url string | Regex | Func<string, bool>#

等待导航时匹配的通配符模式、正则表达式模式或接收 URL 的断言函数。请注意，如果参数是一个没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 URL。
options FrameWaitForURLOptions?（可选）
- Timeout [float]?（可选）#
  
  最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#
  
  何时视为操作成功，默认为 load。事件可以是：
  - 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，视为操作完成。
  - 'load' - 当 load 事件触发时，视为操作完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。不要在测试中使用此方法，应依靠 Web 断言来评估准备情况。
  - 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值

void #

已弃用

CheckAsync

在 v1.9 之前添加

frame.CheckAsync

不推荐使用

请改用基于定位器的 Locator.CheckAsync()。了解更多关于定位器的信息。

此方法通过执行以下步骤，选中与 selector 匹配的元素：

查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
确保匹配的元素是复选框或单选输入框。如果不是，则此方法将抛出异常。如果该元素已经被选中，则此方法立即返回。
等待对匹配元素的可操作性检查，除非设置了 Force 选项。如果在检查过程中元素被分离，则整个操作将重试。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心点击。
确保该元素现在已被选中。如果没有，则此方法将抛出异常。

如果在指定的 Timeout 内，所有步骤组合未完成，此方法将抛出 TimeoutError。传入零超时将禁用此功能。

用法

await Frame.CheckAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameCheckOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）添加于：v1.11#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。
- Strict bool?（可选）添加于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）添加于：v1.11#
  
  设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这在等待元素准备好进行操作但不执行操作时很有用。

返回值

void #

ClickAsync

在 v1.9 之前添加

frame.ClickAsync

不推荐使用

请改用基于定位器的 Locator.ClickAsync()。了解更多关于定位器的信息。

此方法通过执行以下步骤，点击与 selector 匹配的元素：

查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
等待对匹配元素进行可操作性检查，除非设置了 Force 选项。如果在检查过程中元素被分离，则整个操作将重试。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心或指定的 Position 处点击。
等待发起的导航成功或失败，除非设置了 NoWaitAfter 选项。

如果在指定的 Timeout 时间内，所有步骤未能全部完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

用法

await Frame.ClickAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameClickOptions?（可选）
- Button enum MouseButton { Left, Right, Middle }?（可选）#
  
  默认值为 left。
- ClickCount int?（可选）#
  
  默认值为 1。请参阅 UIEvent.detail。
- Delay [float]?（可选）#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认值为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项将来默认值将为 true。
  
  启动导航的操作会等待这些导航发生以及页面开始加载。你可以通过设置此标志选择不等待。只有在导航到无法访问的页面等特殊情况下才需要此选项。默认值为 false。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool?（可选）添加于：v1.14#
  
  为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）添加于：v1.11#
  
  设置此参数时，此方法仅执行可操作性检查并跳过操作。默认值为 false。这对于等待元素准备好执行操作但不实际执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

void #

DblClickAsync

在 v1.9 之前添加

frame.DblClickAsync

不推荐使用

请改用基于定位器的 Locator.DblClickAsync()。了解更多关于定位器的信息。

此方法通过执行以下步骤，双击与 selector 匹配的元素：

查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
等待对匹配元素进行可操作性检查，除非设置了 Force 选项。如果在检查过程中元素被分离，则整个操作将重试。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心或指定的 Position 处双击。如果 dblclick() 的第一次点击触发了导航事件，此方法将抛出异常。

如果在指定的 Timeout 时间内，所有步骤未完成，此方法将抛出 TimeoutError。传入零超时将禁用此功能。

备注

frame.dblclick() 会派发两个 click 事件和一个 dblclick 事件。

用法

await Frame.DblClickAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameDblClickOptions?（可选）
- Button enum MouseButton { Left, Right, Middle }?（可选）#
  
  默认值为 left。
- Delay [float]?（可选）#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认值为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#
  
  要按下的修饰键。确保在操作过程中仅按下这些修饰键，然后恢复当前的修饰键状态。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool?（可选）添加于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认值为 false。这对于等待元素准备好进行操作而不实际执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

void #

DispatchEventAsync

在 v1.9 之前添加

frame.DispatchEventAsync

不推荐使用

请改用基于定位器的 Locator.DispatchEventAsync()。了解更多关于定位器的信息。

以下代码片段在元素上触发 click 事件。无论元素的可见性状态如何，都会触发 click 事件。这等效于调用 element.click()。

用法

await frame.DispatchEventAsync("button#submit", "click");

在底层，它会基于给定的 type 创建一个事件实例，使用 eventInit 属性对其进行初始化，并在元素上派发该事件。默认情况下，事件是 composed、cancelable 且会冒泡的。

由于 eventInit 是特定于事件的，请参考以下事件文档获取初始属性列表：

如果你希望将实时对象传入事件，也可以将 JSHandle 指定为属性值：

// 注意，你只能在 Chromium 和 Firefox 中创建 DataTransfer
var dataTransfer = await frame.EvaluateHandleAsync("() => new DataTransfer()");
await frame.DispatchEventAsync("#source", "dragstart", new { dataTransfer });

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
type string #

DOM 事件类型："click"、"dragstart" 等。
eventInit EvaluationArgument?（可选）#

可选的特定于事件的初始化属性。
options FrameDispatchEventOptions?（可选）
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

EvalOnSelectorAsync

新增于：v1.9

frame.EvalOnSelectorAsync

不推荐使用

此方法不会等待元素通过可操作性检查，因此可能会导致测试不稳定。请改用 Locator.EvaluateAsync()、其他 Locator 辅助方法或基于 Web 的断言。

返回 expression 的返回值。

该方法会在框架内查找与指定选择器匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素匹配该选择器，该方法将抛出错误。

如果 expression 返回一个 Promise，则 Frame.EvalOnSelectorAsync() 将等待该 Promise 解决并返回其值。

用法

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");

参数

selector string #

要查询的选择器。
expression string #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则会自动调用该函数。
arg EvaluationArgument?（可选）#

传递给 expression 的可选参数。
options FrameEvalOnSelectorOptions?（可选）
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

返回值

[object]#

EvalOnSelectorAllAsync

添加于：v1.9

frame.EvalOnSelectorAllAsync

不推荐

在大多数情况下，Locator.EvaluateAllAsync()、其他 Locator 辅助方法以及以网页为优先的断言能更好地完成任务。

返回 expression 的返回值。

该方法会查找框架内所有与指定选择器匹配的元素，并将匹配到的元素数组作为第一个参数传递给 expression。

如果 expression 返回一个 Promise，那么 Frame.EvalOnSelectorAllAsync() 将等待该 Promise 解决，并返回其值。

用法

var divsCount = await frame.EvalOnSelectorAllAsync<bool>("div", "(divs, min) => divs.length >= min", 10);

参数

selector string #

要查询的选择器。
expression string #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则该函数将自动调用。
arg EvaluationArgument?（可选）#

传递给 expression 的可选参数。

返回值

[object]#

FillAsync

在 v1.9 之前添加

frame.FillAsync

不推荐使用

请改用基于定位器的 Locator.FillAsync()。了解更多关于定位器的信息。

此方法等待与 selector 匹配的元素出现，等待可操作性检查通过，聚焦该元素，填充内容，并在填充后触发 input 事件。请注意，你可以传入空字符串来清空输入字段。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果该元素位于具有关联控件的 <label> 元素内，则会填充该控件。

要发送细粒度的键盘事件，请使用 Locator.PressSequentiallyAsync()。

用法

await Frame.FillAsync(selector, value, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
value string #

要为 <input>、<textarea> 或 [contenteditable] 元素填充的值。
options FrameFillOptions?（可选）
- Force bool?（可选）新增于：v1.13#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

FocusAsync

在 v1.9 之前添加

frame.FocusAsync

不推荐使用

请改用基于定位器的 Locator.FocusAsync()。了解更多关于定位器的信息。

此方法使用 selector 获取一个元素并将其聚焦。如果没有与 selector 匹配的元素，该方法将等待，直到 DOM 中出现匹配的元素。

用法

await Frame.FocusAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameFocusOptions?（可选）
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

GetAttributeAsync

在 v1.9 之前新增

frame.GetAttributeAsync

不推荐

请改用基于定位器的 Locator.GetAttributeAsync()。了解更多关于定位器的信息。

返回元素属性值。

用法

await Frame.GetAttributeAsync(selector, name, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
name string #

要获取其值的属性名称。
options FrameGetAttributeOptions?（可选）
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

string?#

HoverAsync

在 v1.9 之前添加

frame.HoverAsync

不推荐使用

请改用基于定位器的 Locator.HoverAsync()。了解更多关于定位器的信息。

此方法通过执行以下步骤，将鼠标悬停在与 selector 匹配的元素上：

查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
除非设置了 Force 选项，否则等待对匹配元素进行可操作性检查。如果在检查过程中元素被分离，则会重试整个操作。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 将鼠标悬停在元素中心或指定的 Position 上。

如果在指定的 Timeout 时间内，所有步骤组合未完成，此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。

用法

await Frame.HoverAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameHoverOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#
  
  要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前的修饰键状态。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。
- NoWaitAfter bool?（可选）添加于：v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。
- Strict bool?（可选）添加于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）添加于：v1.11#
  
  设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作而不实际执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

void #

InnerHTMLAsync

在 v1.9 之前添加

frame.InnerHTMLAsync

不推荐使用

请改用基于定位器的 Locator.InnerHTMLAsync()。了解更多关于定位器的信息。

返回 element.innerHTML。

用法

await Frame.InnerHTMLAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameInnerHTMLOptions?（可选）
- Strict bool?（可选）在 v1.14 中添加#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

string #

InnerTextAsync

在 v1.9 之前添加

frame.InnerTextAsync

不推荐使用

请改用基于定位器的 Locator.InnerTextAsync()。了解更多关于定位器的信息。

返回 element.innerText。

用法

await Frame.InnerTextAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameInnerTextOptions?（可选）
- Strict bool?（可选）在 v1.14 中添加#
  
  为 true 时，此调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

string #

InputValueAsync

新增于：v1.13

frame.InputValueAsync

不推荐使用

请改用基于定位器的 Locator.InputValueAsync()。了解更多关于定位器的信息。

返回选定的 <input>、<textarea> 或 <select> 元素的 input.value。

对于非输入元素会抛出异常。但是，如果该元素位于具有关联 control 的 <label> 元素内，则返回该控件的值。

用法

await Frame.InputValueAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameInputValueOptions?（可选）
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

string #

IsCheckedAsync

在 v1.9 之前添加

frame.IsCheckedAsync

不推荐

请改用基于定位器的 Locator.IsCheckedAsync()。了解更多关于定位器的信息。

返回元素是否被选中。如果该元素不是复选框或单选输入框，则会抛出异常。

用法

await Frame.IsCheckedAsync(selector, options);

参数

selector string # 用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameIsCheckedOptions?（可选）
- Strict bool?（可选）新增于：v1.14# 为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）# 最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

bool #

IsDisabledAsync

在 v1.9 之前添加

frame.IsDisabledAsync

不推荐

请改用基于定位器的 Locator.IsDisabledAsync()。了解更多关于定位器的信息。

返回元素是否已禁用，与已启用相反。

用法

await Frame.IsDisabledAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameIsDisabledOptions? (可选)
- Strict bool? (可选) 在 v1.14 中添加#
  
  为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，此调用将抛出异常。
- Timeout [float]? (可选)#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

bool #

IsEditableAsync

在 v1.9 之前添加

frame.IsEditableAsync

不推荐使用

请改用基于定位器的 Locator.IsEditableAsync()。了解更多关于定位器的信息。

返回元素是否可编辑。

用法

await Frame.IsEditableAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameIsEditableOptions?（可选）
- Strict bool?（可选）在 v1.14 中添加#
  
  为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

bool #

IsHiddenAsync

在 v1.9 之前添加

frame.IsHiddenAsync

不推荐使用

请改用基于定位器的 Locator.IsHiddenAsync()。了解更多关于定位器的信息。

返回元素是否隐藏，与可见相反。selector 若未匹配到任何元素，则视为隐藏。

用法

await Frame.IsHiddenAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameIsHiddenOptions? (可选)
- Strict bool? (可选) 添加于：v1.14#
  
  为 true 时，此调用要求选择器仅解析为单个元素。如果给定选择器解析到多个元素，调用将抛出异常。
- Timeout [float]? (可选)#
  
  已弃用
  此选项将被忽略。Frame.IsHiddenAsync() 不会等待元素变为隐藏状态，而是立即返回。

返回值

bool #

IsVisibleAsync

在 v1.9 之前添加

frame.IsVisibleAsync

不推荐使用

请改用基于定位器的 Locator.IsVisibleAsync()。了解更多关于定位器的信息。

返回元素是否可见。selector 若未匹配到任何元素，则视为不可见。

用法

await Frame.IsVisibleAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameIsVisibleOptions?（可选）
- Strict bool?（可选）添加于：v1.14#
  
  为 true 时，此调用要求选择器仅解析为单个元素。如果给定选择器解析出多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  已弃用
  此选项将被忽略。Frame.IsVisibleAsync() 不会等待元素变为可见，而是立即返回。

返回值

bool #

PressAsync

在 v1.9 之前添加

frame.PressAsync

不推荐使用

请改用基于定位器的 Locator.PressAsync()。了解更多关于定位器的信息。

key 可以指定预期的 keyboardEvent.key 值，或指定一个用于生成文本的单个字符。key 值的超集可在此处找到。键的示例如下：

F1 - F12、Digit0 - Digit9、KeyA - KeyZ、Backquote、Minus、Equal、Backslash、Backspace、Tab、Delete、Escape、ArrowDown、End、Enter、Home、Insert、PageDown、PageUp、ArrowRight、ArrowUp 等。

还支持以下组合快捷键：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

按住 Shift 键将输入与 key 对应的大写文本。

如果 key 是单个字符，则区分大小写，因此 a 和 A 值将分别生成不同的文本。

也支持诸如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 这样的快捷键。当指定了修饰键时，在按下后续键的同时按下并按住修饰键。

用法

await Frame.PressAsync(selector, key, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
key string #

要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。
options FramePressOptions?（可选）
- Delay [float]?（可选）#
  
  keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项在未来将默认为 true。
  
  启动导航的操作会等待这些导航发生以及页面开始加载。你可以通过设置此标志选择不等待。只有在导航到无法访问的页面等特殊情况下才需要此选项。默认为 false。
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

QuerySelectorAsync

新增于：v1.9

frame.QuerySelectorAsync

不推荐使用

请改用基于定位器的 Frame.Locator()。详细了解定位器。

返回指向框架元素的 ElementHandle。

警告

不推荐使用 ElementHandle，请改用 Locator 对象和以网页为优先的断言。

该方法在框架内查找与指定选择器匹配的元素。如果没有元素与选择器匹配，则返回 null。

用法

await Frame.QuerySelectorAsync(selector, options);

参数

selector string #

要查询的选择器。
options FrameQuerySelectorOptions?（可选）
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，该调用将抛出异常。

返回值

ElementHandle?#

QuerySelectorAllAsync

添加于：v1.9

frame.QuerySelectorAllAsync

不推荐

请改用基于定位器的 Frame.Locator()。了解更多关于定位器的信息。

返回指向框架元素的 ElementHandle。

警告

不推荐使用 ElementHandle，请改用 Locator 对象。

该方法会在框架内查找所有与指定选择器匹配的元素。如果没有元素匹配该选择器，则返回空数组。

用法

await Frame.QuerySelectorAllAsync(selector);

参数

selector string #

要查询的选择器。

返回值

IReadOnlyList<ElementHandle>#

在 v1.9 之前添加

frame.RunAndWaitForNavigationAsync

已弃用

此方法本质上存在竞争问题，请改用 Frame.WaitForURLAsync()。

等待框架导航，并返回主资源响应。如果存在多个重定向，导航将使用最后一个重定向的响应来解析。如果导航到不同的锚点或由于使用 History API 而进行导航，导航将使用 null 来解析。

用法

此方法等待框架导航到新的 URL。当你运行的代码将间接导致框架导航时，此方法很有用。考虑以下示例：

await frame.RunAndWaitForNavigationAsync(async () =>
{
    // 点击链接将间接导致导航。
    await frame.ClickAsync("a.delayed-navigation");
});

// 导航完成后解析

:::注意使用 History API 更改 URL 被视为导航。 :::

参数

action Func<Task> 新增于：v1.12#

触发事件的操作。
options FrameRunAndWaitForNavigationOptions? （可选）
- Timeout [float]? （可选）#
  
  最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool> （可选）#
  
  等待导航时要匹配的通配符模式、正则表达式模式或接收 URL 的谓词。请注意，如果参数是一个没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 URL。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? （可选）#
  
  何时认为操作成功，默认为 load。事件可以是：
  - 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
  - 'load' - 当 load 事件触发时，认为操作完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作完成。不要在测试中使用此方法，应依靠 Web 断言来评估准备情况。
  - 'commit' - 当接收到网络响应且文档开始加载时，认为操作完成。

返回值

Response?#

在 v1.9 之前添加

frame.WaitForNavigationAsync

已弃用

此方法本质上存在竞争问题，请改用 Frame.WaitForURLAsync()。

等待框架导航并返回主资源响应。如果存在多个重定向，导航将使用最后一个重定向的响应来解析。如果导航到不同的锚点或由于使用 History API 而进行导航，导航将使用 null 来解析。

用法

此方法等待框架导航到新的 URL。当你运行的代码将间接导致框架导航时，此方法很有用。考虑以下示例：

await frame.RunAndWaitForNavigationAsync(async () =>
{
    // 点击链接将间接导致导航。
    await frame.ClickAsync("a.delayed-navigation");
});

// 导航完成后解析

备注

使用 History API 更改 URL 被视为导航。

参数

options FrameRunAndWaitForNavigationOptions?（可选）
- Timeout [float]?（可选）#
  
  最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool>（可选）#
  
  等待导航时要匹配的通配符模式、正则表达式模式或接收 URL 的谓词。请注意，如果参数是一个没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 URL。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#
  
  何时认为操作成功，默认为 load。事件可以是：
  - 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
  - 'load' - 当 load 事件触发时，认为操作完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作完成。不要在测试中使用此方法，应依靠 Web 断言来评估准备情况。
  - 'commit' - 当接收到网络响应且文档开始加载时，认为操作完成。

返回值

Response?#

SelectOptionAsync

在 v1.9 之前添加

frame.SelectOptionAsync

不推荐使用

请改用基于定位器的 Locator.SelectOptionAsync()。了解更多关于定位器的信息。

此方法等待与 selector 匹配的元素，等待可操作性检查，等待所有指定的选项出现在 <select> 元素中，然后选择这些选项。

如果目标元素不是 <select> 元素，此方法将抛出错误。但是，如果该元素位于具有关联 control 的 <label> 元素内，则将改用该控件。

返回已成功选择的选项值数组。

在所有提供的选项都被选中后，触发 change 和 input 事件。

用法

// 匹配值或标签的单选
await frame.SelectOptionAsync("select#colors", new[] { "blue" });
// 匹配值和标签两者的单选
await frame.SelectOptionAsync("select#colors", new[] { new SelectOptionValue() { Label = "blue" } });
// 多选
await frame.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" });

参数

selector string #

要查询的选择器。
values string | ElementHandle | IEnumerable | SelectOption | IEnumerable | IEnumerable?#
- Value string? （可选）
  
  通过 option.value 进行匹配。可选。
- Label string? （可选）
  
  通过 option.label 进行匹配。可选。
- Index int? （可选）
  
  通过索引进行匹配。可选。
要选择的选项。如果 <select> 有 multiple 属性，所有匹配的选项都会被选中，否则只有第一个匹配传入选项之一的选项会被选中。字符串值会同时匹配值和标签。如果所有指定属性都匹配，则认为该选项匹配。
options FrameSelectOptionOptions? （可选）
- Force bool? （可选）新增于：v1.13#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool? （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Strict bool? （可选）新增于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]? （可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

IReadOnlyList<string>#

SetCheckedAsync

新增于：v1.15

frame.SetCheckedAsync

不推荐使用

请改用基于定位器的 Locator.SetCheckedAsync()。了解更多关于定位器的信息。

此方法通过执行以下步骤来选中或取消选中与 selector 匹配的元素：

查找与 selector 匹配的元素。如果没有，则等待匹配的元素附加到 DOM 中。
确保匹配的元素是复选框或单选输入框。如果不是，此方法将抛出异常。
如果该元素已经处于正确的选中状态，此方法将立即返回。
等待对匹配元素进行可操作性检查，除非设置了 Force 选项。如果在检查过程中元素被分离，整个操作将重试。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心点击。
确保该元素现在已被选中或取消选中。如果没有，此方法将抛出异常。

如果在指定的 Timeout 时间内所有步骤仍未完成，此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。

用法

await Frame.SetCheckedAsync(selector, checked, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
checkedState bool #

是否选中或取消选中复选框。
options FrameSetCheckedOptions? （可选）
- Force bool? （可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool? （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? （可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。
- Strict bool? （可选）#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]? （可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool? （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作但不执行操作很有用。

返回值

void #

SetInputFilesAsync

在 v1.9 之前添加

frame.SetInputFilesAsync

不推荐使用

请改用基于定位器的 Locator.SetInputFilesAsync()。了解更多关于定位器的信息。

将文件输入的值设置为这些文件路径或文件。如果某些 filePaths 是相对路径，则它们将相对于当前工作目录进行解析。如果传入空数组，则会清除选定的文件。

此方法要求 selector 指向一个 input 元素。但是，如果该元素位于具有关联 control 的 <label> 元素内，则会改为定位该控件。

用法

await Frame.SetInputFilesAsync(selector, files, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#
- Name string
  
  文件名
- MimeType string
  
  文件类型
- Buffer byte[]
  
  文件内容
options FrameSetInputFilesOptions?（可选）
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

TapAsync

在 v1.9 之前添加

frame.TapAsync

不推荐使用

请改用基于定位器的 Locator.TapAsync()。了解更多关于定位器的信息。

此方法通过执行以下步骤点击与 selector 匹配的元素：

查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
等待对匹配元素执行可操作性检查，除非设置了 Force 选项。如果在检查过程中元素被分离，则会重试整个操作。
如有需要，将元素滚动到可见区域。
使用 Page.Touchscreen 点击元素中心或指定的 Position。

如果在指定的 Timeout 时间内，所有步骤未能全部完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

备注

frame.tap() 要求浏览器上下文的 hasTouch 选项设置为 true。

用法

await Frame.TapAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameTapOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#
  
  要按下的修饰键。确保在操作过程中仅按下这些修饰键，然后恢复当前的修饰键状态。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool?（可选）添加于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）添加于：v1.11#
  
  设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作但不执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

void #

TextContentAsync

在 v1.9 之前添加

frame.TextContentAsync

不推荐使用

请改用基于定位器的 Locator.TextContentAsync()。了解更多关于定位器的信息。

返回 element.textContent。

用法

await Frame.TextContentAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameTextContentOptions?（可选）
- Strict bool?（可选）添加于：v1.14#
  
  为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

string?#

TypeAsync

在 v1.9 之前添加

frame.TypeAsync

已弃用

在大多数情况下，你应该使用 Locator.FillAsync() 替代。只有在页面上存在特殊键盘处理时，你才需要逐个按键，这种情况下请使用 Locator.PressSequentiallyAsync()。

为文本中的每个字符发送 keydown、keypress/input 和 keyup 事件。frame.type 可用于发送细粒度的键盘事件。要在表单字段中填充值，请使用 Frame.FillAsync()。

要按下特殊键，如 Control 或 ArrowDown，请使用 Keyboard.PressAsync()。

用法

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
text string #

要输入到获得焦点元素中的文本。
options FrameTypeOptions?（可选）
- Delay [float]?（可选）#
  
  按键之间等待的时间（毫秒）。默认为 0。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

UncheckAsync

在 v1.9 之前添加

frame.UncheckAsync

不推荐

请改用基于定位器的 Locator.UncheckAsync()。了解更多关于定位器的信息。

此方法通过执行以下步骤，取消选中与 selector 匹配的元素：

查找与 selector 匹配的元素。如果没有匹配元素，则等待匹配元素附加到 DOM。
确保匹配的元素是复选框或单选输入框。否则，此方法将抛出异常。如果该元素已经处于未选中状态，此方法将立即返回。
等待对匹配元素进行可操作性检查，除非设置了 Force 选项。如果在检查过程中元素被分离，整个操作将重试。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心点击。
确保该元素现在处于未选中状态。否则，此方法将抛出异常。

如果在指定的 Timeout 时间内，所有步骤未完成，此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。

用法

await Frame.UncheckAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
options FrameUncheckOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）新增于：v1.11#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）新增于：v1.11#
  
  设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这在等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

WaitForSelectorAsync

在 v1.9 之前添加

frame.WaitForSelectorAsync

不推荐

请使用断言可见性的 Web 断言，或基于定位器的 Locator.WaitForAsync()。了解更多关于定位器的信息。

当选择器指定的元素满足 State 选项时返回。如果等待 hidden 或 detached，则返回 null。

备注

Playwright 会在执行操作前自动等待元素准备就绪。使用 Locator 对象和以 Web 优先的断言可使代码无需等待选择器。

等待选择器满足 State 选项（从 DOM 中出现/消失，或变为可见/隐藏）。如果在调用该方法时选择器已经满足条件，该方法将立即返回。如果选择器在 Timeout 毫秒内未满足条件，函数将抛出异常。

用法

此方法在导航过程中均有效：

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")}");
        }
    }
}

参数

selector string #

要查询的选择器。
options FrameWaitForSelectorOptions?（可选）
- State enum WaitForSelectorState { Attached, Detached, Visible, Hidden }?（可选）#
  
  默认为 'visible'。可以是以下值：
  - 'attached' - 等待元素出现在 DOM 中。
  - 'detached' - 等待元素从 DOM 中移除。
  - 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或 display:none 的元素具有空的边界框，不被视为可见。
  - 'hidden' - 等待元素从 DOM 中移除，或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。
- Strict bool?（可选）新增于：v1.14#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

ElementHandle?#

WaitForTimeoutAsync

在 v1.9 之前添加

frame.WaitForTimeoutAsync

不推荐使用

在生产环境中切勿等待超时。依赖时间等待的测试本质上是不可靠的。请使用 Locator 操作和自动等待的 Web 断言。

等待指定的 timeout 毫秒数。

请注意，frame.waitForTimeout() 仅应用于调试。在生产环境中使用定时器的测试将不可靠。请改用网络事件、选择器变为可见等信号。

用法

await Frame.WaitForTimeoutAsync(timeout);

参数

timeout [float]#

等待的超时时间

返回值

void #

方法​

AddScriptTagAsync​

AddStyleTagAsync​

ChildFrames​

ContentAsync​

DragAndDropAsync​

EvaluateAsync​

EvaluateHandleAsync​

用法​

参数​

返回值​

FrameElementAsync​

FrameLocator​

GetByAltText​

GetByLabel​

GetByPlaceholder​

参数​

返回值​

GetByRole​

用法​

GetByTestId​

GetByText​

详细信息​

GetByTitle​

用法​

参数​

返回值​

GotoAsync​

IsDetached​

IsEnabledAsync​

参数​

返回值​

Locator​

Name​

Page​

ParentFrame​

SetContentAsync​

TitleAsync​

Url​

WaitForFunctionAsync​

用法​

WaitForLoadStateAsync​

参数​

返回值​

WaitForURLAsync​

参数​

已弃用​

CheckAsync​

ClickAsync​

DblClickAsync​

DispatchEventAsync​

EvalOnSelectorAsync​

EvalOnSelectorAllAsync​

FillAsync​

FocusAsync​

GetAttributeAsync​

HoverAsync​

InnerHTMLAsync​

InnerTextAsync​

InputValueAsync​

IsCheckedAsync​

用法​

参数​

返回值​

IsDisabledAsync​

IsEditableAsync​

IsHiddenAsync​

IsVisibleAsync​

PressAsync​

QuerySelectorAsync​

QuerySelectorAllAsync​

RunAndWaitForNavigationAsync​

WaitForNavigationAsync​

SelectOptionAsync​

SetCheckedAsync​

SetInputFilesAsync​

TapAsync​

TextContentAsync​

TypeAsync​

UncheckAsync​

方法

AddScriptTagAsync

AddStyleTagAsync

ChildFrames

ContentAsync

DragAndDropAsync

EvaluateAsync

EvaluateHandleAsync

用法

参数

返回值

FrameElementAsync

FrameLocator

GetByAltText

GetByLabel

GetByPlaceholder

参数

返回值

GetByRole

用法

GetByTestId

GetByText

详细信息

GetByTitle

用法

参数

返回值

GotoAsync

IsDetached

IsEnabledAsync

参数

返回值

Locator

Name

Page

ParentFrame

SetContentAsync

TitleAsync

Url

WaitForFunctionAsync

用法

WaitForLoadStateAsync

参数

返回值

WaitForURLAsync

参数

已弃用

CheckAsync

ClickAsync

DblClickAsync

DispatchEventAsync

EvalOnSelectorAsync

EvalOnSelectorAllAsync

FillAsync

FocusAsync

GetAttributeAsync

HoverAsync

InnerHTMLAsync

InnerTextAsync

InputValueAsync

IsCheckedAsync

用法

参数

返回值

IsDisabledAsync

IsEditableAsync

IsHiddenAsync

IsVisibleAsync

PressAsync

QuerySelectorAsync

QuerySelectorAllAsync

RunAndWaitForNavigationAsync

WaitForNavigationAsync

SelectOptionAsync

SetCheckedAsync

SetInputFilesAsync

TapAsync

TextContentAsync

TypeAsync

UncheckAsync