跳转到主要内容

Frame

在任何时间点，页面都会通过 Page.mainFrame() 和 Frame.childFrames() 方法暴露其当前的帧树。

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

转储框架树的示例

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType firefox = playwright.firefox();
      Browser browser = firefox.launch();
      Page page = browser.newPage();
      page.navigate("https://www.google.com/chrome/browser/canary.html");
      dumpFrameTree(page.mainFrame(), "");
      browser.close();
    }
  }
  static void dumpFrameTree(Frame frame, String indent) {
    System.out.println(indent + frame.url());
    for (Frame child : frame.childFrames()) {
      dumpFrameTree(child, indent + "  ");
    }
  }
}

方法​

addScriptTag​

v1.9 之前添加 frame.addScriptTag

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

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

用法

Frame.addScriptTag();
Frame.addScriptTag(options);

参数

  • options Frame.AddScriptTagOptions (可选)

    • setContent String (可选)#

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

    • setPath Path (可选)#

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

    • setType String (可选)#

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

    • setUrl String (可选)#

      要添加的脚本的 URL。

返回

addStyleTag​

v1.9 之前添加 frame.addStyleTag

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

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

用法

Frame.addStyleTag();
Frame.addStyleTag(options);

参数

  • options Frame.AddStyleTagOptions (可选)

    • setContent String (可选)#

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

    • setPath Path (可选)#

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

    • setUrl String (可选)#

      <link> 标签的 URL。

返回

childFrames​

v1.9 之前添加 frame.childFrames

用法

Frame.childFrames();

返回

content​

v1.9 之前添加 frame.content

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

用法

Frame.content();

返回

dragAndDrop​

添加于：v1.13 frame.dragAndDrop

用法

Frame.dragAndDrop(source, target);
Frame.dragAndDrop(source, target, options);

参数

  • source String#

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

  • target String#

    用于搜索要拖放到的元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.DragAndDropOptions (可选)

    • setForce boolean (可选)#

      是否绕过 可操作性 检查。默认为 false。

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setSourcePosition SourcePosition (可选)新增于：v1.14#

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

    • setSteps int (可选)Added in: v1.57#

      默认为 1。发送 n 个插值的 mousemove 事件以表示从 mousedown 到 mouseup 的拖动过程。当设置为 1 时，在目标位置发出单个 mousemove 事件。

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTargetPosition TargetPosition (可选)新增于：v1.14#

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

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选)#

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

返回

evaluate​

v1.9 之前添加 frame.evaluate

返回 expression 的返回值。

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

如果传递给 Frame.evaluate() 的函数返回一个非 可序列化 的值，则 Frame.evaluate() 返回 undefined。Playwright 也支持传输一些不能被 JSON 序列化的附加值：-0, NaN, Infinity, -Infinity。

用法

Object result = frame.evaluate("([x, y]) => {\n" +
  "  return Promise.resolve(x * y);\n" +
  "}", Arrays.asList(7, 8));
System.out.println(result); // prints "56"

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

System.out.println(frame.evaluate("1 + 2")); // prints "3"

ElementHandle 实例可以作为参数传递给 Frame.evaluate()

ElementHandle bodyHandle = frame.evaluate("document.body");
String html = (String) frame.evaluate("([body, suffix]) => body.innerHTML + suffix", Arrays.asList(bodyHandle, "hello"));
bodyHandle.dispose();

参数

  • expression String#

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

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

返回

evaluateHandle​

v1.9 之前添加 frame.evaluateHandle

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

Frame.evaluate() 和 Frame.evaluateHandle() 之间的唯一区别是 Frame.evaluateHandle() 返回 JSHandle。

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

用法

// Handle for the window object.
JSHandle aWindowHandle = frame.evaluateHandle("() => Promise.resolve(window)");

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

JSHandle aHandle = frame.evaluateHandle("document"); // Handle for the "document".

JSHandle 实例可以作为参数传递给 Frame.evaluateHandle()

JSHandle aHandle = frame.evaluateHandle("() => document.body");
JSHandle resultHandle = frame.evaluateHandle("([body, suffix]) => body.innerHTML + suffix", Arrays.asList(aHandle, "hello"));
System.out.println(resultHandle.jsonValue());
resultHandle.dispose();

