跳到主要内容

Frame

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

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

转储框架树的示例

import com.microsoft.playwright.*;

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

方法

addScriptTag

在 v1.9 之前添加 frame.addScriptTag

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

向页面添加一个 <script> 标签,带有所需的 URL 或内容。

用法

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

参数

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

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

    • setPath Path (可选)#

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

    • setType String (可选)#

      脚本类型。使用 'module' 加载 JavaScript ES6 模块。更多详情请参阅 script

    • setUrl String (可选)#

      要添加的脚本的 URL。

返回值


addStyleTag

在 v1.9 之前添加 frame.addStyleTag

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

向页面添加一个带有所需 URL 的 <link rel="stylesheet"> 标签,或者添加一个带有内容的 <style type="text/css"> 标签。

用法

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

参数

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

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

    • setPath Path (可选)#

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

    • setUrl String (可选)#

      <link> 标签的 URL。

返回值


childFrames

在 v1.9 之前添加 frame.childFrames

用法

Frame.childFrames();

返回值


content

在 v1.9 之前添加 frame.content

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

用法

Frame.content();

返回值


dragAndDrop

添加于: v1.13 frame.dragAndDrop

用法

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

参数

  • source String#

    用于搜索要拖动元素的选定器。如果存在多个满足选定器的元素,则使用第一个。

  • target String#

    用于搜索要放置元素的选定器。如果存在多个满足选定器的元素,则使用第一个。

  • options Frame.DragAndDropOptions (可选)

    • setForce boolean (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

      在此点相对于元素的填充框左上角处点击源元素。如果未指定,则使用元素的某个可见点。

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

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

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

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

    • setTimeout double (可选)#

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

    • setTrial boolean (可选)#

      设置后,此方法仅执行可操作性检查并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪非常有用。

返回值


evaluate

在 v1.9 之前添加 frame.evaluate

返回 expression 的返回值。

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

如果传给 Frame.evaluate() 的函数返回一个不可序列化的值,那么 Frame.evaluate() 将返回 undefined。Playwright 还支持传输一些 JSON 不可序列化的额外值:-0, NaN, Infinity, -Infinity

用法

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

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

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

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

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

参数

  • expression String#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式求值为函数,则函数会自动调用。

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

返回值


evaluateHandle

在 v1.9 之前添加 frame.evaluateHandle

返回 expression 的返回值,作为 JSHandle

Frame.evaluate()Frame.evaluateHandle() 之间唯一的区别在于 Frame.evaluateHandle() 返回 JSHandle

如果传给 Frame.evaluateHandle() 的函数返回一个 Promise,那么 Frame.evaluateHandle() 将等待该 Promise 解析并返回其值。

用法

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

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

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

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

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

参数

  • expression String#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式求值为函数,则函数会自动调用。

  • arg EvaluationArgument (可选)#

    要传递给 expression 的可选参数。

返回值


frameElement

在 v1.9 之前添加 frame.frameElement

返回对应此框架的 frameiframe 元素句柄。

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

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

用法

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

返回值


frameLocator

添加于: v1.17 frame.frameLocator

处理 iframe 时,您可以创建一个框架定位符,该定位符将进入 iframe 并允许在该 iframe 中选择元素。

用法

以下代码片段定位了 id 为 my-frame 的 iframe 中文本为 "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 (可选)#

      通常存在于 heading, listitem, row, treeitem 角色的数字属性,对于 <h1>-<h6> 元素有默认值。

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

    • setName String | Pattern (可选)#

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

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

    • setPressed boolean (可选)#

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

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

    • setSelected boolean (可选)#

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

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

返回值

详情

角色选择器不能取代可访问性审计和一致性测试,但可以提供关于 ARIA 指南的早期反馈。

许多 html 元素都有一个隐式定义的角色,角色选择器可以识别这些角色。您可以在此处找到所有支持的角色。ARIA 指南不建议通过将 role 和/或 aria-* 属性设置为默认值来重复隐式角色和属性。


getByTestId

添加于: v1.27 frame.getByTestId

通过测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过元素的测试 ID 定位它:

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

参数

返回值

详情

默认情况下,data-testid 属性用作测试 ID。如有必要,使用 Selectors.setTestIdAttribute() 配置不同的测试 ID 属性。


getByText

添加于: v1.27 frame.getByText

允许定位包含给定文本的元素。

另请参阅 Locator.filter(),它允许按其他条件(例如可访问角色)进行匹配,然后再按文本内容进行过滤。

用法

考虑以下 DOM 结构

<div>Hello <span>world</span></div>
<div>Hello</div>

您可以通过文本子字符串、精确字符串或正则表达式进行定位:

// Matches <span>
page.getByText("world");

// Matches first <div>
page.getByText("Hello world");

// Matches second <div>
page.getByText("Hello", new Page.GetByTextOptions().setExact(true));

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

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

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Frame.GetByTextOptions (可选)

    • setExact boolean (可选)#

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

返回值

详情

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

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


getByTitle

添加于: v1.27 frame.getByTitle

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

用法

考虑以下 DOM 结构。

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

通过 title 文本定位后,可以检查 issues 计数:

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

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Frame.GetByTitleOptions (可选)

    • setExact boolean (可选)#

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

返回值


isDetached

在 v1.9 之前添加 frame.isDetached

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

用法

Frame.isDetached();

返回值


isEnabled

在 v1.9 之前添加 frame.isEnabled

返回元素是否启用

用法

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

参数

  • selector String#

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

  • options Frame.IsEnabledOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


locator

添加于: v1.14 frame.locator

此方法返回一个元素定位符,可用于在此页面/框架上执行操作。定位符在执行操作之前立即解析为元素,因此对同一定位符进行的一系列操作实际上可以在不同的 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 字符串 | Pattern (可选)添加于: v1.33#

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

    • setHasText 字符串 | Pattern (可选)#

      匹配内部(可能在子元素或后代元素中)包含指定文本的元素。当传入一个字符串时,匹配是不区分大小写的,并搜索子字符串。例如,"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或导航到具有不同 hash 的相同 URL,这些操作将成功并返回null

注意

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

用法

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

参数

  • url 字符串#

    要导航 frame 的 URL。url 应包含 scheme,例如https://

  • options Frame.NavigateOptions (可选)

    • setReferer 字符串 (可选)#

      Referer header 值。如果提供,它将优先于Page.setExtraHTTPHeaders()设置的 referer header 值。

    • setTimeout double (可选)#

      操作的最大时间(毫秒),默认为 30 秒,传递0以禁用超时。可以通过BrowserContext.setDefaultNavigationTimeout()BrowserContext.setDefaultTimeout()Page.setDefaultNavigationTimeout()Page.setDefaultTimeout()方法更改默认值。

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

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

      • 'domcontentloaded' - 当DOMContentLoaded事件被触发时,认为操作完成。
      • 'load' - 当load事件被触发时,认为操作完成。
      • 'networkidle' - 不推荐 当至少500毫秒内没有网络连接时,认为操作完成。不要将此方法用于测试,而是依赖 web 断言来评估准备状态。
      • 'commit' - 当接收到网络响应且文档开始加载时,认为操作完成。

返回值


page

在 v1.9 之前添加 frame.page

返回包含此 frame 的 page。

用法

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 字符串#

    要分配给页面的 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返回一个 truthy 值时返回,返回该值。

用法

Frame.waitForFunction()可用于观察 viewport 大小的变化

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函数的 predicate

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

参数

  • expression 字符串#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式求值为函数,则函数会自动调用。

  • arg EvaluationArgument (可选)#

    可选参数,传递给expression

  • options Frame.WaitForFunctionOptions (可选)

    • setPollingInterval double (可选)#

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

    • 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 字符串 | Pattern | Predicate<字符串>#

    用于在等待导航时匹配 [URL] 的 glob 模式、regex 模式或 predicate。请注意,如果参数是不带通配符的字符串,则该方法将等待导航到与该字符串完全相等的 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 的Locator.check()。阅读更多关于locators的信息。

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options Frame.CheckOptions (可选)

    • setForce boolean (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

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

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

    • setTimeout double (可选)#

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

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

      设置后,此方法仅执行可操作性检查并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪非常有用。

返回值


click

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

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

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options Frame.ClickOptions (可选)

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

      默认为left

    • setClickCount int (可选)#

      默认为 1。请参阅UIEvent.detail

    • setDelay double (可选)#

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

    • setForce boolean (可选)#

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

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

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      未来此选项将默认为true

      启动导航的操作会等待这些导航发生并等待页面开始加载。通过设置此标志,你可以选择不等待。只有在特殊情况下(例如导航到不可访问的页面)才需要此选项。默认为false

    • setPosition Position (可选)#

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

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

此方法通过执行以下步骤来双击与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 字符串#

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

  • options Frame.DblclickOptions (可选)

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

      默认为left

    • setDelay double (可选)#

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

    • setForce boolean (可选)#

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

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

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

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

下面的代码片段在元素上分派click事件。无论元素的可见性状态如何,都会分派click事件。这相当于调用element.click()

用法

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

在底层,它根据给定的type创建一个事件实例,使用eventInit属性对其进行初始化,并在元素上分派该事件。事件默认是composedcancelable和 bubble 的。

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

如果你想将 live 对象传递给事件,你也可以指定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 字符串#

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

  • type 字符串#

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

此方法在帧内查找匹配指定选择器的元素,并将其作为第一个参数传递给 expression。如果没有元素匹配该选择器,则此方法会抛出异常。

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

用法

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

参数

  • selector String#

    要查询的选择器。

  • expression String#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式求值为函数,则函数会自动调用。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

  • options Frame.EvalOnSelectorOptions (可选)

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

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

返回值


evalOnSelectorAll

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

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

返回 expression 的返回值。

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

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

用法

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

参数

  • selector String#

    要查询的选择器。

  • expression String#

    要在浏览器上下文中执行的 JavaScript 表达式。如果表达式求值为函数,则函数会自动调用。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值


fill

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

请改用基于定位符的 Locator.fill()。详细了解定位符

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

如果目标元素不是 <input><textarea>[contenteditable] 元素,此方法会抛出异常。但是,如果元素位于具有关联控件<label> 元素内,则将填充该控件。

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

用法

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

参数

  • selector String#

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

  • value String#

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

  • options Frame.FillOptions (可选)

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

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • setTimeout double (可选)#

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

返回值


focus

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

请改用基于定位符的 Locator.focus()。详细了解定位符

此方法使用 selector 获取一个元素并聚焦它。如果没有匹配 selector 的元素,此方法将等待直到 DOM 中出现匹配的元素。

用法

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

参数

  • selector String#

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

  • options Frame.FocusOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


getAttribute

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

请改用基于定位符的 Locator.getAttribute()。详细了解定位符

返回元素的属性值。

用法

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

参数

  • selector String#

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

  • name String#

    要获取值的属性名称。

  • options Frame.GetAttributeOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


hover

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

请改用基于定位符的 Locator.hover()。详细了解定位符

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

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

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

用法

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

参数

  • selector String#

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

  • options Frame.HoverOptions (可选)

    • setForce boolean (可选)#

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

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

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

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

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

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

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

    • setTimeout double (可选)#

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

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

      设置后,此方法仅执行可操作性检查并跳过操作。默认为false。用于等待元素准备好执行操作,而不实际执行操作。请注意,无论是否设置了trial,都会按下键盘modifiers,以便测试仅在按下这些键时才可见的元素。

返回值


innerHTML

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

请改用基于定位符的 Locator.innerHTML()。详细了解定位符

返回 element.innerHTML

用法

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

参数

  • selector String#

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

  • options Frame.InnerHTMLOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


innerText

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

请改用基于定位符的 Locator.innerText()。详细了解定位符

返回 element.innerText

用法

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

参数

  • selector String#

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

  • options Frame.InnerTextOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


inputValue

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

请改用基于定位符的 Locator.inputValue()。详细了解定位符

返回所选 <input><textarea><select> 元素的 input.value

对于非输入元素会抛出异常。但是,如果元素位于具有关联控件<label> 元素内,则返回该控件的值。

用法

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

参数

  • selector String#

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

  • options Frame.InputValueOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


isChecked

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

请改用基于定位符的 Locator.isChecked()。详细了解定位符

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

用法

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

参数

  • selector String#

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

  • options Frame.IsCheckedOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


isDisabled

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

请改用基于定位符的 Locator.isDisabled()。详细了解定位符

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

用法

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

参数

  • selector String#

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

  • options Frame.IsDisabledOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


isEditable

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

请改用基于定位符的 Locator.isEditable()。详细了解定位符

返回元素是否可编辑

用法

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

参数

  • selector String#

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

  • options Frame.IsEditableOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


isHidden

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

请改用基于定位符的 Locator.isHidden()。详细了解定位符

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

用法

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

参数

  • selector String#

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

  • options Frame.IsHiddenOptions (可选)

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

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

    • setTimeout double (可选)#

      已弃用

      此选项将被忽略。Frame.isHidden() 不等待元素变为隐藏状态,而是立即返回。

返回值


isVisible

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

请改用基于定位符的 Locator.isVisible()。详细了解定位符

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

用法

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

参数

  • selector String#

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

  • options Frame.IsVisibleOptions (可选)

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

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

    • setTimeout double (可选)#

      已弃用

      此选项将被忽略。Frame.isVisible() 不等待元素变为可见状态,而是立即返回。

返回值


press

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

请改用基于定位符的 Locator.press()。详细了解定位符

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

F1 - F12Digit0- Digit9KeyA- KeyZBackquoteMinusEqualBackslashBackspaceTabDeleteEscapeArrowDownEndEnterHomeInsertPageDownPageUpArrowRightArrowUp 等。

还支持以下修饰符快捷键:ShiftControlAltMetaShiftLeftControlOrMetaControlOrMeta 在 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#

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

  • 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()。详细了解定位符

返回指向帧元素的 ElementHandle。

注意

不建议使用 ElementHandle,请改用 Locator 对象和 web-first 断言。

此方法在帧内查找匹配指定选择器的元素。如果没有元素匹配该选择器,则返回 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()。详细了解定位符

返回指向帧元素的 ElementHandle 列表。

注意

不建议使用 ElementHandle,请改用 Locator 对象。

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

用法

Frame.querySelectorAll(selector);

参数

  • selector String#

    要查询的选择器。

返回值


selectOption

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

请改用基于定位符的 Locator.selectOption()。详细了解定位符

此方法等待匹配 selector 的元素,等待操作性检查,等待直到 <select> 元素中存在所有指定的选项,然后选择这些选项。

如果目标元素不是 <select> 元素,此方法会抛出异常。但是,如果元素位于具有关联控件<label> 元素内,则将使用该控件。

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

在所有提供的选项都被选择后,会触发 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 属性,则会选择所有匹配的选项;否则仅选择与所传递选项之一匹配的第一个选项。字符串值匹配 valuelabel。如果所有指定属性都匹配,则认为选项匹配。

  • options Frame.SelectOptionOptions (可选)

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

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • setTimeout double (可选)#

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

返回值


setChecked

添加于: v1.15 frame.setChecked
不推荐

请改用基于定位符的 Locator.setChecked()。详细了解定位符

此方法通过执行以下步骤检查或取消选择匹配 selector 的元素:

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

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

用法

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

参数

  • selector String#

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

  • checked boolean#

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

  • options Frame.SetCheckedOptions (可选)

    • setForce boolean (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

    • setStrict boolean (可选)#

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

    • setTimeout double (可选)#

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

    • setTrial boolean (可选)#

      设置后,此方法仅执行可操作性检查并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪非常有用。

返回值


setInputFiles

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

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

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

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

用法

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

参数

  • selector String#

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

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

  • options Frame.SetInputFilesOptions (可选)

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • setTimeout double (可选)#

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

返回值


tap

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

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

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

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

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

注意

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

用法

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

参数

  • selector String#

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

  • options Frame.TapOptions (可选)

    • setForce boolean (可选)#

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

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

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

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

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

    • setTimeout double (可选)#

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

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

      设置后,此方法仅执行可操作性检查并跳过操作。默认为false。用于等待元素准备好执行操作,而不实际执行操作。请注意,无论是否设置了trial,都会按下键盘modifiers,以便测试仅在按下这些键时才可见的元素。

返回值


textContent

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

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

返回 element.textContent

用法

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

参数

  • selector String#

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

  • options Frame.TextContentOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值


type

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

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

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

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

用法

参数

  • selector String#

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

  • text String#

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

  • options Frame.TypeOptions (可选)

    • setDelay double (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • setTimeout double (可选)#

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

返回值


uncheck

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

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

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

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

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

用法

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

参数

  • selector String#

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

  • options Frame.UncheckOptions (可选)

    • setForce boolean (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

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

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

    • setTimeout double (可选)#

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

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

      设置后,此方法仅执行可操作性检查并跳过实际操作。默认为 false。在不执行操作的情况下等待元素准备就绪非常有用。

返回值


waitForNavigation

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

此方法本身存在竞态条件,请改用 Frame.waitForURL()

等待帧导航并返回主资源响应。在多次重定向的情况下,导航将解析为最后一次重定向的响应。如果导航到不同的锚点或由于 History API 使用而导致的导航,导航将解析为 null

用法

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

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

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

参数

  • options Frame.WaitForNavigationOptions (可选)

    • setTimeout double (可选)#

      操作的最大时间(毫秒),默认为 30 秒,传递0以禁用超时。可以通过BrowserContext.setDefaultNavigationTimeout()BrowserContext.setDefaultTimeout()Page.setDefaultNavigationTimeout()Page.setDefaultTimeout()方法更改默认值。

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

      用于在等待导航时匹配 [URL] 的 glob 模式、regex 模式或 predicate。请注意,如果参数是不带通配符的字符串,则该方法将等待导航到与该字符串完全相等的 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-first 断言可以使代码无需等待选择器。

等待 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' - 等待元素具有非空的 bounding box 且没有 visibility:hidden。请注意,没有任何内容或具有 display:none 的元素具有空的 bounding box 且不被视为可见。
      • 'hidden' - 等待元素从 DOM 中分离,或具有空的 bounding box 或 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#

    要等待的超时时间

返回值