Frame

在任何时候，page 都通过 Page.MainFrame 和 Frame.ChildFrames 方法暴露其当前的框架树。

Frame 对象的生命周期由调度到 page 对象的三个事件控制：

Page.FrameAttached - 当 frame 附加到 page 时触发。一个 Frame 只能附加到 page 一次。
Page.FrameNavigated - 当 frame 提交导航到不同 URL 时触发。
Page.FrameDetached - 当 frame 从 page 分离时触发。一个 Frame 只能从 page 分离一次。

转储框架树的示例

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 触发或脚本内容被注入到 frame 中时，返回添加的标签。

向页面添加一个带有指定 URL 或内容的 <script> 标签。

用法

await Frame.AddScriptTagAsync(options);

参数

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

返回值

ElementHandle #

AddStyleTagAsync

在 v1.9 之前添加

frame.AddStyleTagAsync

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

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

用法

await Frame.AddStyleTagAsync(options);

参数

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

返回值

ElementHandle #

ChildFrames

在 v1.9 之前添加

frame.ChildFrames

用法

Frame.ChildFrames

返回值

IReadOnlyList<Frame>#

ContentAsync

在 v1.9 之前添加

frame.ContentAsync

获取 frame 的完整 HTML 内容，包括 doctype。

用法

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]
  点击源元素相对于元素 padding box 左上角的此点。如果未指定，则使用元素的某个可见点。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- TargetPosition TargetPosition? (可选)添加于：v1.14#
  - X [float]
  - Y [float]
  将元素释放到目标元素相对于元素 padding box 左上角的此点。如果未指定，则使用元素的某个可见点。
- 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")); // 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 对应的 frame 或 iframe 元素的 handle。

这是 ElementHandle.ContentFrameAsync() 的逆操作。请注意，返回的 handle 实际上属于父 frame。

如果在 frameElement() 返回之前 frame 已被分离，此方法将抛出错误。

用法

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

返回值

ElementHandle #

FrameLocator

添加于：v1.17

frame.FrameLocator

在使用 iframe 时，您可以创建一个 frame locator，它将进入 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 文本定位元素。

用法

例如，此方法将通过 alt 文本“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

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

用法

例如，考虑以下 DOM 结构。

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

您可以通过 placeholder 文本定位输入并填写

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 role、ARIA attributes 和可访问名称定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过其隐式 role 定位每个元素

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

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

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

参数

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 role。
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? (可选)#
  
  控制是否匹配隐藏元素的选项。默认情况下，role 选择器仅匹配非隐藏元素（如 ARIA 定义的）。
  
  了解更多关于 aria-hidden 的信息。
- Level int? (可选)#
  
  一个数字属性，通常存在于 heading、listitem、row、treeitem 等 role 中，并对 <h1>-<h6> 元素有默认值。
  
  了解更多关于 aria-level 的信息。
- Name|NameRegex string? | Regex? (可选)#
  
  匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 Exact 控制此行为。
  
  了解更多关于可访问名称的信息。
- Pressed bool? (可选)#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- Selected bool? (可选)#
  
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected 的信息。

返回值

Locator #

详情

Role 选择器不能替代可访问性审计和一致性测试，但可以提前提供关于 ARIA 指南的反馈。

许多 html 元素都具有 role 选择器可以识别的隐式定义 role。您可以在此处找到所有受支持的 role。ARIA 指南不推荐通过将 role 和/或 aria-* 属性设置为默认值来重复隐式 role 和属性。

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()，它允许按其他条件（例如可访问 role）进行匹配，然后按文本内容进行筛选。

用法

考虑以下 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

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

用法

考虑以下 DOM 结构。

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

您可以通过 title 文本定位元素后检查问题计数

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 无效。
导航期间超出超时。
远程服务器无响应或不可达。
主资源加载失败。

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

注意

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

注意

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

用法

await Frame.GotoAsync(url, options);

参数

url string #

导航 frame 的 URL。URL 应包含 scheme，例如 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

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

用法

Frame.IsDetached

返回值

bool #

IsEnabledAsync

在 v1.9 之前添加

frame.IsEnabledAsync

返回元素是否已启用。

用法

await Frame.IsEnabledAsync(selector, options);

参数

selector string #

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

返回值

bool #

Locator

添加于：v1.14

frame.Locator

此方法返回一个元素 Locator，可用于在此页面/frame 上执行操作。Locator 在执行操作之前立即解析到元素，因此对同一个 Locator 的一系列操作实际上可能在不同的 DOM 元素上执行。这发生在这些操作之间的 DOM 结构发生改变时。