参数

  • expression String#

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

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

返回

frameElement​

v1.9 之前添加 frame.frameElement

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

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

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

用法

ElementHandle frameElement = frame.frameElement();
Frame contentFrame = frameElement.contentFrame();
System.out.println(frame == contentFrame);  // -> true

返回

frameLocator​

新增于: v1.17 frame.frameLocator

使用 iframe 时，您可以创建一个框架定位器，它将进入 iframe 并允许选择 iframe 中的元素。

用法

以下代码片段在 id 为 my-frame 的 iframe 中查找文本为“提交”的元素，例如 <iframe id="my-frame">

Locator locator = frame.frameLocator("#my-iframe").getByText("Submit");
locator.click();

参数

  • selector String#

    用于解析 DOM 元素的选取器。

返回

getByAltText​

新增于：v1.27 frame.getByAltText

允许根据元素的 alt 文本定位元素。

用法

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

<img alt='Playwright logo'>
page.getByAltText("Playwright logo").click();

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Frame.GetByAltTextOptions (可选)

    • setExact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

返回

getByLabel​

新增于：v1.27 frame.getByLabel

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

用法

例如，此方法将在以下 DOM 中通过标签“用户名”和“密码”找到输入

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
page.getByLabel("Username").fill("john");
page.getByLabel("Password").fill("secret");

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Frame.GetByLabelOptions (可选)

    • setExact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

返回

getByPlaceholder​

新增于：v1.27 frame.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

您可以按占位符文本定位输入框后填充它

page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Frame.GetByPlaceholderOptions (可选)

    • setExact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

返回

getByRole​

新增于：v1.27 frame.getByRole

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

用法

考虑以下 DOM 结构。

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

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

assertThat(page
    .getByRole(AriaRole.HEADING,
               new Page.GetByRoleOptions().setName("Sign up")))
    .isVisible();

page.getByRole(AriaRole.CHECKBOX,
               new Page.GetByRoleOptions().setName("Subscribe"))
    .check();

page.getByRole(AriaRole.BUTTON,
               new Page.GetByRoleOptions().setName(
                   Pattern.compile("submit", Pattern.CASE_INSENSITIVE)))
    .click();

参数

  • 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 Frame.GetByRoleOptions (可选)

    • setChecked boolean (可选)#

      通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。

      了解更多关于 aria-checked 的信息。

    • setDisabled boolean (可选)#

      通常由 aria-disabled 或 disabled 设置的属性。

      注意

      与大多数其他属性不同，disabled 在 DOM 层次结构中是继承的。了解更多关于 aria-disabled 的信息。

    • setExact boolean (可选)新增于: v1.28#

      是否精确匹配 setName：区分大小写且全字符串匹配。默认为 false。当 setName 是正则表达式时忽略。注意，精确匹配仍然会修剪空白。

    • setExpanded boolean (可选)#

      通常由 aria-expanded 设置的属性。

      了解更多关于 aria-expanded 的信息。

    • setIncludeHidden boolean (可选)#

      控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（由 ARIA 定义）由角色选择器匹配。

      了解更多关于 aria-hidden 的信息。

    • setLevel int (可选)#

      通常用于角色 heading、listitem、row、treeitem 的数字属性，<h1>-<h6> 元素具有默认值。

      了解更多关于 aria-level 的信息。

    • setName String | Pattern (可选)#

      用于匹配 可访问名称 的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 setExact 来控制此行为。

      了解更多关于 可访问名称 的信息。

    • setPressed boolean (可选)#

      通常由 aria-pressed 设置的属性。

      了解更多关于 aria-pressed 的信息。

    • setSelected boolean (可选)#

      通常由 aria-selected 设置的属性。

      了解更多关于 aria-selected 的信息。

返回

详情

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

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

getByTestId​

新增于：v1.27 frame.getByTestId

按测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过其测试 ID 定位元素

page.getByTestId("directions").click();

参数

返回

详情

默认情况下，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 Page.GetByTextOptions().setExact(true));

// Matches both <div>s
page.getByText(Pattern.compile("Hello"));

