跳到主要内容

Frame

在任何时间点,页面都会通过 Page.mainFrame()Frame.childFrames() 方法公开其当前的 frame 树。

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

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

<script> 标签添加到页面中,带有期望的 url 或内容。

用法

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

参数

  • options Frame.AddScriptTagOptions (可选)
    • setContent String (可选)#

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

    • setPath Path (可选)#

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

    • setType String (可选)#

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

    • setUrl String (可选)#

      要添加的脚本的 URL。

返回值


addStyleTag

在 v1.9 之前添加 frame.addStyleTag

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

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

用法

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

参数

  • options Frame.AddStyleTagOptions (可选)
    • setContent String (可选)#

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

    • setPath Path (可选)#

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

    • setUrl String (可选)#

      <link> 标签的 URL。

返回值


childFrames

在 v1.9 之前添加 frame.childFrames

用法

Frame.childFrames();

返回值


content

在 v1.9 之前添加 frame.content

获取 frame 的完整 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 (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setSourcePosition SourcePosition (可选)添加于: v1.14#

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

    • setStrict boolean (可选)添加于: v1.14#

      当为 true 时,调用需要选择器解析为单个元素。 如果给定选择器解析为多个元素,则调用将抛出异常。

    • setTargetPosition TargetPosition (可选)添加于: v1.14#

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

    • setTimeout double (可选)#

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

    • setTrial boolean (可选)#

      设置后,此方法仅执行 actionability 检查并跳过操作。 默认为 false。 用于等待元素准备好执行操作,但不执行它。

返回值


evaluate

在 v1.9 之前添加 frame.evaluate

返回 expression 的返回值。

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

如果传递给 Frame.evaluate() 的函数返回一个非 Serializable 值,则 Frame.evaluate() 返回 undefined。 Playwright 还支持传输一些额外的非 JSON 可序列化的值:-0NaNInfinity-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 对应的 frameiframe 元素句柄。

这是 ElementHandle.contentFrame() 的逆操作。 请注意,返回的句柄实际上属于父 frame。

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

用法

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

返回值


frameLocator

添加于: v1.17 frame.frameLocator

当使用 iframe 时,您可以创建一个 frame 定位器,它将进入 iframe 并允许在 iframe 中选择元素。

用法

以下代码片段在 id 为 my-frame 的 iframe 中定位文本为 "Submit" 的元素,如 <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 中通过标签 "Username" 和 "Password" 查找输入

<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-disableddisabled 设置的属性。

      注意

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

    • setExact boolean (可选)添加于: v1.28#

      是否精确匹配 setName:区分大小写和全字符串。 默认为 false。 当 setName 是正则表达式时被忽略。 请注意,完全匹配仍然会修剪空格。

    • setExpanded boolean (可选)#

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

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

    • setIncludeHidden boolean (可选)#

      控制是否匹配隐藏元素的选项。 默认情况下,只有非隐藏元素,如 ARIA 定义,才会被角色选择器匹配。

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

    • setLevel int (可选)#

      一个数字属性,通常存在于角色 headinglistitemrowtreeitem 中,对于 <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。 如果需要配置不同的测试 ID 属性,请使用 Selectors.setTestIdAttribute()


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

返回值

详情

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

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


getByTitle

添加于: v1.27 frame.getByTitle

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

用法

考虑以下 DOM 结构。

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

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

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

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Frame.GetByTitleOptions (可选)

    • setExact boolean (可选)#

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

返回值


isDetached

在 v1.9 之前添加 frame.isDetached

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

用法

Frame.isDetached();

返回值


isEnabled

在 v1.9 之前添加 frame.isEnabled

返回元素是否为 启用状态

用法

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

参数

  • selector String#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • options Frame.IsEnabledOptions (可选)

    • setStrict boolean (可选)添加于: v1.14#

      当为 true 时,调用需要选择器解析为单个元素。 如果给定选择器解析为多个元素,则调用将抛出异常。

    • setTimeout double (可选)#

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

返回值


locator

添加于: v1.14 frame.locator

此方法返回一个元素定位器,可用于对当前页面/ frame 执行操作。定位器在执行操作前会立即解析为元素,因此对同一定位器执行的一系列操作实际上可能在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构发生了更改,则会发生这种情况。

了解更多关于定位器的信息.

了解更多关于定位器的信息.

用法

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

参数

  • selector String#

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

  • options Frame.LocatorOptions (可选)

    • setHas Locator (可选)#

      将方法的结果范围缩小到包含与此相对定位器匹配的元素的那些结果。例如,包含 text=Playwrightarticle<article><div>Playwright</div></article> 匹配。

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

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

    • setHasNot Locator (可选)添加于: v1.33#

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

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

    • setHasNotText String | Pattern (可选)添加于: v1.33#

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

    • setHasText String | Pattern (可选)#

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

返回值


name

在 v1.9 之前添加 frame.name

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

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

注意

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

用法

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#

    要导航 frame 的 URL。该 URL 应包含 scheme,例如 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 的页面。

用法

Frame.page();

返回值


parentFrame

在 v1.9 之前添加 frame.parentFrame

父 frame(如果有)。分离的 frame 和主 frame 返回 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

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

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

当 frame 达到所需的加载状态时返回,默认情况下为 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

等待 frame 导航到给定的 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#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • options Frame.CheckOptions (可选)

    • setForce boolean (可选)#

      是否绕过 actionability 检查。 默认为 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#

      设置后,此方法仅执行 actionability 检查并跳过操作。 默认为 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#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • options Frame.ClickOptions (可选)

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

      默认为 left

    • setClickCount int (可选)#

      默认为 1。请参阅 UIEvent.detail

    • setDelay double (可选)#

      mousedownmouseup 之间等待的时间(毫秒)。默认为 0。

    • setForce boolean (可选)#

      是否绕过 actionability 检查。 默认为 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#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • options Frame.DblclickOptions (可选)

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

      默认为 left

    • setDelay double (可选)#

      mousedownmouseup 之间等待的时间(毫秒)。默认为 0。

    • setForce boolean (可选)#

      是否绕过 actionability 检查。 默认为 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 属性初始化它,并在元素上派发它。事件默认是 composedcancelable 和冒泡的。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • 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-first 断言代替。

返回 expression 的返回值。

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

如果 expression 返回一个 Promise,那么 Frame.evalOnSelector() 将等待 Promise resolve 并返回其值。

用法

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 的返回值。

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

如果 expression 返回一个 Promise,那么 Frame.evalOnSelectorAll() 将等待 Promise resolve 并返回其值。

用法

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#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • value String#

    要为 <input>, <textarea>[contenteditable] 元素填充的值。

  • options Frame.FillOptions (可选)

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

      是否绕过 actionability 检查。 默认为 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#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • options Frame.HoverOptions (可选)

    • setForce boolean (可选)#

      是否绕过 actionability 检查。 默认为 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#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • options Frame.IsCheckedOptions (可选)

    • setStrict boolean (可选)添加于: v1.14#

      当为 true 时,调用需要选择器解析为单个元素。 如果给定选择器解析为多个元素,则调用将抛出异常。

    • setTimeout double (可选)#

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

返回值


isDisabled

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

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

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

用法

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

参数

  • selector String#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • 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, ControlOrMetaControlOrMeta 在 Windows 和 Linux 上解析为 Control,在 macOS 上解析为 Meta

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

如果 key 是单个字符,则它是区分大小写的,因此值 aA 将生成不同的相应文本。

也支持诸如 key: "Control+o", key: "Control++key: "Control+Shift+T" 之类的快捷方式。当使用修饰符指定时,修饰符在后续键被按下时被按下并保持按住状态。

用法

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

参数

  • selector String#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • key String#

    要按下的键的名称或要生成的字符,例如 ArrowLefta

  • options Frame.PressOptions (可选)

    • setDelay double (可选)#

      keydownkeyup 之间等待的时间,以毫秒为单位。默认为 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() 代替。阅读更多关于 定位器 的信息。

返回指向 frame 元素的 ElementHandle。

注意

不鼓励使用 ElementHandle,请使用 Locator 对象和 Web-first 断言代替。

该方法在 frame 中查找与指定选择器匹配的元素。如果没有元素与选择器匹配,则返回 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() 代替。阅读更多关于 定位器 的信息。

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

注意

不鼓励使用 ElementHandle,请使用 Locator 对象代替。

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

用法

Frame.querySelectorAll(selector);

参数

  • selector String#

    要查询的选择器。

返回值


selectOption

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

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

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

如果目标元素不是 <select> 元素,此方法将抛出一个错误。但是,如果元素位于具有关联 control<label> 元素内,则将使用该 control 代替。

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

一旦所有提供的选项都被选择,则触发一个 changeinput 事件。

用法

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

      是否绕过 actionability 检查。 默认为 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. 查找与 选择器 匹配的元素。如果找不到,则等待直到匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选输入框。如果不是,此方法将抛出错误。
  3. 如果元素已处于正确的选中状态,此方法将立即返回。
  4. 等待对匹配元素执行可操作性检查,除非设置了 setForce 选项。如果在检查期间元素被分离,则会重试整个操作。
  5. 如果需要,将元素滚动到视图中。
  6. 使用 Page.mouse() 在元素的中心点击。
  7. 确保元素现在处于选中或未选中状态。如果不是,此方法将抛出错误。

当所有步骤的总耗时超过指定的 setTimeout 时,此方法将抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

  • selector String#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • checked boolean#

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

  • options Frame.SetCheckedOptions (可选)

    • setForce boolean (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

    • setStrict boolean (可选)#

      当为 true 时,调用需要选择器解析为单个元素。 如果给定选择器解析为多个元素,则调用将抛出异常。

    • setTimeout double (可选)#

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

    • setTrial boolean (可选)#

      设置后,此方法仅执行 actionability 检查并跳过操作。 默认为 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#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • 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()。阅读更多关于 定位器 的信息。

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

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

当所有步骤的总耗时超过指定的 setTimeout 时,此方法将抛出 TimeoutError。传递零超时将禁用此功能。

注意

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

用法

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

参数

  • selector String#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • options Frame.TapOptions (可选)

    • setForce boolean (可选)#

      是否绕过 actionability 检查。 默认为 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#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

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

为文本中的每个字符发送 keydownkeypress/inputkeyup 事件。frame.type 可用于发送细粒度的键盘事件。要填充表单字段中的值,请使用 Frame.fill()

要按下特殊键,例如 ControlArrowDown,请使用 Keyboard.press()

用法

参数

  • selector String#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • 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()。阅读更多关于 定位器 的信息。

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

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

当所有步骤的总耗时超过指定的 setTimeout 时,此方法将抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

  • selector String#

    用于搜索元素的 selector。如果存在多个满足 selector 的元素,将使用第一个。

  • options Frame.UncheckOptions (可选)

    • setForce boolean (可选)#

      是否绕过 actionability 检查。 默认为 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#

      设置后,此方法仅执行 actionability 检查并跳过操作。 默认为 false。 用于等待元素准备好执行操作,但不执行它。

返回值


waitForNavigation

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

此方法本质上是竞态的,请改用 Frame.waitForURL()

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

用法

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

// 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
不推荐使用

请改用断言可见性的 Web 断言或基于定位器的 Locator.waitFor()。阅读更多关于 定位器 的信息。

当选择器指定的元素满足 setState 选项时返回。如果等待 hiddendetached,则返回 null

注意

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

等待 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 操作和自动等待的 Web 断言。

等待给定的 timeout 毫秒数。

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

用法

Frame.waitForTimeout(timeout);

参数

  • timeout double#

    要等待的超时时间

返回值