跳到主要内容

Frame

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

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

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

转储框架树的示例

using Microsoft.Playwright;
using System;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Firefox.LaunchAsync();
        var page = await browser.NewPageAsync();

        await page.GotoAsync("https://www.bing.com");
        DumpFrameTree(page.MainFrame, string.Empty);
    }

    private static void DumpFrameTree(IFrame frame, string indent)
    {
        Console.WriteLine($"{indent}{frame.Url}");
        foreach (var child in frame.ChildFrames)
            DumpFrameTree(child, indent + " ");
    }
}

方法​

AddScriptTagAsync​

在 v1.9 之前添加 frame.AddScriptTagAsync

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

向页面添加一个带有期望的 url 或内容的 <script> 标签。

用法

await Frame.AddScriptTagAsync(options);

参数

  • options FrameAddScriptTagOptions? (可选)

    • Content string? (可选)#

      要注入到框架中的原始 JavaScript 内容。

    • Path string? (可选)#

      要注入到框架中的 JavaScript 文件的路径。如果 path 是相对路径，则它相对于当前工作目录解析。

    • Type string? (可选)#

      脚本类型。使用 'module' 以加载 JavaScript ES6 模块。有关更多详细信息，请参阅 script。

    • Url string? (可选)#

      要添加的脚本的 URL。

返回

AddStyleTagAsync​

在 v1.9 之前添加 frame.AddStyleTagAsync

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

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

用法

await Frame.AddStyleTagAsync(options);

参数

  • options FrameAddStyleTagOptions? (可选)

    • Content string? (可选)#

      要注入到框架中的原始 CSS 内容。

    • Path string? (可选)#

      要注入到框架中的 CSS 文件的路径。如果 path 是相对路径，则它相对于当前工作目录解析。

    • Url string? (可选)#

      <link> 标签的 URL。

返回

ChildFrames​

在 v1.9 之前添加 frame.ChildFrames

用法

Frame.ChildFrames

返回

ContentAsync​

在 v1.9 之前添加 frame.ContentAsync

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

用法

await Frame.ContentAsync();

返回

DragAndDropAsync​

添加于：v1.13 frame.DragAndDropAsync

用法

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

参数

  • source string#

    用于搜索要拖动元素的 selector。如果存在多个满足 selector 的元素，则将使用第一个。

  • target string#

    用于搜索要拖放到的元素的 selector。如果存在多个满足 selector 的元素，则将使用第一个。

  • options FrameDragAndDropOptions? (可选)

    • Force bool? (可选)#

      是否绕过 actionability 检查。默认为 false。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • SourcePosition SourcePosition? (可选)添加于：v1.14#

      • X [float]

      • Y [float]

      点击源元素上相对于元素内边距框左上角的这个点。如果未指定，则使用元素的某个可见点。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • TargetPosition TargetPosition? (可选)添加于：v1.14#

      • X [float]

      • Y [float]

      在目标元素上拖放到相对于元素内边距框左上角的这个点。如果未指定，则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • Trial bool? (可选)#

      设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待元素准备好执行操作，而无需实际执行它。

返回

EvaluateAsync​

在 v1.9 之前添加 frame.EvaluateAsync

返回 expression 的返回值。

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

如果传递给 Frame.EvaluateAsync() 的函数返回一个非 Serializable 值，则 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 的可选参数。

返回

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

返回

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 元素的选择器。

返回

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。当按正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回

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。当按正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回

GetByPlaceholder​

添加于：v1.27 frame.GetByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

您可以在通过占位符文本定位输入后填充输入

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

参数

  • text string | Regex#

    用于定位元素的文本。

  • options FrameGetByPlaceholderOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配项：区分大小写且全字符串匹配。默认为 false。当按正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回

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 的信息。

返回

详情

角色选择器不能替代无障碍功能审核和一致性测试，而是提供关于 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();

参数

返回

详情

默认情况下，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。当按正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回

详情