// Matches second <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Frame.GetByTextOptions (可选)

    • setExact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

返回

详情

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

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

getByTitle​

新增于：v1.27 frame.getByTitle

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

用法

考虑以下 DOM 结构。

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

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

assertThat(page.getByTitle("Issues count")).hasText("25 issues");

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Frame.GetByTitleOptions (可选)

    • setExact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

返回

isDetached​

v1.9 之前添加 frame.isDetached

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

用法

Frame.isDetached();

返回

isEnabled​

v1.9 之前添加 frame.isEnabled

返回元素是否 启用。

用法

Frame.isEnabled(selector);
Frame.isEnabled(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.IsEnabledOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

locator​

新增于：v1.14 frame.locator

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

了解更多关于定位器.

了解更多关于定位器.

用法

Frame.locator(selector);
Frame.locator(selector, options);

参数

  • selector String#

    用于解析 DOM 元素的选取器。

  • options Frame.LocatorOptions (可选)

    • setHas Locator (可选)#

      将方法的返回结果缩小到包含匹配此相对定位器的元素的结果。例如，article 包含 text=Playwright 匹配 <article><div>Playwright</div></article>。

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

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

    • setHasNot Locator (可选)新增于：v1.33#

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

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

    • setHasNotText String | Pattern (optional)新增于：v1.33#

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

    • setHasText String | Pattern (可选)#

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

返回

name​

v1.9 之前添加 frame.name

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

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

注意

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

用法

Frame.name();

返回

navigate​

v1.9 之前添加 frame.navigate

返回主资源响应。如果发生多次重定向，导航将解析为最后一次重定向的响应。

此方法将在以下情况下抛出错误

  • 存在 SSL 错误（例如自签名证书）。
  • 目标 URL 无效。
  • 超过 setTimeout 时抛出异常。
  • 远程服务器无响应或无法访问。
  • 主资源加载失败。

当远程服务器返回任何有效的 HTTP 状态码时，该方法都不会抛出错误，包括 404 "Not Found" 和 500 "Internal Server Error"。可以通过调用 Response.status() 来获取此类响应的状态码。

注意

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

注意

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

用法

Frame.navigate(url);
Frame.navigate(url, options);

参数

  • url String#

    要导航框架到的 URL。URL 应包含方案，例如 https://。

  • options Frame.NavigateOptions (可选)

    • setReferer String (可选)#

      Referer 头部值。如果提供，它将优先于由 Page.setExtraHTTPHeaders() 设置的 referer 头部值。

    • setTimeout double (可选)#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (可选)#

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

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
      • 'load' - 当 load 事件触发时，认为操作完成。
      • 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
      • 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

page​

v1.9 之前添加 frame.page

返回包含此框架的页面。

用法

Frame.page();

返回

parentFrame​

v1.9 之前添加 frame.parentFrame

父框架，如果有的话。分离的框架和主框架返回 null。

用法

Frame.parentFrame();

返回

setContent​

v1.9 之前添加 frame.setContent

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

用法

Frame.setContent(html);
Frame.setContent(html, options);

参数

  • html String#

    要分配给页面的 HTML 标记。

  • options Frame.SetContentOptions (可选)

    • setTimeout double (可选)#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (可选)#

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

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
      • 'load' - 当 load 事件触发时，认为操作完成。
      • 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
      • 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

title​

v1.9 之前添加 frame.title

返回页面标题。

用法

Frame.title();

返回

url​

v1.9 之前添加 frame.url

返回框架的 url。

用法

Frame.url();

返回

waitForFunction​

v1.9 之前添加 frame.waitForFunction

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

用法

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

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType firefox = playwright.firefox();
      Browser browser = firefox.launch();
      Page page = browser.newPage();
      page.setViewportSize(50, 50);
      page.mainFrame().waitForFunction("window.innerWidth < 100");
      browser.close();
    }
  }
}

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

String selector = ".foo";
frame.waitForFunction("selector => !!document.querySelector(selector)", selector);

参数

  • expression String#

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

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

  • options Frame.WaitForFunctionOptions (可选)

    • setPollingInterval double (可选)#

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

    • setTimeout double (可选)#

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

返回

waitForLoadState​