了解更多关于 locators 的信息.

用法

Frame.Locator(selector, options);

参数

selector string #

解析 DOM 元素时使用的选择器。
options FrameLocatorOptions? (可选)
- Has Locator? (可选)#
  
  将方法结果缩小到包含匹配此相对 locator 的元素的那些元素。例如，包含 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。
  
  内部 locator 必须相对于 外部 locator，并且从外部 locator 匹配开始查询，而不是从文档根部。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将会失败，因为内部 locator 必须是相对的，并且不应使用 content 之外的任何元素。
  
  注意，外部和内部 locators 必须属于同一个 frame。内部 locator 不得包含 FrameLocators。
- HasNot Locator? (可选)添加于: v1.33#
  
  匹配不包含与内部 locator 匹配的元素的元素。内部 locator 针对外部 locator 进行查询。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  注意，外部和内部 locators 必须属于同一个 frame。内部 locator 不得包含 FrameLocators。
- 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 的 name 属性。

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

注意

此值在 frame 创建时计算一次，如果属性随后更改，则不会更新。

用法

Frame.Name

返回值

string #

Page

在 v1.9 之前添加

frame.Page

返回包含此 frame 的 page。

用法

Frame.Page

返回值

Page #

ParentFrame

在 v1.9 之前添加

frame.ParentFrame

父 frame，如果存在的话。分离的 frame 和主 frame 返回 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

返回 frame 的 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 函数的 predicate

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

参数

expression string #

要在浏览器上下文中评估的 JavaScript 表达式。如果表达式评估结果为函数，则会自动调用该函数。
arg EvaluationArgument? (可选)#

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

返回值

JSHandle #

WaitForLoadStateAsync

在 v1.9 之前添加

frame.WaitForLoadStateAsync

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

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

注意

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

用法

await frame.ClickAsync("button");
await frame.WaitForLoadStateAsync(); // Defaults to 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

等待 frame 导航到给定的 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 模式、regex 模式或接收 URL 的 predicate。注意，如果参数是没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 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 的 Locator.CheckAsync()。阅读更多关于 locators 的信息。

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

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

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

用法

await Frame.CheckAsync(selector, options);

参数

selector string #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 的 Locator.ClickAsync()。阅读更多关于 locators 的信息。

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

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

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

用法

await Frame.ClickAsync(selector, options);

参数

selector string #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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。
  
  发起导航的 actions 会等待这些导航发生并且页面开始加载。您可以通过设置此标志来选择不等待。只有在导航到不可访问页面等特殊情况下才需要此选项。默认为 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#
  
  设置后，此方法仅执行操作性检查并跳过 action。默认为 false。用于等待元素准备好进行操作但又不执行它。注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试只有在这些键按下时才可见的元素。

返回值

void #

DblClickAsync

在 v1.9 之前添加

frame.DblClickAsync

不推荐

请改用基于 locator 的 Locator.DblClickAsync()。阅读更多关于 locators 的信息。

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

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

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

注意

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

用法

await Frame.DblClickAsync(selector, options);

参数

selector string #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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#
  
  设置后，此方法仅执行操作性检查并跳过 action。默认为 false。用于等待元素准备好进行操作但又不执行它。注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试只有在这些键按下时才可见的元素。

返回值

void #

DispatchEventAsync

在 v1.9 之前添加

frame.DispatchEventAsync

不推荐

请改用基于 locator 的 Locator.DispatchEventAsync()。阅读更多关于 locators 的信息。

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

用法

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

在底层，它根据给定的 type 创建一个事件实例，用 eventInit 属性初始化它，并在元素上分派它。事件默认是 composed、cancelable 和 bubble 的。

由于 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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 的返回值。

此方法在 frame 中查找与指定 selector 匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素匹配 selector，则方法会抛出异常。

如果 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 #

用于查询的 selector。
expression string #

要在浏览器上下文中评估的 JavaScript 表达式。如果表达式评估结果为函数，则会自动调用该函数。
arg EvaluationArgument? (可选)#

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

返回值

[object]#

EvalOnSelectorAllAsync

添加于: v1.9

frame.EvalOnSelectorAllAsync

不推荐

在大多数情况下，Locator.EvaluateAllAsync()、其他 Locator 辅助方法和 web 优先断言效果更好。

返回 expression 的返回值。

此方法在 frame 中查找所有与指定 selector 匹配的元素，并将匹配元素的数组作为第一个参数传递给 expression。

如果 expression 返回一个 Promise，则 Frame.EvalOnSelectorAllAsync() 将等待 promise 解析并返回其值。

