框架

在任何时候，页面都通过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 触发或脚本内容已注入框架时，返回添加的标签。

在页面中添加 <script> 标签，并使用所需的 url 或内容。

用法

await Frame.AddScriptTagAsync(options);

参数

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

返回值

ElementHandle #

AddStyleTagAsync

在 v1.9 之前添加

frame.AddStyleTagAsync

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

在页面中添加 <link rel="stylesheet"> 标签，并使用所需的 url 或添加 <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

返回值

IEnumerable<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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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

返回表达式的返回值。

如果传递给 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")); // prints "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

将 expression 的返回值作为 JSHandle 返回。

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

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

用法

// Handle for the window object.
var aWindowHandle = await frame.EvaluateHandleAsync("() => Promise.resolve(window)");

也可以传递字符串而不是函数。

var docHandle = await frame.EvaluateHandleAsync("document"); // Handle for the `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

允许通过其替代文本定位元素。

用法

例如，此方法将按替代文本“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 属性来定位输入元素。

用法

例如，此方法将按标签“Username”和“Password”在以下 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");

参数

text string | Regex #

要定位元素的文本。
options FrameGetByLabelOptions? (可选)
- Exact bool? (可选)#
  
  是否查找完全匹配：区分大小写且为整个字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

Locator #

GetByPlaceholder

新增于：v1.27

frame.GetByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

<input type="email" placeholder="[email protected]" />

通过占位符文本定位输入后，可以填充该输入

await page
    .GetByPlaceholder("[email protected]")
    .FillAsync("[email protected]");

参数

text string | Regex #

要定位元素的文本。
options FrameGetByPlaceholderOptions? (可选)
- Exact bool? (可选)#
  
  是否查找完全匹配：区分大小写且为整个字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

Locator #

GetByRole

新增于：v1.27

frame.GetByRole

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

用法

考虑以下 DOM 结构。

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

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

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

参数

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>

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

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

参数

text string | Regex #

要定位元素的文本。
options FrameGetByTextOptions? (可选)
- Exact bool? (可选)#
  
  是否查找完全匹配：区分大小写且为整个字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

Locator #

细节

通过文本匹配始终规范化空白，即使使用精确匹配。例如，它将多个空格变成一个空格，将换行符变成空格，并忽略前导和尾随空格。

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

GetByTitle

新增于：v1.27

frame.GetByTitle

允许通过标题属性定位元素。

用法

考虑以下 DOM 结构。

<span title='Issues count'>25 issues</span>

您可以通过标题文本定位它后检查问题数量

await Expect(Page.GetByTitle("Issues count")).toHaveText("25 issues");

参数

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() 设置的 Referer 标头值。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

bool #

Locator

在以下版本中添加：v1.14

frame.Locator

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

详细了解定位器.

用法

Frame.Locator(selector, options);

参数

selector string #

解析 DOM 元素时要使用的选择器。
options FrameLocatorOptions? (可选)
- Has Locator? (可选)#
  
  将方法的结果缩小到包含与该相对定位器匹配的元素的那些结果。例如，包含 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。
  
  内部定位器**必须相对于**外部定位器，并且从外部定位器匹配开始查询，而不是从文档根目录开始查询。例如，您可以找到包含div的content，其结构为<article><content><div>Playwright</div></content></article>。但是，查找包含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

返回框架在标签中指定的名称属性。

如果名称为空，则返回 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

当表达式返回真值时返回，返回该值。

用法

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? (可选)#

要传递给表达式的可选参数。
options FrameWaitForFunctionOptions? (可选)
- PollingInterval [float]? (可选)#
  
  如果指定，则将其视为以毫秒为单位的间隔，函数将在该间隔内执行。默认情况下，如果未指定该选项，则表达式将在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(); // Defaults to LoadState.Load

参数

state enum LoadState { Load, DOMContentLoaded, NetworkIdle }? (可选)#