v1.9 之前添加 frame.waitForLoadState

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

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

注意

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

用法

frame.click("button"); // Click triggers navigation.
frame.waitForLoadState(); // Waits for "load" state by default.

参数

  • state enum LoadState { LOAD, DOMCONTENTLOADED, NETWORKIDLE } (可选)#

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

    • 'load' - 等待 load 事件触发。
    • 'domcontentloaded' - 等待 DOMContentLoaded 事件触发。
    • 'networkidle' - **不推荐** 等待至少 500 毫秒内没有网络连接。不要将此方法用于测试，而是依赖 Web 断言来评估准备情况。

  • options Frame.WaitForLoadStateOptions (可选)

返回

waitForURL​

添加于：v1.11 frame.waitForURL

等待框架导航到给定 URL。

用法

frame.click("a.delayed-navigation"); // Clicking the link will indirectly cause a navigation
frame.waitForURL("**/target.html");

参数

  • url String | Pattern | Predicate<String>#

    一个 glob 模式、正则表达式模式或接收 [URL] 进行匹配的谓词，用于在等待导航时匹配。请注意，如果参数是**不含**通配符的字符串，则方法将等待导航到与该字符串完全相等的 URL。

  • options Frame.WaitForURLOptions (可选)

    • setTimeout double (可选)#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (可选)#

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

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
      • 'load' - 当 load 事件触发时，认为操作完成。
      • 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
      • 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

已弃用​

check​

v1.9 之前添加 frame.check
不推荐

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

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

  1. 查找与 selector 匹配的元素。如果找不到，则等待匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选输入。如果不是，此方法将抛出。如果元素已被选中，此方法将立即返回。
  3. 等待匹配元素的 可操作性 检查，除非设置了 setForce 选项。如果在检查过程中元素分离，则重试整个操作。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 Page.mouse() 点击元素中心。
  6. 确保元素现在已选中。如果不是，此方法将抛出异常。

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此操作。

用法

Frame.check(selector);
Frame.check(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.CheckOptions (可选)

    • setForce boolean (可选)#

      是否绕过 可操作性 检查。默认为 false。

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)添加于：v1.11#

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

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选)添加于：v1.11#

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

返回

click​

v1.9 之前添加 frame.click
不推荐

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

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

  1. 查找与 selector 匹配的元素。如果找不到，则等待匹配的元素附加到 DOM。
  2. 等待匹配元素的 可操作性 检查，除非设置了 setForce 选项。如果在检查过程中元素分离，则重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.mouse() 点击元素中心，或指定的 setPosition。
  5. 等待已启动的导航成功或失败，除非设置了 setNoWaitAfter 选项。

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此操作。

用法

Frame.click(selector);
Frame.click(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.ClickOptions (可选)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (可选)#

      默认为 left。

    • setClickCount int (可选)#

      默认为 1。参见 UIEvent.detail。

    • setDelay double (可选)#

      mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。

    • setForce boolean (可选)#

      是否绕过 可操作性 检查。默认为 false。

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项将来默认为 true。

      发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。

    • setPosition Position (可选)#

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

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选)添加于：v1.11#

      如果设置，此方法仅执行 可操作性 检查并跳过操作。默认为 false。可用于在不执行操作的情况下等待元素准备好执行操作。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以便测试在按下这些键时才可见的元素。

返回

dblclick​

v1.9 之前添加 frame.dblclick
不推荐

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

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

  1. 查找与 selector 匹配的元素。如果找不到，则等待匹配的元素附加到 DOM。
  2. 等待匹配元素的 可操作性 检查，除非设置了 setForce 选项。如果在检查过程中元素分离，则重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.mouse() 双击元素中心，或指定的 setPosition。如果 dblclick() 的第一次点击触发了导航事件，此方法将抛出异常。

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此操作。

注意

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

用法

Frame.dblclick(selector);
Frame.dblclick(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.DblclickOptions (可选)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (可选)#

      默认为 left。

    • setDelay double (可选)#

      mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。

    • setForce boolean (可选)#

      是否绕过 可操作性 检查。默认为 false。

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选)添加于：v1.11#

      如果设置，此方法仅执行 可操作性 检查并跳过操作。默认为 false。可用于在不执行操作的情况下等待元素准备好执行操作。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以便测试在按下这些键时才可见的元素。