用法

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

参数

selector string #

用于查询的 selector。
expression string #

要在浏览器上下文中评估的 JavaScript 表达式。如果表达式评估结果为函数，则会自动调用该函数。
arg EvaluationArgument? (可选)#

可选参数，传递给 expression。

返回值

[object]#

FillAsync

在 v1.9 之前添加

frame.FillAsync

不推荐

请改用基于 locator 的 Locator.FillAsync()。阅读更多关于 locators 的信息。

此方法等待匹配 selector 的元素，等待操作性检查，聚焦元素，填充它，并在填充后触发 input 事件。注意，您可以传入空字符串来清空输入字段。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法会抛出异常。但是，如果元素在具有关联 control 的 <label> 元素内，则会填充该 control。

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

用法

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

参数

selector string #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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#
  
  设置后，此方法仅执行操作性检查并跳过 action。默认为 false。用于等待元素准备好进行操作但又不执行它。注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试只有在这些键按下时才可见的元素。

返回值

void #

InnerHTMLAsync

在 v1.9 之前添加

frame.InnerHTMLAsync

不推荐

请改用基于定位符的 Locator.InnerHTMLAsync()。阅读更多关于定位符的信息。

返回 element.innerHTML。

用法

await Frame.InnerHTMLAsync(selector, options);

参数

selector string #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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> 元素内部，则返回 control 的值。

用法

await Frame.InputValueAsync(selector, options);

参数

selector string #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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。在 Windows 和 Linux 上 ControlOrMeta 解析为 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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
key string #

要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。
options FramePressOptions? (可选)
- Delay [float]? (可选)#
  
  keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项将来会默认为 true。
  
  发起导航的 actions 会等待这些导航发生并且页面开始加载。您可以通过设置此标志来选择不等待。只有在导航到不可访问页面等特殊情况下才需要此选项。默认为 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 对象和 web-first 断言。

此方法在框架中查找与指定 selector 匹配的元素。如果没有元素匹配 selector，则返回 null。

用法

await Frame.QuerySelectorAsync(selector, options);

参数

selector string #

用于查询的 selector。
options FrameQuerySelectorOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。

返回值

ElementHandle?#

QuerySelectorAllAsync

添加于: v1.9

frame.QuerySelectorAllAsync

不推荐

请改用基于定位符的 Frame.Locator()。阅读更多关于定位符的信息。

返回指向框架元素的 ElementHandle 集合。

注意

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

此方法在框架中查找所有与指定 selector 匹配的元素。如果没有元素匹配 selector，则返回空数组。

用法

await Frame.QuerySelectorAllAsync(selector);

参数

selector string #

用于查询的 selector。

返回值

IReadOnlyList<ElementHandle>#

在 v1.9 之前添加

frame.RunAndWaitForNavigationAsync

已弃用

此方法本质上存在竞态条件，请改用 Frame.WaitForURLAsync()。

等待框架导航并返回主资源响应。在多次重定向的情况下，导航将解析为最后一次重定向的响应。如果导航到不同的锚点或由于 History 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

注意

使用 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> (可选)#
  
  在等待导航时匹配的 glob 模式、regex 模式或接收 URL 的 predicate。注意，如果参数是没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 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

注意

使用 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> (可选)#
  
  在等待导航时匹配的 glob 模式、regex 模式或接收 URL 的 predicate。注意，如果参数是没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 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> 元素内部，则将使用该 control。

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

在所有提供的选项都被选中后，触发一个 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 #

用于查询的 selector。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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> 元素内部，则会转而定位该 control。

用法

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

参数

selector string #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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#
  
  设置后，此方法仅执行操作性检查并跳过 action。默认为 false。用于等待元素准备好进行操作但又不执行它。注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试只有在这些键按下时才可见的元素。

返回值

void #

TextContentAsync

在 v1.9 之前添加

frame.TextContentAsync

不推荐

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

返回 element.textContent。

用法

await Frame.TextContentAsync(selector, options);

参数

selector string #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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 #

用于搜索元素的 selector。如果有多个元素满足 selector，则使用第一个。
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()。了解更多关于定位符的信息。

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

注意

Playwright 会在执行操作前自动等待元素准备就绪。使用 Locator 对象和 web-first 断言可以使代码摆脱对 selector 的等待。

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

用法

此方法在导航过程中仍然有效

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 #

用于查询的 selector。
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() 仅应用于调试。在生产环境中使用计时器进行的测试会不稳定。请改用网络事件、selector 可见等信号。

用法

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