要等待的可选加载状态，默认为load。如果在加载当前文档时已达到该状态，则该方法立即解析。可以是以下之一
- 'load' - 等待load 事件被触发。
- 'domcontentloaded' - 等待DOMContentLoaded 事件被触发。
- 'networkidle' - 不建议 等待至少500 毫秒没有网络连接。不要将此方法用于测试，而是依靠网络断言来评估准备情况。
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"); // clicking the link will indirectly cause a navigation
await frame.WaitForURLAsync("**/target.html");

参数

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

在等待导航时，用于匹配的 glob 模式、正则表达式模式或接收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()。阅读有关定位器的更多信息。

此方法通过执行以下步骤来检查与选择器匹配的元素

查找与选择器匹配的元素。如果没有，则等待匹配的元素附加到 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)新增于：v1.11#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试只有在按下这些键时才可见的元素。

返回值

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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)新增于：v1.11#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试只有在按下这些键时才可见的元素。

返回值

void #

DispatchEventAsync

在 v1.9 之前添加

frame.DispatchEventAsync

不建议

使用基于定位器的 Locator.DispatchEventAsync() 替代。阅读更多关于定位器的内容。

下面的代码片段在元素上分派 click 事件。无论元素的可见性状态如何，click 都会被分派。这相当于调用 element.click()。

用法

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

在幕后，它会根据给定的 type 创建一个事件实例，使用 eventInit 属性对其进行初始化，并在元素上分派它。事件默认情况下是 composed、cancelable 和冒泡。

由于 eventInit 是特定于事件的，因此请参阅事件文档以获取初始属性列表

您也可以指定 JSHandle 作为属性值，如果您希望将实时对象传递到事件中

// Note you can only create DataTransfer in Chromium and Firefox
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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

EvalOnSelectorAsync

添加于：v1.9

frame.EvalOnSelectorAsync

不建议

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

返回 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

返回值

[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] 元素，此方法会抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则会改而填充 control。

要发送细粒度的键盘事件，请使用 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)新增于：v1.11#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试只有在按下这些键时才可见的元素。

返回值

void #

InnerHTMLAsync

在 v1.9 之前添加

frame.InnerHTMLAsync

不建议

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

返回 element.innerHTML。

用法

await Frame.InnerHTMLAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个元素。
options FrameInnerHTMLOptions? (可选)
- Strict bool? (可选)在以下版本中添加：v1.14#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

string #

InputValueAsync

在以下版本中添加：v1.13

frame.InputValueAsync

不建议

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

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

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

用法

await Frame.InputValueAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个元素。
options FrameInputValueOptions? (可选)
- Strict bool? (可选)在以下版本中添加：v1.14#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

QuerySelectorAsync

添加于：v1.9

frame.QuerySelectorAsync

不建议

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

返回指向 frame 元素的 ElementHandle。

caution

不建议使用 ElementHandle，请改用 Locator 对象和以 Web 为中心的断言。

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

用法

await Frame.QuerySelectorAsync(selector, options);

参数

selector string #

要查询的选择器。
options FrameQuerySelectorOptions? (可选)
- Strict bool? (可选)在以下版本中添加：v1.14#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

返回值

ElementHandle?#

QuerySelectorAllAsync

添加于：v1.9

frame.QuerySelectorAllAsync

不建议

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

返回指向 frame 元素的 ElementHandles。

caution

不建议使用 ElementHandle，请改用 Locator 对象。

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

用法

await Frame.QuerySelectorAllAsync(selector);

参数

selector string #

要查询的选择器。

返回值

IEnumerable<ElementHandle>#

在 v1.9 之前添加

frame.RunAndWaitForNavigationAsync

已弃用

此方法本质上是竞争的，请使用 Frame.WaitForURLAsync() 代替。

等待框架导航并返回主资源响应。如果出现多次重定向，导航将以最后一次重定向的响应解析。如果导航到不同的锚点或由于历史记录 API 使用导致的导航，导航将以 null 解析。

用法

此方法等待框架导航到新的 URL。它在运行会导致框架间接导航的代码时很有用。请考虑以下示例