返回

dispatchEvent​

v1.9 之前添加 frame.dispatchEvent
不推荐

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

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

用法

frame.dispatchEvent("button#submit", "click");

在底层，它根据给定的 type 创建一个事件实例，使用 eventInit 属性对其进行初始化，并将其派发到元素上。事件默认是 composed、cancelable 和冒泡的。

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

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

// Note you can only create DataTransfer in Chromium and Firefox
JSHandle dataTransfer = frame.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
frame.dispatchEvent("#source", "dragstart", arg);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • type String#

    DOM 事件类型："click"、"dragstart" 等。

  • eventInit EvaluationArgument (可选)#

    可选的事件特定初始化属性。

  • options Frame.DispatchEventOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

evalOnSelector​

添加于：v1.9 frame.evalOnSelector
不推荐

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

返回 expression 的返回值。

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

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

用法

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

参数

  • selector String#

    要查询的选择器。

  • expression String#

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

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

  • options Frame.EvalOnSelectorOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

返回

evalOnSelectorAll​

添加于：v1.9 frame.evalOnSelectorAll
不推荐

在大多数情况下，Locator.evaluateAll()、其他 Locator 辅助方法和 web-first 断言做得更好。

返回 expression 的返回值。

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

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

用法

boolean divsCounts = (boolean) page.evalOnSelectorAll("div", "(divs, min) => divs.length >= min", 10);

参数

  • selector String#

    要查询的选择器。

  • expression String#

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

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

返回

fill​

v1.9 之前添加 frame.fill
不推荐

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

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

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

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

用法