按文本匹配始终会规范化空格，即使是完全匹配也是如此。例如，它将多个空格变成一个空格，将换行符变成空格，并忽略前导和尾随空格。

类型为 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>

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

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

参数

  • text string | Regex#

    用于定位元素的文本。

  • options FrameGetByTitleOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配项：区分大小写且全字符串匹配。默认为 false。当按正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回

GotoAsync​

在 v1.9 之前添加 frame.GotoAsync

返回主资源响应。在发生多次重定向的情况下，导航将使用最后一次重定向的响应进行解析。

如果发生以下情况，该方法将抛出错误

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

当远程服务器返回任何有效的 HTTP 状态代码时，该方法不会抛出错误，包括 404“Not Found”和 500“Internal Server Error”。可以通过调用 Response.Status 检索此类响应的状态代码。

注意

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

注意

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

用法

await Frame.GotoAsync(url, options);

参数

  • url string#

    要导航到的框架的 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' - 当收到网络响应并且文档开始加载时，认为操作已完成。

返回

IsDetached​

在 v1.9 之前添加 frame.IsDetached

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

用法

Frame.IsDetached

返回

  • bool#

IsEnabledAsync​

在 v1.9 之前添加 frame.IsEnabledAsync

返回元素是否为 启用状态。

用法

await Frame.IsEnabledAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameIsEnabledOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • 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>。

      内部定位器**必须相对于**外部定位器，并且从外部定位器匹配项开始查询，而不是从文档根目录开始。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到具有 div 的 content。但是，查找具有 article div 的 content 将会失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。

      请注意，外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator。

    • HasNot Locator? (可选)添加于版本: v1.33#

      匹配不包含与内部定位器匹配的元素的元素。内部定位器针对外部定位器进行查询。例如，不具有 div 的 article 匹配 <article><span>Playwright</span></article>。

      请注意，外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator。

    • HasNotText|HasNotTextRegex string? | Regex? (可选)添加于版本: v1.33#

      匹配在内部某处（可能在子元素或后代元素中）不包含指定文本的元素。当传递 string 时，匹配不区分大小写并搜索子字符串。

    • HasText|HasTextRegex string? | Regex? (可选)#

      匹配在内部某处（可能在子元素或后代元素中）包含指定文本的元素。当传递 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回

  • Locator#

Name​

在 v1.9 之前添加 frame.Name

返回框架标签中指定的 name 属性。

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

注意

此值在创建框架时计算一次，如果之后属性发生更改，则不会更新。

用法

Frame.Name

返回

  • string#

Page​

在 v1.9 之前添加 frame.Page

返回包含此框架的页面。

用法

Frame.Page

返回

  • Page#

ParentFrame​

在 v1.9 之前添加 frame.ParentFrame

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

用法

Frame.ParentFrame

返回

  • Frame?#

SetContentAsync​

在 v1.9 之前添加 frame.SetContentAsync

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

用法

await Frame.SetContentAsync(html, options);

参数

  • html string#

    要分配给页面的 HTML 标记。

  • options FrameSetContentOptions? (可选)

    • Timeout [float]? (可选)#

      最大操作时间（以毫秒为单位），默认为 30 秒，传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultNavigationTimeout(), BrowserContext.SetDefaultTimeout(), Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (可选)#

      何时认为操作成功，默认为 load。事件可以是

      • 'domcontentloaded' - 当 DOMContentLoaded 事件被触发时，认为操作已完成。
      • 'load' - 当 load 事件被触发时，认为操作已完成。
      • 'networkidle' - 不建议使用 当至少 500 毫秒内没有网络连接时，认为操作已完成。请勿将此方法用于测试，而应依靠 Web 断言来评估就绪状态。
      • 'commit' - 当收到网络响应并且文档开始加载时，认为操作已完成。

返回

  • void#

TitleAsync​

在 v1.9 之前添加 frame.TitleAsync

返回页面标题。

用法