await frame.RunAndWaitForNavigationAsync(async () =>
{
    // Clicking the link will indirectly cause a navigation.
    await frame.ClickAsync("a.delayed-navigation");
});

// Resolves after navigation has finished

注意

使用历史记录 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> (可选)#
  
  在等待导航时，用于匹配的 glob 模式、正则表达式模式或接收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() 代替。

用法

此方法等待框架导航到新的 URL。它在运行会导致框架间接导航的代码时很有用。请考虑以下示例

await frame.RunAndWaitForNavigationAsync(async () =>
{
    // Clicking the link will indirectly cause a navigation.
    await frame.ClickAsync("a.delayed-navigation");
});

// Resolves after navigation has finished

注意

使用历史记录 API 更改 URL 被视为导航。

参数

options FrameRunAndWaitForNavigationOptions? (可选)
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大操作时间，默认为 30 秒，传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool> (可选)#
  
  在等待导航时，用于匹配的 glob 模式、正则表达式模式或接收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() 代替。阅读更多关于定位器的内容。

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

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

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

一旦所有提供的选项都被选中，就会触发 change 和 input 事件。

用法

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

参数

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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

IEnumerable<string>#

SetCheckedAsync

添加于：v1.15

frame.SetCheckedAsync

不建议

使用基于定位器的 Locator.SetCheckedAsync() 代替。阅读更多关于定位器的内容。

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

查找匹配选择器的元素。如果没有，则等待匹配元素附加到 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? (可选)#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在执行操作之前，如果要等到元素准备就绪，则很有用。

返回值

void #

SetInputFilesAsync

在 v1.9 之前添加

frame.SetInputFilesAsync

不建议

使用基于定位器的 Locator.SetInputFilesAsync() 代替。阅读更多关于定位器的内容。

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

此方法期望选择器指向输入元素。但是，如果元素位于具有关联控件的 <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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

TapAsync

在 v1.9 之前添加

frame.TapAsync

不建议

使用基于定位器的 Locator.TapAsync() 代替。阅读更多关于定位器的内容。

此方法通过执行以下步骤来点击匹配选择器的元素

查找与选择器匹配的元素。如果没有找到，则等待匹配元素附加到 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)新增于：v1.11#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试只有在按下这些键时才可见的元素。

返回值

void #

TextContentAsync

在 v1.9 之前添加

frame.TextContentAsync

不建议

使用基于定位器的 Locator.TextContentAsync() 替代。详细了解定位器。

返回 element.textContent。

用法

await Frame.TextContentAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个元素。
options FrameTextContentOptions? (可选)
- Strict bool? (可选)在以下版本中添加：v1.14#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

UncheckAsync

在 v1.9 之前添加

frame.UncheckAsync

不建议

使用基于定位器的 Locator.UncheckAsync() 替代。详细了解定位器。

此方法通过执行以下步骤检查与选择器匹配的元素

查找与选择器匹配的元素。如果没有找到，则等待匹配元素附加到 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在执行操作之前，如果要等到元素准备就绪，则很有用。

返回值

void #

WaitForSelectorAsync

在 v1.9 之前添加

frame.WaitForSelectorAsync

不建议

使用断言可见性的网络断言或基于定位器的 Locator.WaitForAsync() 替代。详细了解定位器。

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

注意

Playwright 会自动等待元素准备好，然后再执行操作。使用 Locator 对象和以 Web 为中心的断言可以使代码无需等待选择器。

等待选择器满足 State 选项（出现在 DOM 中或从 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#
  
  如果为真，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

ElementHandle?#

WaitForTimeoutAsync

在 v1.9 之前添加

frame.WaitForTimeoutAsync

不建议

在生产环境中不要等待超时。等待时间的测试本质上不可靠。使用 Locator 操作和自动等待的网络断言。

等待 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​

WaitForSelectorAsync​

WaitForTimeoutAsync​

方法

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

WaitForSelectorAsync

WaitForTimeoutAsync