Frame
在任何时候,页面都会通过 Page.mainFrame() 和 Frame.childFrames() 方法公开其当前的框架树。
Frame 对象的生命周期由在页面对象上派发的三个事件控制:
- Page.onFrameAttached(handler) - 当框架附加到页面时触发。一个框架只能附加到页面一次。
- Page.onFrameNavigated(handler) - 当框架提交导航到不同的 URL 时触发。
- Page.onFrameDetached(handler) - 当框架从页面分离时触发。一个框架只能从页面分离一次。
转储框架树的示例:
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 之前添加当脚本的 onload
触发或脚本内容注入到框架中时,返回添加的标签。
使用所需的 URL 或内容向页面添加一个 <script>
标签。
用法
Frame.addScriptTag();
Frame.addScriptTag(options);
参数
options
Frame.AddScriptTagOptions
(可选)
返回值
addStyleTag
在 v1.9 之前添加当样式表的 onload
触发或 CSS 内容被注入到框架中时,返回添加的标签。
向页面添加一个带有所需 URL 的 <link rel="stylesheet">
标签,或添加一个带有内容的 <style type="text/css">
标签。
用法
Frame.addStyleTag();
Frame.addStyleTag(options);
参数
options
Frame.AddStyleTagOptions
(可选)
返回值
childFrames
在 v1.9 之前添加用法
Frame.childFrames();
返回值
content
在 v1.9 之前添加获取框架的完整 HTML 内容,包括文档类型声明。
用法
Frame.content();
返回值
dragAndDrop
添加于:v1.13用法
Frame.dragAndDrop(source, target);
Frame.dragAndDrop(source, target, options);
参数
-
用于搜索要拖动元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
用于搜索要放置到的元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.DragAndDropOptions
(可选)-
是否绕过 可操作性 检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
setSourcePosition
SourcePosition (可选) 新增于:v1.14#相对于元素内边距框左上角的此点,点击源元素。如果未指定,则使用元素的某个可见点。
-
setStrict
boolean (可选) 新增于:v1.14#为
true
时,此调用要求选择器解析为单个元素。如果给定选择器解析为多个元素,此调用将抛出异常。 -
setTargetPosition
TargetPosition (可选) 新增于:v1.14#相对于元素内边距框左上角的此点,在目标元素上放置。如果未指定,则使用元素的某个可见点。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
设置后,此方法仅执行 可操作性 检查并跳过操作。默认为
false
。这对于等待元素准备好进行操作而不实际执行操作很有用。
-
返回值
evaluate
在 v1.9 之前添加返回 expression 的返回值。
如果传递给 Frame.evaluate() 的函数返回一个 Promise,那么 Frame.evaluate() 将等待该 Promise 解决,并返回其值。
如果传递给 Frame.evaluate() 的函数返回一个不可 [序列化(Serializable)] 的值,那么 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); // 输出 "56"
也可以传入一个字符串,而不是函数。
System.out.println(frame.evaluate("1 + 2")); // 输出 "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();
参数
-
要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数,则会自动调用该函数。
-
arg
EvaluationArgument(可选)#传递给 expression 的可选参数。
返回值
evaluateHandle
在 v1.9 之前添加以 JSHandle 的形式返回 expression 的返回值。
Frame.evaluate() 和 Frame.evaluateHandle() 之间的唯一区别在于,Frame.evaluateHandle() 返回 JSHandle。
如果传递给 Frame.evaluateHandle() 的函数返回一个 Promise,则 Frame.evaluateHandle() 将等待该 Promise 解决并返回其值。
用法
// 窗口对象的句柄。
JSHandle aWindowHandle = frame.evaluateHandle("() => Promise.resolve(window)");
也可以传入字符串,而非函数。
JSHandle aHandle = frame.evaluateHandle("document"); // “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();
参数
-
要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为函数,则会自动调用该函数。
-
arg
EvaluationArgument(可选)#传递给 expression 的可选参数。
返回值
frameElement
在 v1.9 之前添加返回与此框架对应的 frame
或 iframe
元素句柄。
这是 ElementHandle.contentFrame() 的反向操作。请注意,返回的句柄实际上属于父框架。
如果在 frameElement()
返回之前框架已分离,则此方法会抛出错误。
用法
ElementHandle frameElement = frame.frameElement();
Frame contentFrame = frameElement.contentFrame();
System.out.println(frame == contentFrame); // -> true
返回值
frameLocator
添加于:v1.17在处理 iframe 时,可以创建一个框架定位器,它将进入 iframe 并允许在该 iframe 中选择元素。
用法
以下代码片段在 id 为 my-frame
的 iframe 中定位文本为 "Submit" 的元素,例如 <iframe id="my-frame">
:
Locator locator = frame.frameLocator("#my-iframe").getByText("Submit");
locator.click();
参数
返回值
getByAltText
新增于:v1.27允许通过元素的替代文本(alt text)定位元素。
用法
例如,此方法将通过替代文本“Playwright logo”找到图片:
<img alt='Playwright logo'>
page.getByAltText("Playwright logo").click();
参数
-
用于定位元素的文本。
-
options
Frame.GetByAltTextOptions
(可选)
返回值
getByLabel
新增于:v1.27允许通过关联的 <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");
参数
-
用于定位元素的文本。
-
options
Frame.GetByLabelOptions
(可选)
返回值
getByPlaceholder
新增于:v1.27允许通过占位符文本定位输入元素。
用法
例如,考虑以下 DOM 结构。
<input type="email" placeholder="name@example.com" />
你可以在通过占位符文本定位到输入框后填充内容:
page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");
参数
-
用于定位元素的文本。
-
options
Frame.GetByPlaceholderOptions
(可选)
返回值
getByRole
新增于:v1.27允许通过 ARIA 角色、ARIA 属性 和 可访问名称 来定位元素。
用法
考虑以下 DOM 结构。
<h3>注册</h3>
<label>
<input type="checkbox" /> 订阅
</label>
<br/>
<button>提交</button>
你可以通过每个元素的隐式角色来定位它们:
assertThat(page
.getByRole(AriaRole.HEADING,
new Page.GetByRoleOptions().setName("注册")))
.isVisible();
page.getByRole(AriaRole.CHECKBOX,
new Page.GetByRoleOptions().setName("订阅"))
.check();
page.getByRole(AriaRole.BUTTON,
new Page.GetByRoleOptions().setName(
Pattern.compile("提交", 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
(可选)-
通常由
aria-checked
或原生<input type=checkbox>
控件设置的属性。了解更多关于
aria-checked
的信息。 -
通常由
aria-disabled
或disabled
设置的属性。备注与大多数其他属性不同,
disabled
会通过 DOM 层次结构继承。了解更多关于aria-disabled
的信息。 -
setExact
boolean(可选) 新增于:v1.28#setName 是否完全匹配:区分大小写且匹配整个字符串。默认为
false
。当 setName 是正则表达式时,此选项将被忽略。请注意,完全匹配仍会修剪空白字符。 -
通常由
aria-expanded
设置的属性。了解更多关于
aria-expanded
的信息。 -
控制是否匹配隐藏元素的选项。默认情况下,根据 ARIA 定义,角色选择器仅匹配非隐藏元素。
了解更多关于
aria-hidden
的信息。 -
通常用于
heading
、listitem
、row
、treeitem
角色的数字属性,<h1>-<h6>
元素有默认值。了解更多关于
aria-level
的信息。 -
用于匹配 可访问名称 的选项。默认情况下,匹配不区分大小写并搜索子字符串,使用 setExact 来控制此行为。
了解更多关于 可访问名称 的信息。
-
通常由
aria-pressed
设置的属性。了解更多关于
aria-pressed
的信息。 -
通常由
aria-selected
设置的属性。了解更多关于
aria-selected
的信息。
-
返回值
详细信息
角色选择器并不能替代可访问性审计和一致性测试,而是对 ARIA 指南提供早期反馈。
许多 HTML 元素都有一个隐式的定义角色,角色选择器可以识别这些角色。你可以在此处找到所有支持的角色。ARIA 指南不建议通过将 role
和 / 或 aria-*
属性设置为默认值来重复隐式角色和属性。
getByTestId
新增于:v1.27通过测试 ID 定位元素。
用法
考虑以下 DOM 结构。
<button data-testid="directions">Itinéraire</button>
你可以通过测试 ID 定位该元素:
page.getByTestId("directions").click();
参数
返回值
详细信息
默认情况下,data-testid
属性用作测试 ID。如有必要,可使用 Selectors.setTestIdAttribute() 配置不同的测试 ID 属性。
getByText
添加于:v1.27允许定位包含给定文本的元素。
另请参阅 Locator.filter(),它允许通过其他条件(如可访问角色)进行匹配,然后按文本内容进行筛选。
用法
考虑以下 DOM 结构:
<div>Hello <span>world</span></div>
<div>Hello</div>
你可以通过文本子字符串、精确字符串或正则表达式进行定位:
// 匹配 <span>
page.getByText("world");
// 匹配第一个 <div>
page.getByText("Hello world");
// 匹配第二个 <div>
page.getByText("Hello", new Page.GetByTextOptions().setExact(true));
// 匹配两个 <div>
page.getByText(Pattern.compile("Hello"));
// 匹配第二个 <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));
参数
-
用于定位元素的文本。
-
options
Frame.GetByTextOptions
(可选)
返回值
详细信息
即使是精确匹配,按文本匹配也总会对空白字符进行规范化处理。例如,它会将多个空格合并为一个,将换行符转换为空格,并忽略前导和尾随的空白字符。
类型为 button
和 submit
的输入元素是通过其 value
而不是文本内容进行匹配的。例如,通过文本 "登录"
定位会匹配 <input type=button value="登录">
。
getByTitle
添加于:v1.27允许通过元素的 title
属性定位元素。
用法
考虑以下 DOM 结构。
<span title='问题数量'>25 个问题</span>
通过标题文本定位后,你可以检查问题数量:
assertThat(page.getByTitle("问题数量")).hasText("25 个问题");
参数
返回值
isDetached
在 v1.9 之前添加如果框架已分离,则返回 true
,否则返回 false
。
使用方法
Frame.isDetached();
返回值
isEnabled
在 v1.9 之前添加返回元素是否启用。
使用方法
Frame.isEnabled(selector);
Frame.isEnabled(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.IsEnabledOptions
(可选)-
setStrict
boolean(可选)在 v1.14 中添加#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
locator
新增于:v1.14此方法返回一个元素定位器(element locator),可用于在此页面/框架上执行操作。定位器会在执行操作前立即解析为元素,因此对同一定位器执行的一系列操作实际上可能在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构发生了变化,就会出现这种情况。
用法
Frame.locator(selector);
Frame.locator(selector, options);
参数
-
解析 DOM 元素时使用的选择器。
-
options
Frame.LocatorOptions
(可选)-
将方法的结果范围缩小到包含与该相对定位器匹配的元素的结果。例如,有
text=Playwright
的article
与<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(可选) 新增于:v1.33#匹配在内部(可能在子元素或后代元素中)不包含指定文本的元素。当传入 [字符串] 时,匹配不区分大小写,并搜索子字符串。
-
setHasText
String | Pattern(可选)#匹配在内部(可能在子元素或后代元素中)包含指定文本的元素。当传入 [字符串] 时,匹配不区分大小写,并搜索子字符串。例如,
"Playwright"
与<article><div>Playwright</div></article>
匹配。
-
返回值
name
在 v1.9 之前添加返回 <frame>
或 <iframe>
标签中指定的框架 name
属性。
如果 name
为空,则返回 id
属性。
此值在框架创建时计算一次,如果属性随后更改,该值不会更新。
用法
Frame.name();
返回值
navigate
在 v1.9 之前添加返回主资源响应。如果存在多个重定向,导航将使用最后一个重定向的响应来解析。
在以下情况下,该方法将抛出错误:
- 存在 SSL 错误(例如自签名证书的情况)。
- 目标 URL 无效。
- 导航期间超过了 setTimeout。
- 远程服务器无响应或无法访问。
- 主资源加载失败。
当远程服务器返回任何有效的 HTTP 状态码时,包括 404 “未找到” 和 500 “内部服务器错误”,该方法不会抛出错误。此类响应的状态码可以通过调用 Response.status() 来获取。
该方法要么抛出错误,要么返回主资源响应。唯一的例外是导航到 about:blank
或导航到具有不同哈希值的相同 URL,这两种情况将成功并返回 null
。
无头模式不支持导航到 PDF 文档。请参阅 上游问题。
用法
Frame.navigate(url);
Frame.navigate(url, options);
参数
-
要导航到的框架的 URL。该 URL 应包含协议,例如
https://
。 -
options
Frame.NavigateOptions
(可选)-
引用页(Referer)标头值。如果提供了该值,它将优先于通过 Page.setExtraHTTPHeaders() 设置的引用页标头值。
-
最大操作时间(毫秒),默认为 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();
返回值
parentFrame
在 v1.9 之前添加父框架(如果有)。分离的框架和主框架返回 null
。
用法
Frame.parentFrame();
返回值
setContent
在 v1.9 之前添加此方法在内部调用 document.write(),继承其所有特定特征和行为。
用法
Frame.setContent(html);
Frame.setContent(html, options);
参数
-
要分配给页面的 HTML 标记。
-
options
Frame.SetContentOptions
(可选)-
最大操作时间(毫秒),默认为 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();
返回值
url
在 v1.9 之前添加返回框架的 URL。
用法
Frame.url();
返回值
waitForFunction
在 v1.9 之前添加当 表达式 返回真值时返回,并返回该值。
用法
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);
参数
-
要在浏览器上下文中求值的 JavaScript 表达式。如果该表达式求值为一个函数,则会自动调用该函数。
-
arg
EvaluationArgument(可选)#传递给 expression 的可选参数。
-
options
Frame.WaitForFunctionOptions
(可选)-
setPollingInterval
double(可选)#如果指定,则将其视为函数执行的时间间隔(以毫秒为单位)。默认情况下,如果未指定该选项,expression 将在
requestAnimationFrame
回调中执行。 -
最大等待时间(以毫秒为单位)。默认为
30000
(30 秒)。传递0
以禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
-
返回值
waitForLoadState
在 v1.9 之前添加等待达到所需的加载状态。
当框架达到所需的加载状态(默认为 load
)时,此方法返回。调用此方法时,导航必须已经提交。如果当前文档已经达到所需状态,则立即解析。
大多数情况下,不需要此方法,因为 Playwright 在每次操作前自动等待。
用法
frame.click("button"); // 点击触发导航。
frame.waitForLoadState(); // 默认为等待 "load" 状态。
参数
-
state
enum LoadState { LOAD, DOMCONTENTLOADED, NETWORKIDLE }
(可选)#等待的可选加载状态,默认为
load
。如果在加载当前文档时已经达到该状态,此方法将立即解析。可以是以下值之一:'load'
- 等待触发load
事件。'domcontentloaded'
- 等待触发DOMContentLoaded
事件。'networkidle'
- 不推荐 等待至少500
毫秒内没有网络连接。不要在测试中使用此方法,应依靠 Web 断言来评估准备情况。
-
options
Frame.WaitForLoadStateOptions
(可选)-
最大操作时间(毫秒),默认为 30 秒,传入
0
可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
waitForURL
新增于:v1.11等待框架导航到给定的 URL。
用法
frame.click("a.delayed-navigation"); // 点击链接将间接导致导航
frame.waitForURL("**/target.html");
参数
-
url
String | Pattern | Predicate<String>#等待导航时要匹配的全局模式、正则表达式模式或接收 [URL] 的断言。请注意,如果参数是一个没有通配符的字符串,该方法将等待导航到与该字符串完全相等的 URL。
-
options
Frame.WaitForURLOptions
(可选)-
最大操作时间(毫秒),默认为 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 之前添加请改用基于定位器的 Locator.check()。了解更多关于 定位器 的信息。
此方法通过执行以下步骤,选中与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有匹配元素,则等待直到有匹配元素附加到 DOM 中。
- 确保匹配的元素是复选框或单选输入框。如果不是,则此方法抛出异常。如果该元素已经被选中,则此方法立即返回。
- 等待对匹配元素的 可操作性 检查,除非设置了 setForce 选项。如果在检查过程中元素被分离,则整个操作将重试。
- 如有需要,将元素滚动到可见区域。
- 使用 Page.mouse() 在元素中心点击。
- 确保该元素现在已被选中。如果没有,则此方法抛出异常。
如果在指定的 setTimeout 时间内,所有步骤组合未完成,此方法将抛出 TimeoutError。传入零超时将禁用此功能。
用法
Frame.check(selector);
Frame.check(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.CheckOptions
(可选)-
是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
setPosition
Position(可选) 新增于:v1.11#相对于元素内边距框左上角使用的一个点。如果未指定,则使用元素的某个可见点。
-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
setTrial
boolean(可选) 新增于:v1.11#设置此参数时,此方法仅执行可操作性检查并跳过操作。默认为
false
。这在等待元素准备好进行操作但不执行操作时很有用。
-
返回值
click
在 v1.9 之前添加请改用基于定位器的 Locator.click()。详细了解 定位器。
此方法通过执行以下步骤,点击与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有匹配元素,则等待直到有匹配元素附加到 DOM 中。
- 对匹配的元素进行 可操作性 检查,除非设置了 setForce 选项。如果在检查过程中元素被分离,则整个操作将重试。
- 如有需要,将元素滚动到可见区域。
- 使用 Page.mouse() 在元素中心或指定的 setPosition 处点击。
- 等待发起的导航成功或失败,除非设置了 setNoWaitAfter 选项。
如果在指定的 setTimeout 时间内,所有步骤组合未完成,此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。
用法
Frame.click(selector);
Frame.click(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.ClickOptions
(可选)-
setButton
enum MouseButton { LEFT, RIGHT, MIDDLE }
(可选)#默认值为
left
。 -
默认值为 1。参见 UIEvent.detail。
-
mousedown
和mouseup
之间等待的时间,单位为毫秒。默认值为 0。 -
是否绕过 可操作性 检查。默认值为
false
。 -
setModifiers
List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }
> (可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前的修饰键状态。如果未指定,则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”,在 macOS 上解析为 “Meta”。
-
已弃用
此选项在未来将默认设置为
true
。启动导航的操作会等待这些导航发生以及页面开始加载。你可以通过设置此标志选择不等待。只有在特殊情况下,例如导航到无法访问的页面时,才需要此选项。默认值为
false
。 -
setPosition
Position (可选)#相对于元素内边距框左上角使用的点。如果未指定,则使用元素的某个可见点。
-
setStrict
boolean (可选) 新增于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间,单位为毫秒。默认值为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
setTrial
boolean (可选) 新增于:v1.11#设置此参数时,此方法仅执行 可操作性 检查并跳过操作。默认值为
false
。这对于等待元素准备好执行操作但不实际执行操作很有用。请注意,无论trial
设置如何,都会按下键盘modifiers
,以便测试仅在按下这些键时才可见的元素。
-
返回值
dblclick
在 v1.9 之前添加请改用基于定位器的 Locator.dblclick()。了解更多关于 定位器 的信息。
此方法通过执行以下步骤双击与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有,则等待直到有匹配的元素附加到 DOM 中。
- 等待对匹配元素进行 可操作性 检查,除非设置了 setForce 选项。如果在检查过程中元素被分离,则整个操作将重试。
- 如有需要,将元素滚动到可见区域。
- 使用 Page.mouse() 在元素中心或指定的 setPosition 处双击。如果
dblclick()
的第一次点击触发了导航事件,此方法将抛出异常。
如果在指定的 setTimeout 时间内所有步骤未完成,此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。
frame.dblclick()
会派发两个 click
事件和一个 dblclick
事件。
用法
Frame.dblclick(selector);
Frame.dblclick(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.DblclickOptions
(可选)-
setButton
enum MouseButton { LEFT, RIGHT, MIDDLE }
(可选)#默认值为
left
。 -
mousedown
和mouseup
之间等待的时间(毫秒)。默认值为 0。 -
是否绕过 可操作性 检查。默认值为
false
。 -
setModifiers
List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }
>(可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前的修饰键状态。如果未指定,则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”,在 macOS 上解析为 “Meta”。
-
已弃用
此选项无效。
此选项无效。
-
setPosition
Position(可选)#相对于元素内边距框左上角使用的点。如果未指定,则使用元素的某个可见点。
-
setStrict
boolean(可选) 添加于:v1.14#为
true
时,此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,调用将抛出异常。 -
最大时间(毫秒)。默认值为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
setTrial
boolean(可选) 添加于:v1.11#设置后,此方法仅执行 可操作性 检查并跳过操作。默认值为
false
。这对于等待元素准备好执行操作但不实际执行操作很有用。请注意,无论trial
设置如何,都会按下键盘modifiers
,以便测试仅在按下这些键时才可见的元素。
-
返回值
dispatchEvent
在 v1.9 之前添加请改用基于定位器的 Locator.dispatchEvent()。了解更多关于 定位器 的信息。
以下代码片段在元素上派发 click
事件。无论元素的可见性状态如何,都会派发 click
事件。这等效于调用 element.click()。
用法
frame.dispatchEvent("button#submit", "click");
在底层,它会根据给定的 type 创建一个事件实例,使用 eventInit 属性对其进行初始化,并在元素上派发该事件。事件默认是 composed
、cancelable
且会冒泡的。
由于 eventInit 是特定于事件的,请参考以下事件文档以获取初始属性列表:
- DeviceMotionEvent
- DeviceOrientationEvent
- DragEvent
- Event
- FocusEvent
- KeyboardEvent
- MouseEvent
- PointerEvent
- TouchEvent
- WheelEvent
如果你希望将实时对象传入事件,也可以将 JSHandle
指定为属性值:
// 注意,你只能在 Chromium 和 Firefox 中创建 DataTransfer
JSHandle dataTransfer = frame.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
frame.dispatchEvent("#source", "dragstart", arg);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
DOM 事件类型:
"click"
、"dragstart"
等。 -
eventInit
EvaluationArgument(可选)#可选的特定于事件的初始化属性。
-
options
Frame.DispatchEventOptions
(可选)-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
evalOnSelector
新增于:v1.9此方法不会等待元素通过可操作性检查,因此可能会导致测试不稳定。请改用 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");
参数
-
要查询的选择器。
-
要在浏览器上下文中计算的 JavaScript 表达式。如果该表达式计算结果为一个函数,则会自动调用该函数。
-
arg
EvaluationArgument(可选)#传递给 expression 的可选参数。
-
options
Frame.EvalOnSelectorOptions
(可选)
返回值
evalOnSelectorAll
新增于:v1.9在大多数情况下,Locator.evaluateAll()、其他 Locator 辅助方法以及以网页为优先的断言能更好地完成任务。
返回 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 之前添加请改用基于定位器的 Locator.fill()。了解更多关于 定位器 的信息。
此方法会等待与 selector 匹配的元素,等待 可操作性 检查,聚焦该元素,填充内容,并在填充后触发 input
事件。请注意,你可以传入空字符串来清空输入字段。
如果目标元素不是 <input>
、<textarea>
或 [contenteditable]
元素,此方法将抛出错误。但是,如果该元素位于具有关联 控件 的 <label>
元素内,则会填充该控件。
要发送细粒度的键盘事件,请使用 Locator.pressSequentially()。
用法
Frame.fill(selector, value);
Frame.fill(selector, value, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
要为
<input>
、<textarea>
或[contenteditable]
元素填充的值。 -
options
Frame.FillOptions
(可选)-
setForce
boolean(可选) 新增于:v1.13#是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
focus
在 v1.9 之前添加请改用基于定位器的 Locator.focus()。了解更多关于 定位器 的信息。
此方法使用 selector 获取一个元素并将焦点设置到该元素上。如果没有与 selector 匹配的元素,该方法将等待,直到 DOM 中出现匹配的元素。
用法
Frame.focus(selector);
Frame.focus(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.FocusOptions
(可选)-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
getAttribute
在 v1.9 之前新增请改用基于定位器的 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 之前添加请改用基于定位器的 Locator.hover()。了解更多关于 定位器 的信息。
此方法通过执行以下步骤,将鼠标悬停在与 selector 匹配的元素上:
- 查找与 selector 匹配的元素。如果没有匹配元素,则等待直到有匹配元素附加到 DOM 中。
- 除非设置了 setForce 选项,否则等待对匹配元素的 可操作性 检查。如果在检查过程中元素被分离,则会重试整个操作。
- 如有需要,将元素滚动到可见区域。
- 使用 Page.mouse() 将鼠标悬停在元素中心,或指定的 setPosition 位置。
如果在指定的 setTimeout 时间内,所有步骤组合未完成,此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。
用法
Frame.hover(selector);
Frame.hover(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.HoverOptions
(可选)-
是否绕过可操作性检查。默认为
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
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
setTrial
boolean(可选) 新增于:v1.11#设置后,此方法仅执行可操作性检查并跳过操作。默认为
false
。这对于等待元素准备好进行操作而不实际执行操作很有用。请注意,无论trial
如何,都会按下键盘modifiers
,以便测试仅在按下这些键时才可见的元素。
-
返回值
innerHTML
在 v1.9 之前添加请改用基于定位器的 Locator.innerHTML()。了解更多关于 定位器 的信息。
返回 element.innerHTML
。
用法
Frame.innerHTML(selector);
Frame.innerHTML(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.InnerHTMLOptions
(可选)-
setStrict
boolean(可选)添加于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
innerText
在 v1.9 之前添加请改用基于定位器的 Locator.innerText()。了解更多关于 定位器 的信息。
返回 element.innerText
。
用法
Frame.innerText(selector);
Frame.innerText(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.InnerTextOptions
(可选)-
setStrict
boolean(可选)在 v1.14 中添加#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
inputValue
新增于:v1.13请改用基于定位器的 Locator.inputValue()。了解更多关于 定位器 的信息。
返回选定的 <input>
、<textarea>
或 <select>
元素的 input.value
。
对于非输入元素会抛出异常。但是,如果该元素位于具有关联 control 的 <label>
元素内,则返回该控件的值。
用法
Frame.inputValue(selector);
Frame.inputValue(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.InputValueOptions
(可选)-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,调用要求选择器解析为单个元素。如果给定选择器解析出多个元素,调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
isChecked
在 v1.9 之前新增请改用基于定位器的 Locator.isChecked()。了解更多关于 定位器 的信息。
返回元素是否被选中。如果元素不是复选框或单选输入框,则抛出异常。
使用方法
Frame.isChecked(selector);
Frame.isChecked(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.IsCheckedOptions
(可选)-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
isDisabled
在 v1.9 之前添加请改用基于定位器的 Locator.isDisabled()。了解更多关于 定位器 的信息。
返回元素是否已禁用,与 enabled 相反。
用法
Frame.isDisabled(selector);
Frame.isDisabled(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.IsDisabledOptions
(可选)-
setStrict
boolean (可选) 在 v1.14 中添加#为
true
时,该调用要求选择器解析为单个元素。如果给定选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
isEditable
在 v1.9 之前添加请改用基于定位器的 Locator.isEditable()。了解更多关于 定位器 的信息。
返回元素是否可编辑。
用法
Frame.isEditable(selector);
Frame.isEditable(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.IsEditableOptions
(可选)-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,此调用要求选择器解析为单个元素。如果给定选择器解析出多个元素,调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
isHidden
在 v1.9 之前添加请改用基于定位器的 Locator.isHidden()。了解更多关于 定位器 的信息。
返回元素是否隐藏,与 可见性 相反。selector 若未匹配到任何元素,则视为隐藏。
用法
Frame.isHidden(selector);
Frame.isHidden(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.IsHiddenOptions
(可选)-
setStrict
boolean (可选) 在 v1.14 中添加#为
true
时,此调用要求选择器仅解析到单个元素。如果给定选择器解析到多个元素,调用将抛出异常。 -
已弃用
此选项将被忽略。Frame.isHidden() 不会等待元素变为隐藏状态,而是立即返回。
-
返回值
isVisible
在 v1.9 之前添加请改用基于定位器的 Locator.isVisible()。了解更多关于 定位器 的信息。
返回元素是否可见。selector 若未匹配到任何元素,则视为不可见。
用法
Frame.isVisible(selector);
Frame.isVisible(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.IsVisibleOptions
(可选)-
setStrict
boolean (可选) 在 v1.14 中添加#为
true
时,此调用要求选择器仅解析为单个元素。如果给定选择器解析为多个元素,此调用将抛出异常。 -
已弃用
此选项将被忽略。Frame.isVisible() 不会等待元素变为可见,而是立即返回。
-
返回值
press
在 v1.9 之前添加请改用基于定位器的 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.locator()。了解更多关于 定位器 的信息。
返回指向框架元素的 ElementHandle
。
不推荐使用 ElementHandle,请改用 Locator 对象和以网页为优先的断言。
该方法在框架内查找与指定选择器匹配的元素。如果没有元素与选择器匹配,则返回 null
。
用法
Frame.querySelector(selector);
Frame.querySelector(selector, options);
参数
-
要查询的选择器。
-
options
Frame.QuerySelectorOptions
(可选)
返回值
querySelectorAll
添加于:v1.9请改用基于定位器的 Frame.locator()。了解更多关于 定位器 的信息。
返回指向框架元素的 ElementHandle
。
不推荐使用 ElementHandle,请改用 Locator 对象。
该方法会查找框架内所有与指定选择器匹配的元素。如果没有元素与选择器匹配,则返回空数组。
用法
Frame.querySelectorAll(selector);
参数
返回值
selectOption
在 v1.9 之前添加请改用基于定位器的 Locator.selectOption()。了解更多关于 定位器 的信息。
此方法会等待与 selector 匹配的元素,等待 可操作性检查,等待所有指定的选项出现在 <select>
元素中,然后选择这些选项。
如果目标元素不是 <select>
元素,此方法将抛出错误。但是,如果该元素位于具有关联 control 的 <label>
元素内,则将改用该控件。
返回已成功选中的选项值数组。
在所有提供的选项都被选中后,会触发 change
和 input
事件。
用法
// 匹配值或标签的单选
frame.selectOption("select#colors", "blue");
// 匹配值和标签两者的单选
frame.selectOption("select#colors", new SelectOption().setLabel("Blue"));
// 多选
frame.selectOption("select#colors", new String[] {"red", "green", "blue"});
参数
-
要查询的选择器。
-
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
。 -
已弃用
此选项无效。
此选项无效。
-
setStrict
boolean (可选) 新增于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
setChecked
添加于:v1.15请改用基于定位器的 Locator.setChecked()。了解更多关于 定位器 的信息。
此方法通过执行以下步骤,选中或取消选中与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有匹配元素,则等待直到有匹配元素附加到 DOM 中。
- 确保匹配的元素是复选框或单选输入框。如果不是,此方法将抛出异常。
- 如果该元素已经处于正确的选中状态,此方法将立即返回。
- 等待对匹配元素进行 可操作性 检查,除非设置了 setForce 选项。如果在检查过程中元素被分离,整个操作将重试。
- 如有需要,将元素滚动到可见区域。
- 使用 Page.mouse() 在元素中心点击。
- 确保该元素现在已被选中或取消选中。如果没有,此方法将抛出异常。
如果在指定的 setTimeout 时间内,所有步骤组合仍未完成,此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。
用法
Frame.setChecked(selector, checked);
Frame.setChecked(selector, checked, options);
参数
-
selector
[字符串]#用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
checked
[布尔值]#是否选中或取消选中复选框。
-
options
Frame.SetCheckedOptions
(可选)-
setForce
[布尔值](可选)#是否绕过可操作性检查。默认为
false
。 -
setNoWaitAfter
[布尔值](可选)#已弃用此选项无效。
此选项无效。
-
setPosition
Position(可选)#-
setX
[双精度浮点数] -
setY
[双精度浮点数]
相对于元素内边距框左上角使用的一个点。如果未指定,则使用元素的某个可见点。
-
-
setStrict
[布尔值](可选)#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
setTimeout
[双精度浮点数](可选)#最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
setTrial
[布尔值](可选)#设置后,此方法仅执行可操作性检查并跳过操作。默认为
false
。这在等待元素准备好进行操作但不执行操作时很有用。
-
返回值
setInputFiles
在 v1.9 之前添加请改用基于定位器的 Locator.setInputFiles()。了解更多关于 定位器 的信息。
将文件输入的值设置为这些文件路径或文件。如果某些 filePaths
是相对路径,则它们将相对于当前工作目录进行解析。对于空数组,将清除选定的文件。
此方法要求 selector 指向一个 input 元素。但是,如果该元素位于具有关联 control 的 <label>
元素内,则会改为定位该控件。
用法
Frame.setInputFiles(selector, files);
Frame.setInputFiles(selector, files, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.SetInputFilesOptions
(可选)-
已弃用
此选项无效。
此选项无效。
-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,此调用要求选择器解析为单个元素。如果给定的选择器解析出多个元素,调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
tap
在 v1.9 之前添加请改用基于定位器的 Locator.tap()。了解更多关于 定位器 的信息。
此方法通过执行以下步骤点击与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有,则等待匹配的元素附加到 DOM 中。
- 等待对匹配元素进行 可操作性 检查,除非设置了 setForce 选项。如果在检查过程中元素被分离,则整个操作将重试。
- 如有需要,将元素滚动到可见区域。
- 使用 Page.touchscreen() 点击元素的中心,或指定的 setPosition。
如果在指定的 setTimeout 时间内所有步骤未完成,此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。
frame.tap()
要求浏览器上下文的 hasTouch
选项设置为 true
。
用法
Frame.tap(selector);
Frame.tap(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.TapOptions
(可选)-
是否绕过可操作性检查。默认为
false
。 -
setModifiers
List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }
> (可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前的修饰键状态。如果未指定,则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”,在 macOS 上解析为 “Meta”。
-
已弃用
此选项无效。
此选项无效。
-
setPosition
Position (可选)#相对于元素内边距框左上角使用的点。如果未指定,则使用元素的某个可见点。
-
setStrict
boolean (可选) 新增于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
setTrial
boolean (可选) 新增于:v1.11#设置后,此方法仅执行可操作性检查并跳过操作。默认为
false
。这对于等待元素准备好进行操作而不实际执行操作很有用。请注意,无论trial
设置如何,都会按下键盘modifiers
,以便测试仅在按下这些键时才可见的元素。
-
返回值
textContent
在 v1.9 之前添加请改用基于定位器的 Locator.textContent()。了解更多关于 定位器 的信息。
返回 element.textContent
。
用法
Frame.textContent(selector);
Frame.textContent(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.TextContentOptions
(可选)-
setStrict
boolean(可选)在 v1.14 中添加#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
-
返回值
type
在 v1.9 之前添加在大多数情况下,你应该使用 Locator.fill() 代替。只有在页面上有特殊键盘处理时,你才需要逐个按键,在这种情况下,使用 Locator.pressSequentially()。
为文本中的每个字符发送 keydown
、keypress
/input
和 keyup
事件。frame.type
可用于发送细粒度的键盘事件。要在表单字段中填充值,请使用 Frame.fill()。
要按下特殊键,如 Control
或 ArrowDown
,请使用 Keyboard.press()。
用法
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
要输入到聚焦元素中的文本。
-
options
Frame.TypeOptions
(可选)-
按键之间等待的时间(毫秒)。默认为 0。
-
已弃用
此选项无效。
此选项无效。
-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素,该调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
-
返回值
uncheck
在 v1.9 之前添加请改用基于定位器的 Locator.uncheck()。了解更多关于 定位器 的信息。
此方法通过执行以下步骤,取消选中与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有匹配元素,则等待直到有匹配元素附加到 DOM 中。
- 确保匹配的元素是复选框或单选输入框。如果不是,则此方法抛出异常。如果该元素已经处于未选中状态,则此方法立即返回。
- 等待对匹配元素的可操作性检查,除非设置了 setForce 选项。如果在检查过程中元素被分离,则整个操作将重试。
- 如有需要,将元素滚动到可见区域。
- 使用 Page.mouse() 在元素中心点击。
- 确保该元素现在处于未选中状态。如果不是,则此方法抛出异常。
如果在指定的 setTimeout 时间内,所有步骤组合仍未完成,则此方法抛出 TimeoutError。传入零超时时间将禁用此功能。
用法
Frame.uncheck(selector);
Frame.uncheck(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足该选择器,将使用第一个元素。
-
options
Frame.UncheckOptions
(可选)-
是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
setPosition
Position(可选) 新增于:v1.11#相对于元素内边距框左上角使用的一个点。如果未指定,则使用元素的某个可见点。
-
setStrict
boolean(可选) 新增于:v1.14#为
true
时,调用要求选择器解析为单个元素。如果给定选择器解析为多个元素,调用将抛出异常。 -
最大时间(毫秒)。默认为
30000
(30 秒)。传入0
可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
setTrial
boolean(可选) 新增于:v1.11#设置后,此方法仅执行可操作性检查并跳过操作。默认为
false
。这对于等待元素准备好进行操作但不执行操作很有用。
-
返回值
waitForNavigation
在 v1.9 之前添加此方法本质上存在竞争问题,请改用 Frame.waitForURL()。
等待框架导航,并返回主资源响应。如果发生多次重定向,导航将使用最后一次重定向的响应来解析。如果导航到不同的锚点或由于使用 History API 而进行导航,导航将使用 null
来解析。
用法
此方法等待框架导航到新的 URL。当你运行的代码将间接导致框架导航时,此方法很有用。考虑以下示例:
// 导航完成后,该方法返回
frame.waitForNavigation(() -> {
// 点击链接将间接导致导航
frame.click("a.delayed-navigation");
});
使用 History API 更改 URL 被视为导航。
参数
-
options
Frame.WaitForNavigationOptions
(可选)-
最大操作时间(毫秒),默认为 30 秒,传入
0
可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。 -
setUrl
String | Pattern | Predicate<String>(可选)#等待导航时要匹配的通配符模式、正则表达式模式或接收 [URL] 的断言。请注意,如果参数是一个没有通配符的字符串,该方法将等待导航到与该字符串完全相等的 URL。
-
setWaitUntil
enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT }
(可选)#何时认为操作成功,默认为
load
。事件可以是:'domcontentloaded'
- 当DOMContentLoaded
事件触发时,认为操作完成。'load'
- 当load
事件触发时,认为操作完成。'networkidle'
- 不推荐 当至少500
毫秒内没有网络连接时,认为操作完成。不要在测试中使用此方法,应依靠 Web 断言来评估准备情况。'commit'
- 当接收到网络响应且文档开始加载时,认为操作完成。
-
-
执行触发事件操作的回调。
返回值
waitForSelector
在 v1.9 之前添加请改用断言可见性的 Web 断言,或基于定位器的 Locator.waitFor()。了解更多关于 定位器 的信息。
当选择器指定的元素满足 setState 选项时返回。如果等待 hidden
或 detached
,则返回 null
。
Playwright 会在执行操作前自动等待元素准备就绪。使用 Locator 对象和以 Web 优先的断言可使代码无需使用 wait-for-selector
。
等待 选择器 满足 setState 选项(从 DOM 中出现/消失,或变为可见/隐藏)。如果在调用该方法时 选择器 已经满足条件,该方法将立即返回。如果选择器在 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 之前添加在生产环境中切勿等待超时。依赖时间等待的测试本质上是不可靠的。请使用 Locator 操作和自动等待的 Web 断言。
等待指定的 timeout(以毫秒为单位)。
请注意,frame.waitForTimeout()
仅应用于调试。在生产环境中使用定时器的测试将不可靠。请改用网络事件、选择器变为可见等信号。
用法
Frame.waitForTimeout(timeout);
参数
返回值