await Frame.TitleAsync();

返回

  • string#

Url​

在 v1.9 之前添加 frame.Url

返回框架的 url。

用法

Frame.Url

返回

  • string#

WaitForFunctionAsync​

在 v1.9 之前添加 frame.WaitForFunctionAsync

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

用法

Frame.WaitForFunctionAsync() 可用于观察视口大小更改

using Microsoft.Playwright;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Firefox.LaunchAsync();
        var page = await browser.NewPageAsync();
        await page.SetViewportSizeAsync(50, 50);
        await page.MainFrame.WaitForFunctionAsync("window.innerWidth < 100");
    }
}

要将参数传递给 frame.waitForFunction 函数的谓词

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

参数

  • expression string#

    要在浏览器上下文中评估的 JavaScript 表达式。如果表达式评估为一个函数，则会自动调用该函数。

  • arg EvaluationArgument? (可选)#

    要传递给 expression 的可选参数。

  • options FrameWaitForFunctionOptions? (可选)

    • PollingInterval [float]? (可选)#

      如果指定，则将其视为函数执行的毫秒间隔。默认情况下，如果未指定此选项，则 expression 在 requestAnimationFrame 回调中执行。

    • Timeout [float]? (可选)#

      等待的最大时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

  • JSHandle#

WaitForLoadStateAsync​

在 v1.9 之前添加 frame.WaitForLoadStateAsync

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

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

注意

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

用法

await frame.ClickAsync("button");
await frame.WaitForLoadStateAsync(); // Defaults to LoadState.Load

参数

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

    要等待的可选加载状态，默认为 load。如果在加载当前文档时已达到该状态，则该方法立即解析。可以是以下之一

    • 'load' - 等待 load 事件被触发。
    • 'domcontentloaded' - 等待 DOMContentLoaded 事件被触发。
    • 'networkidle' - **不推荐** 等待直到至少 500 毫秒内没有网络连接。请勿使用此方法进行测试，而应依靠 Web 断言来评估就绪状态。

  • options FrameWaitForLoadStateOptions? (可选)

返回

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

Deprecated​

CheckAsync​

在 v1.9 之前添加 frame.CheckAsync
不推荐使用

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

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

  1. 查找与 selector 匹配的元素。如果没有，请等待直到匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选输入框。否则，此方法将抛出错误。如果元素已被选中，则此方法立即返回。
  3. 等待对匹配元素执行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，则会重试整个操作。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 Page.Mouse 在元素的中心单击。
  6. 确保元素现在已被选中。否则，此方法将抛出错误。

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

用法

await Frame.CheckAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameCheckOptions? (可选)

    • Force bool? (可选)#

      是否绕过 actionability 检查。默认为 false。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)添加于版本: v1.11#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • Trial bool? (可选)添加于版本: v1.11#

      设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待元素准备好执行操作，而无需实际执行它。

返回

  • void#

ClickAsync​

在 v1.9 之前添加 frame.ClickAsync
不推荐使用

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

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

  1. 查找与 selector 匹配的元素。如果没有，请等待直到匹配的元素附加到 DOM。
  2. 等待对匹配元素执行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，则会重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.Mouse 在元素的中心或指定的 Position 单击。
  5. 除非设置了 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? (可选)#

      是否绕过 actionability 检查。默认为 false。

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#

      要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项在未来将默认为 true。

      启动导航的操作正在等待这些导航发生并等待页面开始加载。您可以通过设置此标志来选择不等待。您只需要在特殊情况下使用此选项，例如导航到无法访问的页面。默认为 false。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • Trial bool? (可选)添加于版本: v1.11#

      设置后，此方法仅执行可操作性检查并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行它。请注意，无论 trial 如何，都将按下键盘修饰键，以允许测试仅在按下这些键时才可见的元素。

返回

  • void#

DblClickAsync​

