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 触发或脚本内容注入到框架中时,返回添加的标签。
向页面中添加一个 <script>
标签,并使用所需的 url 或内容。
用法
Frame.addScriptTag();
Frame.addScriptTag(options);
参数
options
Frame.AddScriptTagOptions
(可选)
返回值
addStyleTag
在 v1.9 之前添加当样式表的 onload 触发或 CSS 内容注入到框架中时,返回添加的标签。
向页面中添加一个 <link rel="stylesheet">
标签,并使用所需的 url 或一个带有内容的 <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() 的函数返回一个非 可序列化 值,则 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();
参数
-
在浏览器上下文中要评估的 JavaScript 表达式。如果表达式计算结果为函数,则该函数会自动调用。
-
arg
EvaluationArgument (可选)#传递给 expression 的可选参数。
返回值
evaluateHandle
在 v1.9 之前添加将 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();
参数
-
在浏览器上下文中要评估的 JavaScript 表达式。如果表达式计算结果为函数,则该函数会自动调用。
-
arg
EvaluationArgument (可选)#传递给 expression 的可选参数。
返回值
frameElement
在 v1.9 之前添加返回与该 frame 对应的 frame
或 iframe
元素句柄。
这是 ElementHandle.contentFrame() 的逆操作。请注意,返回的句柄实际上属于父 frame。
如果 frame 在 frameElement()
返回之前已分离,则此方法会抛出错误。
用法
ElementHandle frameElement = frame.frameElement();
Frame contentFrame = frameElement.contentFrame();
System.out.println(frame == contentFrame); // -> true
返回值
frameLocator
新增于:v1.17在处理 iframe 时,您可以创建一个 frame 定位器,它将进入 iframe 并允许在该 iframe 中选择元素。
用法
以下代码片段在 id 为 my-frame
的 iframe 中定位文本为“提交”的元素,例如 <iframe id="my-frame">
Locator locator = frame.frameLocator("#my-iframe").getByText("Submit");
locator.click();
参数
返回值
getByAltText
新增于:v1.27允许根据元素的 alt 文本进行定位。
用法
例如,此方法将根据 alt 文本“Playwright logo”查找图像。
<img alt='Playwright logo'>
page.getByAltText("Playwright logo").click();
参数
-
要定位的元素的文本。
-
options
Frame.GetByAltTextOptions
(可选)
返回值
getByLabel
新增于:v1.27允许根据关联的 <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");
参数
-
要定位的元素的文本。
-
options
Frame.GetByLabelOptions
(可选)
返回值
getByPlaceholder
新增于:v1.27允许根据占位符文本定位输入元素。
用法
例如,考虑以下 DOM 结构。
<input type="email" placeholder="[email protected]" />
您可以根据占位符文本定位输入元素后填充它。
page.getByPlaceholder("[email protected]").fill("[email protected]");
参数
-
要定位的元素的文本。
-
options
Frame.GetByPlaceholderOptions
(可选)
返回值
getByRole
新增于:v1.27允许根据元素的 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
(可选)-
通常由
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
。 -
setIncludeHidden
boolean (可选)#控制是否匹配隐藏元素的选项。默认情况下,只有非隐藏元素(如 ARIA 定义)才会通过角色选择器匹配。
了解更多关于
aria-hidden
。 -
一个通常用于
heading
、listitem
、row
、treeitem
角色的数字属性,并且为<h1>-<h6>
元素提供默认值。了解更多关于
aria-level
。 -
setName
String | Pattern (可选)#匹配可访问名称的选项。默认情况下,匹配不区分大小写并搜索子字符串,使用 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>
您可以通过文本子字符串、精确字符串或正则表达式进行定位
// 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))
参数
-
要定位的元素的文本。
-
options
Frame.GetByTextOptions
(可选)
返回值
详情
根据文本匹配始终规范化空格,即使进行精确匹配也是如此。例如,它将多个空格转换为一个空格,将换行符转换为空格,并忽略开头和结尾的空格。
类型为 button
和 submit
的输入元素通过其 value
而不是文本内容进行匹配。例如,通过文本 "Log in"
定位匹配 <input type=button value="Log in">
。
getByTitle
新增于:v1.27允许根据元素的 title 属性进行定位。
用法
考虑以下 DOM 结构。
<span title='Issues count'>25 issues</span>
您可以在通过标题文本定位后检查问题计数
assertThat(page.getByTitle("Issues count")).hasText("25 issues");
参数
-
要定位的元素的文本。
-
options
Frame.GetByTitleOptions
(可选)
返回值
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该方法返回一个元素定位器,可用于对该页面/框架执行操作。在执行操作之前,定位器会立即解析为元素,因此对同一定位器的一系列操作实际上可能在不同的 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 之前添加返回框架在标签中指定的 name 属性。
如果名称为空,则返回 id 属性。
此值在创建框架时计算一次,如果以后更改属性,则不会更新。
用法
Frame.name();
返回值
导航
在 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()设置的 Referer 标头值。
-
以毫秒为单位的最大操作时间,默认为 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'
- 当收到网络响应并开始加载文档时,认为操作已完成。
-
返回值
页面
在 v1.9 之前添加返回包含此框架的页面。
用法
Frame.page();
返回值
父框架
在 v1.9 之前添加父框架(如果有)。分离的框架和主框架返回null
。
用法
Frame.parentFrame();
返回值
设置内容
在 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'
- 当收到网络响应并开始加载文档时,认为操作已完成。
-
返回值
标题
在 v1.9 之前添加返回页面标题。
用法
Frame.title();
返回值
网址
在 v1.9 之前添加返回框架的 url。
用法
Frame.url();
返回值
等待函数
在 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 (可选)#可选参数,传递给表达式。
-
options
Frame.WaitForFunctionOptions
(可选)-
setPollingInterval
double (可选)#如果指定,则将其视为以毫秒为单位的间隔,在此间隔内将执行该函数。默认情况下,如果未指定该选项,则在
requestAnimationFrame
回调中执行表达式。 -
等待的最大时间(以毫秒为单位)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用BrowserContext.setDefaultTimeout()或Page.setDefaultTimeout()方法更改默认值。
-
返回值
等待加载状态
在 v1.9 之前添加等待达到所需的加载状态。
当框架达到所需的加载状态(默认为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
(可选)-
以毫秒为单位的最大操作时间,默认为 30 秒,传递
0
以禁用超时。可以使用BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout()或Page.setDefaultTimeout()方法更改默认值。
-
返回值
等待 URL
新增于:v1.11等待框架导航到给定的 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
(可选)-
以毫秒为单位的最大操作时间,默认为 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
指定为属性值。
// 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);
参数
-
用于搜索元素的选择器。如果有多个元素满足选择器,则将使用第一个元素。
-
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 辅助方法和 Web 首要断言可以更好地完成这项工作。
返回 expression 的返回值。
此方法查找框架内与指定选择器匹配的所有元素,并将匹配元素的数组作为第一个参数传递给 expression。
如果 expression 返回一个 Promise,则 Frame.evalOnSelectorAll() 会等待 Promise 解析并返回其值。
用法
boolean divsCounts = (boolean) page.evalOnSelectorAll("div", "(divs, min) => divs.length >= min", 10);
参数
-
要查询的选择器。
-
在浏览器上下文中要评估的 JavaScript 表达式。如果表达式计算结果为函数,则该函数会自动调用。
-
arg
EvaluationArgument (可选)#要传递给 expression 的可选参数。
返回值
fill
在 v1.9 之前添加请改用基于定位器的 Locator.fill()。了解更多关于 定位器 的信息。
此方法会等待与 selector 匹配的元素,等待 可操作性 检查,聚焦元素,填充它并在填充后触发 input
事件。请注意,可以传递空字符串以清除输入字段。
如果目标元素不是 <input>
、<textarea>
或 [contenteditable]
元素,则此方法会抛出错误。但是,如果元素位于具有关联 control 的 <label>
元素内,则会改为填充该 control。
要发送细粒度的键盘事件,请使用 Locator.pressSequentially()。
用法
Frame.fill(selector, value);
Frame.fill(selector, value, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足选择器,则将使用第一个元素。
-
要填充
<input>
、<textarea>
或[contenteditable]
元素的值。 -
options
Frame.FillOptions
(可选)-
setForce
布尔值 (可选)在以下版本中添加: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);
参数
-
用于搜索元素的选择器。如果有多个元素满足选择器,则将使用第一个元素。
-
要获取值的属性名称。
-
options
Frame.GetAttributeOptions
(可选)-
setStrict
boolean (可选)在以下版本中添加:v1.14#如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
以毫秒为单位的最大时间。默认为
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
列表<枚举 KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }
> (可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。
-
setNoWaitAfter
布尔值 (可选)新增于:v1.28#已弃用此选项无效。
此选项无效。
-
setPosition
位置 (可选)#相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。
-
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>
元素内部,则返回 control 的值。
用法
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()。了解更多关于 定位器 的信息。
返回元素是否被禁用,与 启用 相反。
用法
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
键将输入与键对应的文本的大写形式。
如果键是单个字符,则区分大小写,因此值 a
和 A
将生成不同的文本。
也支持诸如 key: "Control+o"
、key: "Control++
或 key: "Control+Shift+T"
之类的快捷方式。当与修饰符一起指定时,修饰符会被按下并保持按住状态,同时按下后续键。
用法
Frame.press(selector, key);
Frame.press(selector, key, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足选择器,则将使用第一个元素。
-
要按下的键的名称或要生成的字符,例如
ArrowLeft
或a
。 -
options
Frame.PressOptions
(可选)-
在
keydown
和keyup
之间等待的时间(毫秒)。默认为 0。 -
已弃用
此选项将来将默认为
true
。启动导航的操作将等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择不等待。您只需要在以下例外情况下使用此选项:例如,导航到不可访问的页面。默认为
false
。 -
setStrict
boolean (可选)在以下版本中添加:v1.14#如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
以毫秒为单位的最大时间。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
-
返回值
querySelector
新增于:v1.9请改用基于定位器的 Frame.locator()。详细了解定位器。
返回指向框架元素的 ElementHandle。
不建议使用ElementHandle,请改用Locator对象和以 Web 为中心的断言。
此方法在框架内查找与指定选择器匹配的元素。如果没有任何元素与选择器匹配,则返回 null
。
用法
Frame.querySelector(selector);
Frame.querySelector(selector, options);
参数
-
要查询的选择器。
-
options
Frame.QuerySelectorOptions
(可选)
返回值
querySelectorAll
新增于:v1.9请改用基于定位器的 Frame.locator()。详细了解定位器。
返回指向框架元素的 ElementHandles。
不建议使用ElementHandle,请改用Locator对象。
此方法在框架内查找与指定选择器匹配的所有元素。如果没有任何元素与选择器匹配,则返回空数组。
用法
Frame.querySelectorAll(selector);
参数
返回值
selectOption
在 v1.9 之前添加请改用基于定位器的 Locator.selectOption()。详细了解定位器。
此方法等待与选择器匹配的元素,等待可操作性检查,等待 <select>
元素中出现所有指定选项,然后选择这些选项。
如果目标元素不是 <select>
元素,则此方法将引发错误。但是,如果该元素位于具有关联控件的 <label>
元素内,则将使用该控件。
返回已成功选择的选项值的数组。
在选择所有提供的选项后,触发 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"});
参数
-
要查询的选择器。
-
values
空 | 字符串 | ElementHandle | 字符串[] |SelectOption
| ElementHandle[] |SelectOption
[]#-
setValue
字符串 (可选)按
option.value
匹配。可选。 -
setLabel
字符串 (可选)按
option.label
匹配。可选。 -
setIndex
整数 (可选)按索引匹配。可选。
要选择的选项。如果
<select>
具有multiple
属性,则选择所有匹配的选项,否则仅选择与传递的选项之一匹配的第一个选项。字符串值匹配值和标签。如果所有指定的属性都匹配,则认为选项匹配。 -
-
options
Frame.SelectOptionOptions
(可选)-
setForce
布尔值 (可选)在以下版本中添加:v1.13#是否绕过 可操作性 检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
setStrict
boolean (可选)在以下版本中添加:v1.14#如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
以毫秒为单位的最大时间。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
-
返回值
setChecked
新增于:v1.15请改用基于定位器的 Locator.setChecked()。详细了解定位器。
此方法通过执行以下步骤来选中或取消选中与选择器匹配的元素
- 查找与选择器匹配的元素。如果没有,请等待将匹配的元素附加到 DOM。
- 确保匹配的元素是复选框或单选输入。如果不是,此方法将引发异常。
- 如果元素已具有正确的选中状态,则此方法将立即返回。
- 等待可操作性对匹配元素进行检查,除非设置了setForce选项。如果元素在检查期间分离,则会重试整个操作。
- 如果需要,将元素滚动到可视区域。
- 使用 Page.mouse() 点击元素的中心。
- 确保元素现在已选中或未选中。如果不是,此方法将引发异常。
如果所有步骤组合在指定setTimeout期间未完成,则此方法将引发TimeoutError。传递零超时将禁用此功能。
用法
Frame.setChecked(selector, checked);
Frame.setChecked(selector, checked, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足选择器,则将使用第一个元素。
-
是否选中或取消选中复选框。
-
options
Frame.SetCheckedOptions
(可选)-
是否绕过 可操作性 检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
setPosition
位置 (可选)#相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
以毫秒为单位的最大时间。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。 -
设置后,此方法仅执行 可操作性 检查并跳过操作。默认为
false
。用于在元素准备好执行操作之前等待,而无需执行它。
-
返回值
setInputFiles
在 v1.9 之前添加请改用基于定位器的 Locator.setInputFiles()。了解更多关于 定位器 的信息。
将文件输入的值设置为这些文件路径或文件。如果某些 filePaths
是相对路径,则它们相对于当前工作目录解析。对于空数组,清除所选文件。
此方法期望 选择器 指向一个 输入元素。但是,如果该元素位于具有关联 控件 的 <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()。了解更多关于 定位器 的信息。
此方法通过执行以下步骤来点击与 选择器 匹配的元素
- 查找与 选择器 匹配的元素。如果没有,则等待匹配的元素附加到 DOM。
- 等待对匹配元素进行 可操作性 检查,除非设置了 setForce 选项。如果在检查期间元素被分离,则整个操作将重试。
- 如果需要,将元素滚动到可视区域。
- 使用 Page.touchscreen() 点击元素的中心或指定的 setPosition。
当所有步骤组合在指定的 setTimeout 内未完成时,此方法将抛出 TimeoutError。传递零超时将禁用此功能。
frame.tap()
要求浏览器上下文的 hasTouch
选项设置为 true。
用法
Frame.tap(selector);
Frame.tap(selector, options);
参数
-
用于搜索元素的选择器。如果有多个元素满足选择器,则将使用第一个元素。
-
options
Frame.TapOptions
(可选)-
是否绕过 可操作性 检查。默认为
false
。 -
setModifiers
列表<枚举 KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }
> (可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。
-
已弃用
此选项无效。
此选项无效。
-
setPosition
位置 (可选)#相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。
-
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()。了解更多关于 定位器 的信息。
此方法通过执行以下步骤来取消选中与 选择器 匹配的元素
- 查找与 选择器 匹配的元素。如果没有,则等待匹配的元素附加到 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。当您运行间接导致框架导航的代码时,此方法非常有用。请考虑以下示例
// 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
(可选)-
以毫秒为单位的最大操作时间,默认为 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'
- 当收到网络响应并开始加载文档时,认为操作已完成。
-
-
触发事件的操作的回调函数。
返回值
waitForSelector
在 v1.9 之前添加请改用断言可见性或基于定位器的 Locator.waitFor()。阅读更多关于 定位器 的信息。
当由选择器指定的元素满足 setState 选项时返回。如果等待 hidden
或 detached
,则返回 null
。
Playwright 会自动等待元素准备就绪,然后再执行操作。使用 Locator 对象和 Web 优先断言可以让代码免于使用 waitForSelector。
等待 selector 满足 setState 选项(出现在 DOM 中/从 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();
}
}
}
参数
-
要查询的选择器。
-
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,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
以毫秒为单位的最大时间。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
-
返回值
waitForTimeout
在 v1.9 之前添加在生产环境中永远不要等待超时。等待时间的测试本质上是不稳定的。请改用 Locator 操作和自动等待的 Web 断言。
等待给定的 timeout(以毫秒为单位)。
请注意,frame.waitForTimeout()
仅应用于调试。在生产环境中使用计时器的测试将是不稳定的。请改用网络事件、选择器变为可见等信号。
用法
Frame.waitForTimeout(timeout);
参数
返回值