Frame.fill(selector, value);
Frame.fill(selector, value, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • value String#

    要填充 <input>、<textarea> 或 [contenteditable] 元素的值。

  • options Frame.FillOptions (可选)

    • setForce boolean (可选)添加于：v1.13#

      是否绕过 可操作性 检查。默认为 false。

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

focus​

v1.9 之前添加 frame.focus
不推荐

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

此方法获取与 selector 匹配的元素并使其获得焦点。如果找不到匹配 selector 的元素，该方法将等待匹配的元素出现在 DOM 中。

用法

Frame.focus(selector);
Frame.focus(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.FocusOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

getAttribute​

v1.9 之前添加 frame.getAttribute
不推荐

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

返回元素属性值。

用法

Frame.getAttribute(selector, name);
Frame.getAttribute(selector, name, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • name String#

    要获取值的属性名称。

  • options Frame.GetAttributeOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

hover​

v1.9 之前添加 frame.hover
不推荐

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

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

  1. 查找与 selector 匹配的元素。如果找不到，则等待匹配的元素附加到 DOM。
  2. 等待匹配元素的 可操作性 检查，除非设置了 setForce 选项。如果在检查过程中元素分离，则重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.mouse() 悬停在元素中心，或指定的 setPosition。

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此操作。

用法

Frame.hover(selector);
Frame.hover(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.HoverOptions (可选)

    • setForce boolean (可选)#

      是否绕过 可操作性 检查。默认为 false。

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#

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

    • setNoWaitAfter boolean (可选)新增于: v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选)添加于：v1.11#

      如果设置，此方法仅执行 可操作性 检查并跳过操作。默认为 false。可用于在不执行操作的情况下等待元素准备好执行操作。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以便测试在按下这些键时才可见的元素。

返回

innerHTML​

v1.9 之前添加 frame.innerHTML
不推荐

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

返回 element.innerHTML。

用法

Frame.innerHTML(selector);
Frame.innerHTML(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.InnerHTMLOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

innerText​

v1.9 之前添加 frame.innerText
不推荐

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

返回 element.innerText。

用法

Frame.innerText(selector);
Frame.innerText(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.InnerTextOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

inputValue​

添加于：v1.13 frame.inputValue
不推荐

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

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

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

用法

Frame.inputValue(selector);
Frame.inputValue(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.InputValueOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

isChecked​

v1.9 之前添加 frame.isChecked
不推荐

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

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

用法

Frame.isChecked(selector);
Frame.isChecked(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.IsCheckedOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

isDisabled​

v1.9 之前添加 frame.isDisabled
不推荐

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

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

用法

Frame.isDisabled(selector);
Frame.isDisabled(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.IsDisabledOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

isEditable​

v1.9 之前添加 frame.isEditable
不推荐

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

返回元素是否 可编辑。

用法

Frame.isEditable(selector);
Frame.isEditable(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.IsEditableOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

isHidden​

v1.9 之前添加 frame.isHidden
不推荐

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

返回元素是否隐藏，即 可见 的反面。与任何元素都不匹配的 selector 被视为隐藏。

用法

Frame.isHidden(selector);
Frame.isHidden(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.IsHiddenOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      已弃用

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

返回

isVisible​

v1.9 之前添加 frame.isVisible
不推荐

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

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

用法

Frame.isVisible(selector);
Frame.isVisible(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.IsVisibleOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      已弃用

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

返回

press​

v1.9 之前添加 frame.press
不推荐

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

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"。当与修饰符一起指定时，修饰符在按下后续键时被按下并保持。

用法

Frame.press(selector, key);
Frame.press(selector, key, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • key String#

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

  • options Frame.PressOptions (可选)

    • setDelay double (可选)#

      keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项将来默认为 true。

      发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

querySelector​

添加于：v1.9 frame.querySelector
不推荐

建议使用基于定位器的 Frame.locator()。阅读有关 定位器的更多信息。

返回指向框架元素的 ElementHandle。

注意

不建议使用 ElementHandle，请使用 Locator 对象和面向网页的断言。

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

用法

Frame.querySelector(selector);
Frame.querySelector(selector, options);

参数

  • selector String#

    要查询的选择器。

  • options Frame.QuerySelectorOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

返回

querySelectorAll​

添加于：v1.9 frame.querySelectorAll
不推荐

建议使用基于定位器的 Frame.locator()。阅读有关 定位器的更多信息。

返回指向框架元素的 ElementHandles。

注意

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

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

用法

Frame.querySelectorAll(selector);

参数

  • selector String#

    要查询的选择器。

返回

selectOption​

v1.9 之前添加 frame.selectOption
不推荐

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

此方法等待与 selector 匹配的元素，等待 可操作性检查，等待直到所有指定的选项都存在于 <select> 元素中并选择这些选项。

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

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

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

用法

// Single selection matching the value or label
frame.selectOption("select#colors", "blue");
// single selection matching both the value and the label
frame.selectOption("select#colors", new SelectOption().setLabel("Blue"));
// multiple selection
frame.selectOption("select#colors", new String[] {"red", "green", "blue"});

参数

  • selector String#

    要查询的选择器。

  • values null | String | ElementHandle | String[] | SelectOption | ElementHandle[] | SelectOption[]#

    • setValue String (可选)

      按 option.value 匹配。可选。

    • setLabel String (可选)

      按 option.label 匹配。可选。

    • setIndex int (可选)

      按索引匹配。可选。

    要选择的选项。如果 <select> 具有 multiple 属性，则选择所有匹配的选项，否则仅选择与传入选项之一匹配的第一个选项。字符串值同时匹配值和标签。当所有指定的属性都匹配时，认为选项匹配。

  • options Frame.SelectOptionOptions (可选)

    • setForce boolean (可选)添加于：v1.13#

      是否绕过 可操作性 检查。默认为 false。

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

setChecked​

新增于: v1.15 frame.setChecked
不推荐

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

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

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

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时禁用此设置。

用法

Frame.setChecked(selector, checked);
Frame.setChecked(selector, checked, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • checked boolean#

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

  • options Frame.SetCheckedOptions (可选)

    • setForce boolean (可选)#

      是否绕过 可操作性 检查。默认为 false。

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

    • setStrict boolean (可选)#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选)#

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

返回

setInputFiles​

v1.9 之前添加 frame.setInputFiles
不推荐

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

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

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

用法

Frame.setInputFiles(selector, files);
Frame.setInputFiles(selector, files, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • files Path | Path[] | FilePayload | FilePayload[]#

  • options Frame.SetInputFilesOptions (可选)

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

tap​

v1.9 之前添加 frame.tap
不推荐

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

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

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

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时禁用此设置。

注意

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

用法

Frame.tap(selector);
Frame.tap(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.TapOptions (可选)

    • setForce boolean (可选)#

      是否绕过 可操作性 检查。默认为 false。

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选)添加于：v1.11#

      如果设置，此方法仅执行 可操作性 检查并跳过操作。默认为 false。可用于在不执行操作的情况下等待元素准备好执行操作。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以便测试在按下这些键时才可见的元素。

返回

textContent​

v1.9 之前添加 frame.textContent
不推荐

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

返回 element.textContent。

用法

Frame.textContent(selector);
Frame.textContent(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.TextContentOptions (可选)

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

type​

v1.9 之前添加 frame.type
已弃用

在大多数情况下，您应该使用 Locator.fill()。只有当页面上有特殊的键盘处理时，您才需要一个一个地按下按键——在这种情况下，请使用 Locator.pressSequentially()。

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

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

用法

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • text String#

    要输入到聚焦元素的文本。

  • options Frame.TypeOptions (可选)

    • setDelay double (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

uncheck​

v1.9 之前添加 frame.uncheck
不推荐

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

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

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

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时禁用此设置。

用法

Frame.uncheck(selector);
Frame.uncheck(selector, options);

参数

  • selector String#

    用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Frame.UncheckOptions (可选)

    • setForce boolean (可选)#

      是否绕过 可操作性 检查。默认为 false。

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)添加于：v1.11#

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

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选)添加于：v1.11#

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

返回

waitForNavigation​

v1.9 之前添加 frame.waitForNavigation
已弃用

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

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

用法

此方法等待帧导航到新 URL。当您运行间接导致帧导航的代码时，此方法非常有用。请考虑以下示例：

// The method returns after navigation has finished
frame.waitForNavigation(() -> {
  // Clicking the link will indirectly cause a navigation
  frame.click("a.delayed-navigation");
});
注意

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

参数

  • options Frame.WaitForNavigationOptions (可选)

    • setTimeout double (可选)#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setUrl String | Pattern | Predicate<String> (可选)#

      一个 glob 模式、正则表达式模式或接收 [URL] 进行匹配的谓词，用于在等待导航时匹配。请注意，如果参数是**不含**通配符的字符串，则方法将等待导航到与该字符串完全相等的 URL。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (可选)#

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

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
      • 'load' - 当 load 事件触发时，认为操作完成。
      • 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
      • 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

  • callback Runnable添加于：v1.9#

    执行触发事件的操作的回调。

返回

waitForSelector​

v1.9 之前添加 frame.waitForSelector
不推荐

使用声称可见性的网页断言或基于定位器的 Locator.waitFor() 代替。阅读有关 定位器的更多信息。

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

注意

Playwright 会自动等待元素准备好后再执行操作。使用 Locator 对象和面向网页的断言可以使代码无需等待选择器。

等待 selector 满足 setState 选项（出现在/从 DOM 中移除，或可见/隐藏）。如果在调用方法时 selector 已经满足条件，则方法将立即返回。如果选择器在 setTimeout 毫秒内不满足条件，函数将抛出异常。

用法

此方法适用于跨导航

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType chromium = playwright.chromium();
      Browser browser = chromium.launch();
      Page page = browser.newPage();
      for (String currentURL : Arrays.asList("https://google.com", "https://bbc.com")) {
        page.navigate(currentURL);
        ElementHandle element = page.mainFrame().waitForSelector("img");
        System.out.println("Loaded image: " + element.getAttribute("src"));
      }
      browser.close();
    }
  }
}

参数

  • selector String#

    要查询的选择器。

  • options Frame.WaitForSelectorOptions (可选)

    • setState enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN } (可选)#

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

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

    • setStrict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • setTimeout double (可选)#

      以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回

waitForTimeout​

v1.9 之前添加 frame.waitForTimeout
不推荐

切勿在生产环境中等待超时。等待时间的测试本质上是不稳定的。使用 Locator 操作和自动等待的网页断言。

等待给定的 timeout 毫秒。

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

用法

Frame.waitForTimeout(timeout);

参数

返回