在 v1.9 之前添加 frame.DblClickAsync
不推荐使用

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

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

  1. 查找与 selector 匹配的元素。如果没有，请等待直到匹配的元素附加到 DOM。
  2. 等待对匹配元素执行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，则会重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 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? (可选)#

      是否绕过 actionability 检查。默认为 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，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • Trial bool? (可选)添加于版本: v1.11#

      设置后，此方法仅执行可操作性检查并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行它。请注意，无论 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#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

  • void#

EvalOnSelectorAsync​

添加于版本: v1.9 frame.EvalOnSelectorAsync
不推荐使用

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

返回 expression 的返回值。

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

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

用法

var searchValue = await frame.EvalOnSelectorAsync<string>("#search", "el => el.value");
var preloadHref = await frame.EvalOnSelectorAsync<string>("link[rel=preload]", "el => el.href");
var html = await frame.EvalOnSelectorAsync(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");

参数

  • selector string#

    要查询的选择器。

  • expression string#

    要在浏览器上下文中评估的 JavaScript 表达式。如果表达式评估为一个函数，则会自动调用该函数。

  • arg EvaluationArgument? (可选)#

    传递给 expression 的可选参数。

  • options FrameEvalOnSelectorOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

返回

  • [object]#

EvalOnSelectorAllAsync​

添加于版本: v1.9 frame.EvalOnSelectorAllAsync
不推荐使用

在大多数情况下，Locator.EvaluateAllAsync()，其他 Locator 辅助方法和 web-first 断言能更好地完成任务。

返回 expression 的返回值。

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

如果 expression 返回 Promise，则 Frame.EvalOnSelectorAllAsync() 将等待 Promise resolve 并返回其值。

用法

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 的 Locator.FillAsync()。阅读更多关于 locators 的信息。

此方法等待与 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#

      是否绕过 actionability 检查。默认为 false。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

FocusAsync​

在 v1.9 之前添加 frame.FocusAsync
不推荐使用

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

此方法获取具有 selector 的元素并聚焦它。如果没有与 selector 匹配的元素，则此方法将等待 DOM 中出现匹配的元素。

用法

await Frame.FocusAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameFocusOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

GetAttributeAsync​

在 v1.9 之前添加 frame.GetAttributeAsync
不推荐使用

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

返回元素属性值。

用法

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

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • name string#

    要获取其值的属性名称。

  • options FrameGetAttributeOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

HoverAsync​

在 v1.9 之前添加 frame.HoverAsync
不推荐使用

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

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

  1. 查找与 selector 匹配的元素。 如果没有，请等待直到匹配的元素附加到 DOM。
  2. 对匹配的元素执行可操作性检查，除非设置了 Force 选项。 如果元素在检查期间被分离，则会重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.Mouse 悬停在元素中心，或指定的 Position。

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

用法

await Frame.HoverAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameHoverOptions? (可选)

    • Force bool? (可选)#

      是否绕过 actionability 检查。默认为 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，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • Trial bool? (可选)添加于版本: v1.11#

      设置后，此方法仅执行可操作性检查并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行它。请注意，无论 trial 如何，都将按下键盘修饰键，以允许测试仅在按下这些键时才可见的元素。

返回

InnerHTMLAsync​

在 v1.9 之前添加 frame.InnerHTMLAsync
不推荐使用

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

返回 element.innerHTML。

用法

await Frame.InnerHTMLAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameInnerHTMLOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

InnerTextAsync​

在 v1.9 之前添加 frame.InnerTextAsync
不推荐使用

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

返回 element.innerText。

用法

await Frame.InnerTextAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameInnerTextOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

InputValueAsync​

添加于：v1.13 frame.InputValueAsync
不推荐使用

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

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

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

用法

await Frame.InputValueAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameInputValueOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

IsCheckedAsync​

在 v1.9 之前添加 frame.IsCheckedAsync
不推荐使用

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

返回元素是否被选中。如果元素不是复选框或单选输入框，则抛出错误。

用法

await Frame.IsCheckedAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameIsCheckedOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

IsDisabledAsync​

在 v1.9 之前添加 frame.IsDisabledAsync
不推荐使用

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

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

用法

await Frame.IsDisabledAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameIsDisabledOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

IsEditableAsync​

在 v1.9 之前添加 frame.IsEditableAsync
不推荐使用

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

返回元素是否可编辑。

用法

await Frame.IsEditableAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameIsEditableOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

IsHiddenAsync​

在 v1.9 之前添加 frame.IsHiddenAsync
不推荐使用

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

返回元素是否隐藏，与可见相反。不匹配任何元素的 selector 被认为是隐藏的。

用法

await Frame.IsHiddenAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameIsHiddenOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      已弃用

      此选项被忽略。Frame.IsHiddenAsync() 不会等待元素变为隐藏状态，并立即返回。

返回

IsVisibleAsync​

在 v1.9 之前添加 frame.IsVisibleAsync
不推荐使用

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

返回元素是否可见。不匹配任何元素的 selector 被认为不可见。

用法

await Frame.IsVisibleAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameIsVisibleOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      已弃用

      此选项被忽略。Frame.IsVisibleAsync() 不会等待元素变为可见状态，并立即返回。

返回

PressAsync​

在 v1.9 之前添加 frame.PressAsync
不推荐使用

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

key 可以指定预期的 keyboardEvent.key 值或生成文本的单个字符。 key 值的超集可以在此处找到。 键的示例包括

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

还支持以下修饰快捷方式：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。 ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

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

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

也支持诸如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 之类的快捷方式。 当与修饰符一起指定时，修饰符被按下并在按下后续键时保持按下状态。

用法

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

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • key string#

    要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。

  • options FramePressOptions? (可选)

    • Delay [float]? (可选)#

      keydown 和 keyup 之间等待的时间，以毫秒为单位。 默认为 0。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项在未来将默认为 true。

      启动导航的操作正在等待这些导航发生并等待页面开始加载。您可以通过设置此标志来选择不等待。您只需要在特殊情况下使用此选项，例如导航到无法访问的页面。默认为 false。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

QuerySelectorAsync​

添加于版本: v1.9 frame.QuerySelectorAsync
不推荐使用

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

返回指向帧元素的 ElementHandle。

caution

不鼓励使用 ElementHandle，请改用 Locator 对象和 web-first 断言。

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

用法

await Frame.QuerySelectorAsync(selector, options);

参数

  • selector string#

    要查询的选择器。

  • options FrameQuerySelectorOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

返回

QuerySelectorAllAsync​

添加于版本: v1.9 frame.QuerySelectorAllAsync
不推荐使用

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

返回指向帧元素的 ElementHandle 数组。

caution

不鼓励使用 ElementHandle，请改用 Locator 对象。

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

用法

await Frame.QuerySelectorAllAsync(selector);

参数

  • selector string#

    要查询的选择器。

返回

RunAndWaitForNavigationAsync​

在 v1.9 之前添加 frame.RunAndWaitForNavigationAsync
已弃用

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

等待帧导航并返回主资源响应。 如果发生多次重定向，导航将使用最后一次重定向的响应 resolve。 如果导航到不同的锚点或由于 History API 使用而导航，则导航将使用 null resolve。

用法

此方法等待帧导航到新的 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 模式、正则表达式模式或谓词，接收 URL。 请注意，如果参数是不带通配符的字符串，则该方法将等待导航到与该字符串完全相等的 URL。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (可选)#

      何时认为操作成功，默认为 load。事件可以是

      • 'domcontentloaded' - 当 DOMContentLoaded 事件被触发时，认为操作已完成。
      • 'load' - 当 load 事件被触发时，认为操作已完成。
      • 'networkidle' - 不建议使用 当至少 500 毫秒内没有网络连接时，认为操作已完成。请勿将此方法用于测试，而应依靠 Web 断言来评估就绪状态。
      • 'commit' - 当收到网络响应并且文档开始加载时，认为操作已完成。

返回

WaitForNavigationAsync​

在 v1.9 之前添加 frame.WaitForNavigationAsync
已弃用

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

等待帧导航并返回主资源响应。 如果发生多次重定向，导航将使用最后一次重定向的响应 resolve。 如果导航到不同的锚点或由于 History API 使用而导航，则导航将使用 null resolve。

用法

此方法等待帧导航到新的 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 模式、正则表达式模式或谓词，接收 URL。 请注意，如果参数是不带通配符的字符串，则该方法将等待导航到与该字符串完全相等的 URL。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (可选)#

      何时认为操作成功，默认为 load。事件可以是

      • 'domcontentloaded' - 当 DOMContentLoaded 事件被触发时，认为操作已完成。
      • 'load' - 当 load 事件被触发时，认为操作已完成。
      • 'networkidle' - 不建议使用 当至少 500 毫秒内没有网络连接时，认为操作已完成。请勿将此方法用于测试，而应依靠 Web 断言来评估就绪状态。
      • 'commit' - 当收到网络响应并且文档开始加载时，认为操作已完成。

返回

SelectOptionAsync​

在 v1.9 之前添加 frame.SelectOptionAsync
不推荐使用

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

此方法等待与 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#

    要查询的选择器。

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

      是否绕过 actionability 检查。默认为 false。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

SetCheckedAsync​

添加于: v1.15 frame.SetCheckedAsync
不推荐使用

请使用基于 locator 的 Locator.SetCheckedAsync() 代替。阅读更多关于 locators 的信息。

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

  1. 查找匹配 selector 的元素。 如果没有找到，则等待直到匹配的元素附加到 DOM 上。
  2. 确保匹配的元素是复选框或单选输入框。如果不是，此方法将抛出错误。
  3. 如果元素已处于正确的选中状态，则此方法立即返回。
  4. 等待匹配元素的可操作性 (actionability) 检查，除非设置了 Force 选项。 如果在检查期间元素被分离，则整个操作将重试。
  5. 如果需要，将元素滚动到视图中。
  6. 使用 Page.Mouse 在元素的中心单击。
  7. 确保元素现在已被选中或取消选中。 如果不是，此方法将抛出错误。

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

用法

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

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • checkedState bool#

    是否选中或取消选中复选框。

  • options FrameSetCheckedOptions? (可选)

    • Force bool? (可选)#

      是否绕过 actionability 检查。默认为 false。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。

    • Strict bool? (可选)#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • Trial bool? (可选)#

      设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待元素准备好执行操作，而无需实际执行它。

返回

SetInputFilesAsync​

在 v1.9 之前添加 frame.SetInputFilesAsync
不推荐使用

请使用基于 locator 的 Locator.SetInputFilesAsync() 代替。阅读更多关于 locators 的信息。

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

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

用法

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

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#

  • options FrameSetInputFilesOptions? (可选)

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

TapAsync​

在 v1.9 之前添加 frame.TapAsync
不推荐使用

请使用基于 locator 的 Locator.TapAsync() 代替。阅读更多关于 locators 的信息。

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

  1. 查找匹配 selector 的元素。 如果没有找到，则等待直到匹配的元素附加到 DOM 上。
  2. 等待匹配元素的可操作性 (actionability) 检查，除非设置了 Force 选项。 如果在检查期间元素被分离，则整个操作将重试。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.Touchscreen 点击元素的中心，或指定的 Position。

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

注意

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

用法

await Frame.TapAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameTapOptions? (可选)

    • Force bool? (可选)#

      是否绕过 actionability 检查。默认为 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，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • Trial bool? (可选)添加于版本: v1.11#

      设置后，此方法仅执行可操作性检查并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行它。请注意，无论 trial 如何，都将按下键盘修饰键，以允许测试仅在按下这些键时才可见的元素。

返回

TextContentAsync​

在 v1.9 之前添加 frame.TextContentAsync
不推荐使用

请使用基于 locator 的 Locator.TextContentAsync() 代替。阅读更多关于 locators 的信息。

返回 element.textContent。

用法

await Frame.TextContentAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameTextContentOptions? (可选)

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

TypeAsync​

在 v1.9 之前添加 frame.TypeAsync
已弃用

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

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

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

用法

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • text string#

    要键入到焦点元素中的文本。

  • options FrameTypeOptions? (可选)

    • Delay [float]? (可选)#

      按键之间等待的时间，以毫秒为单位。默认为 0。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

UncheckAsync​

在 v1.9 之前添加 frame.UncheckAsync
不推荐使用

请使用基于 locator 的 Locator.UncheckAsync() 代替。阅读更多关于 locators 的信息。

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

  1. 查找匹配 selector 的元素。 如果没有找到，则等待直到匹配的元素附加到 DOM 上。
  2. 确保匹配的元素是复选框或单选输入框。如果不是，此方法将抛出错误。 如果元素已被取消选中，则此方法立即返回。
  3. 等待匹配元素的可操作性 (actionability) 检查，除非设置了 Force 选项。 如果在检查期间元素被分离，则整个操作将重试。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 Page.Mouse 在元素的中心单击。
  6. 确保元素现在已被取消选中。 如果不是，此方法将抛出错误。

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

用法

await Frame.UncheckAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果存在多个满足选择器的元素，则将使用第一个元素。

  • options FrameUncheckOptions? (可选)

    • Force bool? (可选)#

      是否绕过 actionability 检查。默认为 false。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)添加于版本: v1.11#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

    • Trial bool? (可选)添加于版本: v1.11#

      设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待元素准备好执行操作，而无需实际执行它。

返回

WaitForSelectorAsync​

在 v1.9 之前添加 frame.WaitForSelectorAsync
不推荐使用

请使用断言可见性的 Web 断言或基于 locator 的 Locator.WaitForAsync() 代替。阅读更多关于 locators 的信息。

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

注意

Playwright 会在执行操作之前自动等待元素准备就绪。 使用 Locator 对象和 Web-first 断言使代码无需使用 wait-for-selector。

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

用法

此方法跨导航工作

using Microsoft.Playwright;
using System;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Chromium.LaunchAsync();
        var page = await browser.NewPageAsync();

        foreach (var currentUrl in new[] { "https://www.google.com", "https://bbc.com" })
        {
            await page.GotoAsync(currentUrl);
            element = await page.MainFrame.WaitForSelectorAsync("img");
            Console.WriteLine($"Loaded image: {await element.GetAttributeAsync("src")}");
        }
    }
}

参数

  • selector string#

    要查询的选择器。

  • options FrameWaitForSelectorOptions? (可选)

    • State enum WaitForSelectorState { Attached, Detached, Visible, Hidden }? (可选)#

      默认为 'visible'。 可以是以下之一

      • 'attached' - 等待元素出现在 DOM 中。
      • 'detached' - 等待元素不在 DOM 中。
      • 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden 样式。 请注意，没有任何内容或具有 display:none 样式的元素具有空的边界框，并且不被认为是可见的。
      • 'hidden' - 等待元素从 DOM 中分离，或具有空的边界框或 visibility:hidden 样式。 这与 'visible' 选项相反。

    • Strict bool? (可选)添加于：v1.14#

      如果为 true，则调用需要 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。

    • Timeout [float]? (可选)#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回

WaitForTimeoutAsync​

在 v1.9 之前添加 frame.WaitForTimeoutAsync
不推荐使用

永远不要在生产环境中使用 timeout 等待。 等待时间的测试本质上是不稳定的。 请使用 Locator 操作和自动等待的 Web 断言。

等待给定的 timeout 毫秒数。

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

用法

await Frame.WaitForTimeoutAsync(timeout);

参数

  • timeout [float]#

    要等待的超时时间

返回