Frame

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

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

page.on('frameattached') - 当框架附加到页面时触发。一个框架只能附加到页面一次。
page.on('framenavigated') - 当框架导航到不同 URL 时触发。
page.on('framedetached') - 当框架从页面分离时触发。一个框架只能从页面分离一次。

以下是转储框架树的示例：

const { firefox } = require('playwright');  // 或 'chromium' 或 'webkit'.

(async () => {
  const browser = await firefox.launch();
  const page = await browser.newPage();
  await page.goto('https://www.google.com/chrome/browser/canary.html');
  dumpFrameTree(page.mainFrame(), '');
  await browser.close();

  function dumpFrameTree(frame, indent) {
    console.log(indent + frame.url());
    for (const child of frame.childFrames())
      dumpFrameTree(child, indent + '  ');
  }
})();

方法

addScriptTag

v1.9 版本前添加

frame.addScriptTag

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

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

用法

await frame.addScriptTag();
await frame.addScriptTag(options);

参数

options Object (可选)
- content string (可选)#
  
  要注入到 frame 中的原始 JavaScript 内容。
- path string (可选)#
  
  要注入到 frame 中的 JavaScript 文件路径。如果 path 是相对路径，则相对于当前工作目录解析。
- type string (可选)#
  
  脚本类型。使用 'module' 来加载 JavaScript ES6 模块。详见 script。
- url string (可选)#
  
  要添加的脚本 URL。

返回值

Promise<ElementHandle>#

addStyleTag

Added before v1.9

frame.addStyleTag

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

向页面添加一个带有指定 URL 的 <link rel="stylesheet"> 标签，或一个带有 CSS 内容的 <style type="text/css"> 标签。

用法

await frame.addStyleTag();
await frame.addStyleTag(options);

参数

options Object (可选)
- content string (可选)#
  
  要注入到 frame 中的原始 CSS 内容。
- path string (可选)#
  
  要注入到 frame 中的 CSS 文件路径。如果 path 是相对路径，则相对于当前工作目录解析。
- url string (可选)#
  
  <link> 标签的 URL。

返回值

Promise<ElementHandle>#

childFrames

Added before v1.9

frame.childFrames

用法

frame.childFrames();

返回值

Array<Frame>#

content

v1.9 版本前添加

frame.content

获取框架的完整 HTML 内容，包括文档类型声明。

用法

await frame.content();

返回值

Promise<string>#

dragAndDrop

Added in: v1.13

frame.dragAndDrop

用法

await frame.dragAndDrop(source, target);
await frame.dragAndDrop(source, target, options);

参数

source string #

用于查找要拖拽元素的选择器。如果有多个元素匹配选择器，将使用第一个元素。
target string #

用于查找要放置元素的选择器。如果有多个元素匹配选择器，将使用第一个元素。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- sourcePosition Object (可选) Added in: v1.14#
  - x number
  - y number
  在源元素上相对于其内边距框左上角的该点位置进行点击。如果未指定，则使用元素的某个可见点。
- strict boolean (可选) Added in: v1.14#
  
  当为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，将抛出异常。
- targetPosition Object (可选) Added in: v1.14#
  - x number
  - y number
  在目标元素上相对于其内边距框左上角的该点位置进行放置。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法修改。
- trial boolean (可选)#
  
  当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为 false。适用于等待元素准备好执行操作而不实际执行的情况。

返回值

Promise<void>#

evaluate

v1.9 版本前添加

frame.evaluate

返回 pageFunction 的执行结果。

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

如果传递给 frame.evaluate() 的函数返回一个非 Serializable 值，则 frame.evaluate() 会返回 undefined。Playwright 还支持传输一些无法通过 JSON 序列化的额外值：-0、NaN、Infinity、-Infinity。

用法

const result = await frame.evaluate(([x, y]) => {
  return Promise.resolve(x * y);
}, [7, 8]);
console.log(result); // 输出 "56"

也可以传递字符串代替函数。

console.log(await frame.evaluate('1 + 2')); // 输出 "3"

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

const bodyHandle = await frame.evaluate('document.body');
const html = await frame.evaluate(([body, suffix]) =>
  body.innerHTML + suffix, [bodyHandle, 'hello'],
);
await bodyHandle.dispose();

参数

pageFunction function | string #

要在页面上下文中执行的函数。
arg EvaluationArgument (可选)#

传递给 pageFunction 的可选参数。

返回值

Promise<Serializable>#

evaluateHandle

v1.9 版本前添加

frame.evaluateHandle

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

frame.evaluate() 和 frame.evaluateHandle() 的唯一区别在于 frame.evaluateHandle() 会返回 JSHandle。

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

用法

// 获取 window 对象的句柄
const aWindowHandle = await frame.evaluateHandle(() => Promise.resolve(window));

也可以传递字符串代替函数：

const aHandle = await frame.evaluateHandle('document'); // 获取 'document' 的句柄

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

const aHandle = await frame.evaluateHandle(() => document.body);
const resultHandle = await frame.evaluateHandle(([body, suffix]) =>
  body.innerHTML + suffix, [aHandle, 'hello'],
);
console.log(await resultHandle.jsonValue());
await resultHandle.dispose();

参数

pageFunction function | string #

要在页面上下文中执行的函数。
arg EvaluationArgument (可选)#

传递给 pageFunction 的可选参数。

返回值

Promise<JSHandle>#

frameElement

Added before v1.9

frame.frameElement

返回与该 frame 对应的 frame 或 iframe 元素句柄。

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

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

用法

const frameElement = await frame.frameElement();
const contentFrame = await frameElement.contentFrame();
console.log(frame === contentFrame);  // -> true

返回值

Promise<ElementHandle>#

frameLocator

Added in: v1.17

frame.frameLocator

当处理 iframe 时，可以创建一个 frame 定位器，该定位器会进入 iframe 并允许选择其中的元素。

用法

以下代码片段定位 id 为 my-frame 的 iframe 中文本为 "Submit" 的元素，例如 <iframe id="my-frame">:

const locator = frame.frameLocator('#my-iframe').getByText('Submit');
await locator.click();

参数

selector string #

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

返回值

FrameLocator #

getByAltText

添加于: v1.27

frame.getByAltText

允许通过元素的 alt 文本定位元素。

用法

例如，这个方法会通过 alt 文本 "Playwright logo" 找到图片：

<img alt='Playwright logo'>

await page.getByAltText('Playwright logo').click();

参数

text string | RegExp #

用于定位元素的文本。
options Object (可选)
- exact boolean (可选)#
  
  是否查找完全匹配：区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略此选项。注意完全匹配仍会修剪空白字符。

Locator #

getByLabel

添加于: v1.27

frame.getByLabel

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

用法

例如，以下方法将通过标签 "Username" 和 "Password" 在以下 DOM 中找到输入框：

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">

await page.getByLabel('Username').fill('john');
await page.getByLabel('Password').fill('secret');

参数

text string | RegExp #

用于定位元素的文本
options Object (可选)
- exact boolean (可选)#
  
  是否查找精确匹配：区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略此选项。注意精确匹配仍会修剪空白字符。

Locator #

getByPlaceholder

添加于: v1.27

frame.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构：

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

您可以通过占位符文本定位输入框后填写内容：

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

参数

text string | RegExp #

用于定位元素的文本。
options Object (可选)
- exact boolean (可选)#
  
  是否查找精确匹配：区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略此选项。注意精确匹配仍会修剪空白字符。

返回值

Locator #

getByRole

添加于: v1.27

frame.getByRole

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

用法

考虑以下 DOM 结构：

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

您可以通过元素的隐式角色来定位每个元素：

await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();

await page.getByRole('checkbox', { name: 'Subscribe' }).check();

await page.getByRole('button', { name: /submit/i }).click();

参数

role "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 Object (可选)
- checked boolean (可选)#
  
  通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。
  
  了解更多关于 aria-checked。
- disabled boolean (可选)#
  
  通常由 aria-disabled 或 disabled 设置的属性。
  
  :::注意
  
  与大多数其他属性不同，disabled 是通过 DOM 层次结构继承的。了解更多关于 aria-disabled。 :::
- exact boolean (可选) 添加于: v1.28#
  
  是否精确匹配 name：区分大小写且全字符串匹配。默认为 false。当 name 是正则表达式时忽略此选项。注意精确匹配仍会修剪空白字符。
- expanded boolean (可选)#
  
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded。
- includeHidden boolean (可选)#
  
  控制是否匹配隐藏元素的选项。默认情况下，角色选择器仅匹配非隐藏元素，如 ARIA 定义。
  
  了解更多关于 aria-hidden。
- level number (可选)#
  
  通常出现在 heading、listitem、row、treeitem 角色中的数字属性，对于 <h1>-<h6> 元素有默认值。
  
  了解更多关于 aria-level。
- name string | RegExp (可选)#
  
  匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 exact 来控制此行为。
  
  了解更多关于可访问名称。
- pressed boolean (可选)#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed。
- selected boolean (可选)#
  
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected。

Locator #

详细信息

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

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

getByTestId

添加于: v1.27

frame.getByTestId

通过测试ID定位元素。

用法

考虑以下DOM结构：

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

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

await page.getByTestId('directions').click();

参数

testId string | RegExp #

用于定位元素的ID。

返回值

Locator #

详细信息

默认情况下，使用data-testid属性作为测试ID。如果需要，可以使用selectors.setTestIdAttribute()配置不同的测试ID属性。

// 从@playwright/test配置中设置自定义测试ID属性：
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    testIdAttribute: 'data-pw'
  },
});

getByText

添加于: v1.27

frame.getByText

用于定位包含指定文本的元素。

另请参阅 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', { exact: true });

// 匹配两个 <div>
page.getByText(/Hello/);

// 匹配第二个 <div>
page.getByText(/^hello$/i);

参数

text string | RegExp #

用于定位元素的文本。
options Object (可选)
- exact boolean (可选)#
  
  是否查找精确匹配：区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略此选项。注意精确匹配仍会修剪空白字符。

Locator #

详细说明

按文本匹配时总会规范化空白字符，即使是精确匹配。例如，会将多个空格合并为一个，将换行符转为空格，并忽略首尾空白字符。

button 和 submit 类型的输入元素通过其 value 属性而非文本内容进行匹配。例如，通过文本 "Log in" 定位会匹配 <input type=button value="Log in">。

getByTitle

添加于: v1.27

frame.getByTitle

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

用法

考虑以下 DOM 结构：

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

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

await expect(page.getByTitle('Issues count')).toHaveText('25 issues');

参数

text string | RegExp #

用于定位元素的文本
options Object (可选)
- exact boolean (可选)#
  
  是否查找完全匹配：区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略此选项。注意完全匹配仍会修剪空白字符。

返回值

Locator #

goto

v1.9 之前添加

frame.goto

返回主资源响应。对于多次重定向的情况，导航将返回最后一次重定向的响应。

在以下情况下该方法会抛出错误：

存在 SSL 错误（例如自签名证书）
目标 URL 无效
导航过程中超过超时时间
远程服务器无响应或无法访问
主资源加载失败

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

备注

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

备注

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

用法

await frame.goto(url);
await frame.goto(url, options);

参数

url string #

要导航到的 URL。URL 应包含协议，例如 https://。
options Object (可选)
- referer string (可选)#
  
  Referer 头信息值。如果提供，将优先于通过 page.setExtraHTTPHeaders() 设置的 referer 头信息值。
- timeout number (可选)#
  
  操作的最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置文件中的 navigationTimeout 选项修改，或者使用 browserContext.setDefaultNavigationTimeout()、browserContext.setDefaultTimeout()、page.setDefaultNavigationTimeout() 或 page.setDefaultTimeout() 方法修改。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#
  
  何时认为操作成功，默认为 load。可选值有：
  - 'domcontentloaded' - 当触发 DOMContentLoaded 事件时认为操作完成
  - 'load' - 当触发 load 事件时认为操作完成
  - 'networkidle' - 不推荐 当至少 500 毫秒没有网络连接时认为操作完成。不要将此方法用于测试，应依赖 web 断言来评估准备状态
  - 'commit' - 当收到网络响应且文档开始加载时认为操作完成

Promise<null | Response>#

isDetached

v1.9 版本前添加

frame.isDetached

如果 frame 已被分离则返回 true，否则返回 false。

用法

frame.isDetached();

返回值

boolean #

isEnabled

v1.9 之前添加

frame.isEnabled

返回元素是否处于可操作状态。

用法

await frame.isEnabled(selector);
await frame.isEnabled(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素匹配选择器，将使用第一个元素。
options Object (可选)
- strict boolean (可选) v1.14 新增#
  
  当设置为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<boolean>#

locator

添加于: v1.14

frame.locator

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

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

用法

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

参数

selector string #

用于解析 DOM 元素的选择器。
options Object (可选)
- has Locator (可选)#
  
  将方法结果缩小到包含匹配此相对定位器的元素。例如，article 包含 text=Playwright 会匹配 <article><div>Playwright</div></article>。
  
  内部定位器必须相对于外部定位器，并且从外部定位器匹配处开始查询，而不是文档根。例如，可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是查找包含 article div 的 content 会失败，因为内部定位器必须是相对的，不应使用 content 之外的元素。
  
  注意外部和内部定位器必须属于同一框架。内部定位器不能包含 FrameLocator。
- hasNot Locator (可选) 添加于: v1.33#
  
  匹配不包含内部定位器元素的元素。内部定位器针对外部定位器进行查询。例如，article 不包含 div 会匹配 <article><span>Playwright</span></article>。
  
  注意外部和内部定位器必须属于同一框架。内部定位器不能包含 FrameLocator。
- hasNotText string | RegExp (可选) 添加于: v1.33#
  
  匹配内部不包含指定文本的元素，可能在子元素或后代元素中。当传入 string 时，匹配不区分大小写并搜索子字符串。
- hasText string | RegExp (可选)#
  
  匹配内部包含指定文本的元素，可能在子元素或后代元素中。当传入 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 会匹配 <article><div>Playwright</div></article>。

返回值

Locator #

name

Added before v1.9

frame.name

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

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

备注

此值在 frame 创建时计算一次，后续属性变更不会更新返回值。

用法

frame.name();

返回值

string #

page

Added before v1.9

frame.page

返回包含此 frame 的页面对象。

用法

frame.page();

返回值

Page #

parentFrame

Added before v1.9

frame.parentFrame

返回父级 frame（如果存在）。已分离的 frame 和主 frame 返回 null。

用法

frame.parentFrame();

返回值

null | Frame #

setContent

v1.9 版本前添加

frame.setContent

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

用法

await frame.setContent(html);
await frame.setContent(html, options);

参数

html string #

要分配给页面的 HTML 标记。
options Object (可选)
- timeout number (可选)#
  
  操作的最大超时时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 navigationTimeout 选项修改，或使用 browserContext.setDefaultNavigationTimeout()、browserContext.setDefaultTimeout()、page.setDefaultNavigationTimeout() 或 page.setDefaultTimeout() 方法修改。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#
  
  何时认为操作成功，默认为 load。可选事件包括：
  - 'domcontentloaded' - 当触发 DOMContentLoaded 事件时认为操作完成。
  - 'load' - 当触发 load 事件时认为操作完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒没有网络连接时认为操作完成。不要将此方法用于测试，应依赖 web 断言来评估准备状态。
  - 'commit' - 当收到网络响应且文档开始加载时认为操作完成。

返回值

Promise<void>#

title

v1.9 版本前添加

frame.title

返回页面标题。

用法

await frame.title();

返回值

Promise<string>#

url

v1.9 版本前添加

frame.url

返回框架的 URL 地址。

用法

frame.url();

返回值

string #

waitForFunction

v1.9 版本前添加

frame.waitForFunction

当 pageFunction 返回真值时返回，并返回该值。

用法

frame.waitForFunction() 可用于观察视口尺寸变化：

const { firefox } = require('playwright');  // 或 'chromium' 或 'webkit'.

(async () => {
  const browser = await firefox.launch();
  const page = await browser.newPage();
  const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100');
  await page.setViewportSize({ width: 50, height: 50 });
  await watchDog;
  await browser.close();
})();

要向 frame.waitForFunction 的谓词函数传递参数：

const selector = '.foo';
await frame.waitForFunction(selector => !!document.querySelector(selector), selector);

参数

pageFunction function | string #

在页面上下文中执行的函数。
arg EvaluationArgument (可选)#

传递给 pageFunction 的可选参数。
options Object (可选)
- polling number | "raf" (可选)#
  
  如果 polling 为 'raf'，则 pageFunction 会在 requestAnimationFrame 回调中持续执行。如果 polling 是数字，则作为函数执行的时间间隔（毫秒）。默认为 raf。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法修改。

Promise<JSHandle>#

waitForLoadState

v1.9 之前添加

frame.waitForLoadState

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

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

备注

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

用法

await frame.click('button'); // 点击触发导航
await frame.waitForLoadState(); // 默认等待 'load' 状态

参数

state "load" | "domcontentloaded" | "networkidle" (可选)#

要等待的可选加载状态，默认为 load。如果在加载当前文档时已达到该状态，则方法立即解析。可以是以下之一：
- 'load' - 等待触发 load 事件
- 'domcontentloaded' - 等待触发 DOMContentLoaded 事件
- 'networkidle' - 不推荐 等待至少 500 毫秒内没有网络连接。不要将此方法用于测试，应依赖 web 断言来评估准备状态
options Object (可选)
- timeout number (可选)#
  
  操作的最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 navigationTimeout 选项更改，或使用 browserContext.setDefaultNavigationTimeout()、browserContext.setDefaultTimeout()、page.setDefaultNavigationTimeout() 或 page.setDefaultTimeout() 方法

Promise<void>#

waitForURL

添加于: v1.11

frame.waitForURL

等待 frame 导航到指定 URL。

用法

await frame.click('a.delayed-navigation'); // 点击链接将间接触发导航
await frame.waitForURL('**/target.html');

参数

url string | RegExp | function(URL):boolean #

等待导航时匹配的 glob 模式、正则表达式或接收 URL 的谓词函数。注意：如果参数是不含通配符的字符串，该方法将等待导航到完全匹配该字符串的 URL。
options Object (可选)
- timeout number (可选)#
  
  最大操作时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 navigationTimeout 选项修改，或使用 browserContext.setDefaultNavigationTimeout()、browserContext.setDefaultTimeout()、page.setDefaultNavigationTimeout() 或 page.setDefaultTimeout() 方法修改。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#
  
  何时认为操作成功，默认为 load。可选事件包括：
  - 'domcontentloaded' - 当触发 DOMContentLoaded 事件时认为操作完成。
  - 'load' - 当触发 load 事件时认为操作完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒没有网络连接时认为操作完成。不要将此方法用于测试，应改用 web 断言来评估准备状态。
  - 'commit' - 当收到网络响应且文档开始加载时认为操作完成。

返回值

Promise<void>#

已弃用

$

添加于: v1.9

frame.$

不推荐使用

建议改用基于定位器的 frame.locator() 方法。了解更多关于定位器的信息。

返回指向框架元素的 ElementHandle 对象。

警告

不建议使用 ElementHandle，推荐改用 Locator 对象和面向 web 的断言。

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

用法

await frame.$(selector);
await frame.$(selector, options);

参数

selector string #

要查询的选择器。
options Object (可选)
- strict boolean (可选) 添加于: v1.14#
  
  当设为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用会抛出异常。

返回值

Promise<null | ElementHandle>#

$$

添加于: v1.9

frame.$$

不推荐使用

请改用基于定位器的 frame.locator()。了解更多关于定位器的信息。

返回指向框架元素的 ElementHandles 数组。

警告

不推荐使用 ElementHandle，建议改用 Locator 对象。

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

用法

await frame.$$(selector);

参数

selector string #

要查询的选择器。

返回值

Promise<Array<ElementHandle>>#

$eval

添加于: v1.9

frame.$eval

不推荐使用

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

返回 pageFunction 的返回值。

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

如果 pageFunction 返回一个 Promise，则 frame.$eval() 会等待该 Promise 解析并返回其值。

用法

const searchValue = await frame.$eval('#search', el => el.value);
const preloadHref = await frame.$eval('link[rel=preload]', el => el.href);
const html = await frame.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');

参数

selector string #

要查询的选择器。
pageFunction function(Element) | string #

在页面上下文中要执行的函数。
arg EvaluationArgument (可选)#

传递给 pageFunction 的可选参数。
options Object (可选)
- strict boolean (可选) 添加于: v1.14#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用会抛出异常。

返回值

Promise<Serializable>#

$$eval

v1.9 新增

frame.$$eval

不推荐使用

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

返回 pageFunction 的返回值。

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

如果 pageFunction 返回一个 Promise，则 frame.$$eval() 会等待该 Promise 解析并返回其值。

用法

const divsCounts = await frame.$$eval('div', (divs, min) => divs.length >= min, 10);

参数

selector string #

要查询的选择器。
pageFunction function(Array<Element>) | string #

在页面上下文中要执行的函数。
arg EvaluationArgument (可选)#

传递给 pageFunction 的可选参数。

返回值

Promise<Serializable>#

check

v1.9 之前版本添加

frame.check

不推荐使用

建议改用基于定位器的 locator.check()。了解更多关于定位器的信息。

该方法通过以下步骤勾选匹配 selector 的元素：

查找匹配 selector 的元素。如果没有找到，则等待直到匹配的元素附加到 DOM 中。
确保匹配的元素是复选框或单选按钮。如果不是，该方法会抛出异常。如果元素已经被勾选，该方法立即返回。
等待对匹配元素进行可操作性检查，除非设置了 force 选项。如果在检查期间元素被分离，则整个操作会重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素的中心点。
确保元素现在已被勾选。如果没有，该方法会抛出异常。

如果所有步骤在指定的 timeout 内未完成，该方法会抛出 TimeoutError。传递零超时值会禁用此功能。

用法

await frame.check(selector);
await frame.check(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则使用第一个。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选) v1.11 版本添加#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- strict boolean (可选) v1.14 版本添加#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- timeout number (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。
- trial boolean (可选) v1.11 版本添加#
  
  设置时，该方法仅执行可操作性检查并跳过操作。默认为 false。适用于等待元素准备好进行操作而不实际执行操作的情况。

Promise<void>#

click

v1.9 之前添加

frame.click

不推荐使用

建议改用基于定位器的 locator.click()。了解更多关于定位器的信息。

该方法通过以下步骤点击匹配选择器的元素：

查找匹配选择器的元素。如果没有找到，则等待直到匹配的元素附加到 DOM 中。
除非设置了 force 选项，否则等待对匹配元素进行可操作性检查。如果在检查期间元素被分离，则整个操作会重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素的中心位置或指定的位置。
除非设置了 noWaitAfter 选项，否则等待触发的导航成功或失败。

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

用法

await frame.click(selector);
await frame.click(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个。
options Object (可选)
- button "left" | "right" | "middle" (可选)#
  
  默认为 left。
- clickCount number (可选)#
  
  默认为 1。参见 UIEvent.detail。
- delay number (可选)#
  
  mousedown 和 mouseup 之间的等待时间（毫秒）。默认为 0。
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前按下的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  未来此选项将默认为 true。
  
  触发导航的操作会等待这些导航发生和页面开始加载。通过设置此标志可以选择不等待。仅在导航到不可访问页面等特殊情况下才需要此选项。默认为 false。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- strict boolean (可选) v1.14 新增#
  
  当为 true 时，调用要求选择器必须解析为单个元素。如果给定的选择器解析为多个元素，调用会抛出异常。
- timeout number (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选) v1.11 新增#
  
  设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好执行操作而不实际执行它。注意，无论 trial 如何，键盘 modifiers 都会被按下，以便测试仅在按下这些键时才可见的元素。

Promise<void>#

dblclick

v1.9 版本前添加

frame.dblclick

不推荐使用

请改用基于定位器的 locator.dblclick()。了解更多关于定位器的信息。

该方法通过执行以下步骤双击匹配选择器的元素：

查找匹配选择器的元素。如果没有找到，则等待直到匹配的元素附加到 DOM 中。
除非设置了 force 选项，否则等待对匹配元素进行可操作性检查。如果在检查过程中元素被分离，则整个操作会重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 双击元素的中心位置或指定的 position。如果 dblclick() 的第一次点击触发了导航事件，该方法会抛出异常。

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

备注

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

用法

await frame.dblclick(selector);
await frame.dblclick(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素满足选择器，将使用第一个。
options Object (可选)
- button "left" | "right" | "middle" (可选)#
  
  默认为 left。
- delay number (可选)#
  
  mousedown 和 mouseup 之间的等待时间（毫秒）。默认为 0。
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前按下的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- strict boolean (可选) v1.14 版本新增#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析为多个元素，调用会抛出异常。
- timeout number (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选) v1.11 版本新增#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作而不实际执行操作。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以便测试仅在按下这些键时才可见的元素。

返回值

Promise<void>#

dispatchEvent

v1.9 之前版本添加

frame.dispatchEvent

不推荐使用

建议改用基于定位器的 locator.dispatchEvent()。了解更多关于定位器的信息。

以下代码片段会在元素上派发 click 事件。无论元素是否可见，都会派发 click 事件。这相当于调用 element.click()。

用法

await frame.dispatchEvent('button#submit', 'click');

在底层实现中，它会根据给定的 type 创建事件实例，使用 eventInit 属性初始化该事件，并在元素上派发该事件。事件默认是 composed（可组合）、cancelable（可取消）且会冒泡的。

由于 eventInit 是事件特定的，请参考以下事件文档了解初始属性列表：

如果需要将动态对象传入事件，也可以指定 JSHandle 作为属性值：

// 注意：只能在 Chromium 和 Firefox 中创建 DataTransfer
const dataTransfer = await frame.evaluateHandle(() => new DataTransfer());
await frame.dispatchEvent('#source', 'dragstart', { dataTransfer });

参数

selector string #

用于查找元素的选择器。如果有多个元素匹配选择器，将使用第一个。
type string #

DOM 事件类型：如 "click"、"dragstart" 等。
eventInit EvaluationArgument (可选)#

可选的事件特定初始化属性。
options Object (可选)
- strict boolean (可选) v1.14 版本新增#
  
  当设置为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法修改。

返回值

Promise<void>#

fill

v1.9 版本前添加

frame.fill

不推荐使用

建议改用基于定位器的 locator.fill()。了解更多关于定位器的信息。

该方法会等待匹配 selector 的元素，执行可操作性检查，聚焦元素，填充内容并在填充后触发 input 事件。注意可以传入空字符串来清空输入框。

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

要发送精细的键盘事件，请使用 locator.pressSequentially()。

用法

await frame.fill(selector, value);
await frame.fill(selector, value, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素匹配选择器，将使用第一个。
value string #

要填充到 <input>、<textarea> 或 [contenteditable] 元素中的值。
options Object (可选)
- force boolean (可选) v1.13 版本添加#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- strict boolean (可选) v1.14 版本添加#
  
  当为 true 时，要求选择器必须解析为单个元素。如果选择器解析到多个元素，将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<void>#

focus

v1.9 之前添加

frame.focus

不推荐使用

建议改用基于定位器的 locator.focus()。了解更多关于定位器的信息。

该方法会查找匹配 selector 的元素并使其获得焦点。如果没有元素匹配 selector，该方法会等待直到匹配的元素出现在 DOM 中。

用法

await frame.focus(selector);
await frame.focus(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素满足选择器条件，则使用第一个匹配的元素。
options Object (可选)
- strict boolean (可选) v1.14 新增#
  
  当设置为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时限制。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<void>#

getAttribute

v1.9 版本前添加

frame.getAttribute

不推荐使用

建议改用基于定位器的 locator.getAttribute()。了解更多关于定位器的信息。

返回元素的属性值。

用法

await frame.getAttribute(selector, name);
await frame.getAttribute(selector, name, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素匹配选择器，将使用第一个元素。
name string #

要获取值的属性名称。
options Object (可选)
- strict boolean (可选) v1.14 版本添加#
  
  当为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 和 page.setDefaultTimeout() 方法设置。

返回值

Promise<null | string>#

hover

v1.9 之前添加

frame.hover

不推荐

建议改用基于定位器的 locator.hover()。了解更多关于定位器的信息。

该方法通过以下步骤悬停在匹配 selector 的元素上：

查找匹配 selector 的元素。如果没有找到，则等待直到匹配的元素附加到 DOM 中。
除非设置了 force 选项，否则等待对匹配元素进行可操作性检查。如果在检查期间元素被分离，则整个操作会重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 悬停在元素的中心位置或指定的 position。

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

用法

await frame.hover(selector);
await frame.hover(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前按下的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选) v1.28 新增#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- strict boolean (可选) v1.14 新增#
  
  当为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- timeout number (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选) v1.11 新增#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而不实际执行操作。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试仅在按下这些键时才可见的元素。

Promise<void>#

innerHTML

v1.9 之前版本添加

frame.innerHTML

不推荐使用

建议改用基于定位器的 locator.innerHTML()。了解更多关于定位器的信息。

返回 element.innerHTML。

用法

await frame.innerHTML(selector);
await frame.innerHTML(selector, options);

参数

selector string #

用于查找元素的 CSS 选择器。如果有多个元素匹配选择器，将使用第一个匹配的元素。
options Object (可选)
- strict boolean (可选) v1.14 版本添加#
  
  当设置为 true 时，要求选择器必须精确匹配一个元素。如果选择器匹配到多个元素，将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时限制。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<string>#

innerText

v1.9 版本前添加

frame.innerText

不推荐使用

建议改用基于定位器的 locator.innerText()。了解更多关于定位器的信息。

返回 element.innerText 的值。

用法

await frame.innerText(selector);
await frame.innerText(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素满足选择器条件，将使用第一个匹配的元素。
options Object (可选)
- strict boolean (可选) v1.14 版本添加#
  
  当设置为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时限制。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<string>#

inputValue

发布于: v1.13

frame.inputValue

不推荐使用

建议改用基于定位器的 locator.inputValue()。了解更多关于定位器的信息。

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

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

用法

await frame.inputValue(selector);
await frame.inputValue(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素匹配选择器，将使用第一个元素。
options Object (可选)
- strict boolean (可选) 发布于: v1.14#
  
  当设为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 和 page.setDefaultTimeout() 方法修改。

返回值

Promise<string>#

isChecked

v1.9 之前版本添加

frame.isChecked

不推荐使用

建议改用基于定位器的 locator.isChecked() 方法。了解更多关于定位器的信息。

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

用法

await frame.isChecked(selector);
await frame.isChecked(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素匹配选择器，将使用第一个元素。
options Object (可选)
- strict boolean (可选) v1.14 版本添加#
  
  当设置为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时限制。默认值可以通过配置中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<boolean>#

isDisabled

v1.9 之前版本添加

frame.isDisabled

不推荐使用

请改用基于定位器的 locator.isDisabled()。了解更多关于定位器的信息。

返回元素是否处于禁用状态，与 enabled 状态相反。

用法

await frame.isDisabled(selector);
await frame.isDisabled(selector, options);

参数

selector string #

用于查找元素的选择器。如果多个元素匹配该选择器，将使用第一个元素。
options Object (可选)
- strict boolean (可选) v1.14 版本新增#
  
  当设置为 true 时，要求选择器必须精确匹配一个元素。如果选择器匹配到多个元素，将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时限制。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<boolean>#

isEditable

v1.9 之前版本添加

frame.isEditable

不推荐使用

建议改用基于定位器的 locator.isEditable()。了解更多关于定位器的信息。

返回元素是否处于可编辑状态。

用法

await frame.isEditable(selector);
await frame.isEditable(selector, options);

参数

selector string #

用于查找元素的选择器。如果多个元素匹配该选择器，将使用第一个元素。
options Object (可选)
- strict boolean (可选) v1.14 版本新增#
  
  当设置为 true 时，要求选择器必须精确匹配一个元素。如果选择器匹配到多个元素，将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时限制。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<boolean>#

isHidden

v1.9 之前版本添加

frame.isHidden

不推荐使用

建议改用基于定位器的 locator.isHidden()。了解更多关于定位器的信息。

返回元素是否隐藏，与 visible 相反。不匹配任何元素的 selector 会被视为隐藏。

用法

await frame.isHidden(selector);
await frame.isHidden(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素满足选择器条件，将使用第一个元素。
options Object (可选)
- strict boolean (可选) v1.14 版本新增#
  
  当设置为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用将抛出异常。
- timeout number (可选)#
  
  已弃用
  此选项已被忽略。frame.isHidden() 不会等待元素变为隐藏状态，而是立即返回结果。

返回值

Promise<boolean>#

isVisible

v1.9 之前版本添加

frame.isVisible

不推荐使用

建议改用基于定位器的 locator.isVisible()。了解更多关于定位器的信息。

返回元素是否可见。不匹配任何元素的选择器会被视为不可见。

用法

await frame.isVisible(selector);
await frame.isVisible(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素满足选择器条件，将使用第一个匹配的元素。
options Object (可选)
- strict boolean (可选) v1.14 版本新增#
  
  当设置为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用将抛出异常。
- timeout number (可选)#
  
  已弃用
  此选项已被忽略。frame.isVisible() 不会等待元素变为可见状态，而是立即返回结果。

返回值

Promise<boolean>#

press

v1.9 版本前添加

frame.press

不推荐使用

请改用基于定位器的 locator.press() 方法。了解更多关于定位器的信息。

key 可以指定预期的 keyboardEvent.key 值或单个字符来生成文本。key 值的超集可以在此处找到。按键示例包括：

F1 - F12、Digit0- Digit9、KeyA- KeyZ、Backquote、Minus、Equal、Backslash、Backspace、Tab、Delete、Escape、ArrowDown、End、Enter、Home、Insert、PageDown、PageUp、ArrowRight、ArrowUp 等。

还支持以下修饰快捷键：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

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

如果 key 是单个字符，则区分大小写，因此值 a 和 A 将生成不同的对应文本。

还支持诸如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 等快捷键组合。当指定修饰键时，修饰键会被按下并保持，同时按下后续键。

用法

await frame.press(selector, key);
await frame.press(selector, key, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个元素。
key string #

要按下的键名或要生成的字符，例如 ArrowLeft 或 a。
options Object (可选)
- delay number (可选)#
  
  keydown 和 keyup 之间的等待时间（毫秒）。默认为 0。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项未来将默认为 true。
  
  触发导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志选择不等待。仅在特殊情况下（例如导航到不可访问的页面）才需要此选项。默认为 false。
- strict boolean (可选) v1.14 版本添加#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大超时时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<void>#

selectOption

v1.9 之前版本添加

frame.selectOption

不推荐使用

建议改用基于定位器的 locator.selectOption()。了解更多关于定位器的信息。

该方法会等待匹配 selector 的元素，执行可操作性检查，等待所有指定选项出现在 <select> 元素中，然后选择这些选项。

如果目标元素不是 <select> 元素，此方法会抛出错误。但如果元素位于具有关联控件的 <label> 元素内，则会使用该控件替代。

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

在所有提供的选项被选中后，会触发 change 和 input 事件。

用法

// 匹配值或标签的单选
frame.selectOption('select#colors', 'blue');

// 同时匹配值和标签的单选
frame.selectOption('select#colors', { label: 'Blue' });

// 多选
frame.selectOption('select#colors', 'red', 'green', 'blue');

参数

selector string #

要查询的选择器。
values null | string | ElementHandle | Array<string> | Object | Array<ElementHandle> | Array<Object>#
- value string (可选)
  
  通过 option.value 匹配。可选。
- label string (可选)
  
  通过 option.label 匹配。可选。
- index number (可选)
  
  通过索引匹配。可选。
要选择的选项。如果 <select> 具有 multiple 属性，则所有匹配的选项都会被选中，否则只选中第一个匹配的选项。字符串值会同时匹配值和标签。如果所有指定属性都匹配，则认为选项匹配。
options Object (可选)
- force boolean (可选) v1.13 版本添加#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- strict boolean (可选) v1.14 版本添加#
  
  为 true 时，要求选择器必须解析为单个元素。如果选择器解析为多个元素，则调用会抛出异常。
- timeout number (可选)#
  
  最大超时时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<Array<string>>#

setChecked

添加于: v1.15

frame.setChecked

不推荐使用

请改用基于定位器的 locator.setChecked() 方法。了解更多关于定位器的信息。

该方法通过以下步骤来勾选或取消勾选匹配 selector 的元素：

查找匹配 selector 的元素。如果不存在，则等待直到匹配的元素被附加到 DOM 中。
确保匹配的元素是复选框或单选按钮。如果不是，该方法会抛出异常。
如果元素已经处于正确的勾选状态，该方法会立即返回。
等待对匹配元素进行可操作性检查，除非设置了 force 选项。如果在检查期间元素被分离，整个操作会重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素的中心点。
确保元素现在已被勾选或取消勾选。如果没有，该方法会抛出异常。

如果所有步骤在指定的 timeout 时间内未完成，该方法会抛出 TimeoutError。传递零超时时间会禁用此功能。

用法

await frame.setChecked(selector, checked);
await frame.setChecked(selector, checked, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素匹配选择器，将使用第一个。
checked boolean #

是否勾选或取消勾选复选框。
options Object (可选)
- force boolean (可选)#
是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- strict boolean (可选)#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析为多个元素，调用会抛出异常。
- timeout number (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。
- trial boolean (可选)#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好执行操作而不实际执行它。

返回值

Promise<void>#

setInputFiles

v1.9 之前添加

frame.setInputFiles

不推荐使用

请改用基于定位器的 locator.setInputFiles()。了解更多关于定位器的信息。

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

此方法期望 selector 指向一个输入元素。但如果该元素位于具有关联控件的 <label> 元素内，则会改为定位该控件。

用法

await frame.setInputFiles(selector, files);
await frame.setInputFiles(selector, files, options);

参数

selector [字符串]#

用于搜索元素的选择器。如果有多个元素满足选择器条件，将使用第一个元素。
files [字符串] | [数组]<[字符串]> | [对象] | [数组]<[对象]>#
- name [字符串]
  
  文件名
- mimeType [字符串]
  
  文件类型
- buffer Buffer
  
  文件内容
options [对象] (可选)
- noWaitAfter [布尔值] (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- strict [布尔值] (可选) v1.14 新增#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。
- timeout [数字] (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法修改。

返回值

Promise<void>#

tap

v1.9 之前添加

frame.tap

不推荐使用

建议改用基于定位器的 locator.tap()。了解更多关于定位器的信息。

该方法通过以下步骤点击匹配 selector 的元素：

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

如果所有步骤在指定的 timeout 内未完成，该方法会抛出 TimeoutError。传递零超时值将禁用此功能。

备注

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

用法

await frame.tap(selector);
await frame.tap(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前按下的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- strict boolean (可选) v1.14 新增#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选) v1.11 新增#
  
  当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为 false。可用于等待元素准备好进行操作而不实际执行操作。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以便测试仅在按下这些键时才可见的元素。

返回值

Promise<void>#

textContent

v1.9 版本前添加

frame.textContent

不推荐使用

建议改用基于定位器的 locator.textContent()。了解更多关于定位器的信息。

返回 element.textContent。

用法

await frame.textContent(selector);
await frame.textContent(selector, options);

参数

selector string #

用于查找元素的选择器。如果有多个元素匹配选择器，将使用第一个元素。
options Object (可选)
- strict boolean (可选) v1.14 版本添加#
  
  当为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时限制。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 和 page.setDefaultTimeout() 方法设置。

返回值

Promise<null | string>#

type

v1.9 之前添加

frame.type

已弃用

在大多数情况下，你应该使用 locator.fill() 替代。只有当页面有特殊键盘处理时，才需要逐个按键 - 这种情况下请使用 locator.pressSequentially()。

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

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

用法

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器条件，将使用第一个。
text string #

要输入到已聚焦元素中的文本。
options Object (可选)
- delay number (可选)#
  
  按键之间的等待时间（毫秒）。默认为 0。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- strict boolean (可选) v1.14 新增#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法修改。

Promise<void>#

uncheck

v1.9 之前添加

frame.uncheck

不推荐使用

请改用基于定位器的 locator.uncheck()。了解更多关于定位器的信息。

该方法通过以下步骤取消选中匹配 selector 的元素：

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

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

用法

await frame.uncheck(selector);
await frame.uncheck(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则使用第一个。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选) v1.11 新增#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- strict boolean (可选) v1.14 新增#
  
  当为 true 时，要求选择器必须解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- timeout number (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。
- trial boolean (可选) v1.11 新增#
  
  设置时，该方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作而不实际执行操作。

Promise<void>#

v1.9 版本前添加

frame.waitForNavigation

已弃用

此方法本质上存在竞态条件问题，请改用 frame.waitForURL()。

等待框架导航完成并返回主资源响应。对于多次重定向的情况，导航将返回最后一次重定向的响应。如果是导航到不同锚点或由于 History API 使用导致的导航，将返回 null。

用法

此方法等待框架导航到新 URL。适用于运行会间接导致框架导航的代码时使用。参考以下示例：

// 在点击前开始等待导航。注意此处没有 await。
const navigationPromise = page.waitForNavigation();
await page.getByText('Navigate after timeout').click();
await navigationPromise;

备注

使用 History API 改变 URL 的行为被视为导航。

参数

options Object (可选)
- timeout number (可选)#
  
  最大操作时间（毫秒）。默认为 0 - 无超时。默认值可通过配置文件中的 navigationTimeout 选项修改，或使用 browserContext.setDefaultNavigationTimeout()、browserContext.setDefaultTimeout()、page.setDefaultNavigationTimeout() 或 page.setDefaultTimeout() 方法设置。
- url string | RegExp | function(URL):boolean (可选)#
  
  用于匹配等待导航的 URL 的全局模式、正则表达式或谓词函数。注意如果参数是不含通配符的字符串，方法将等待导航到完全匹配该字符串的 URL。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#
  
  何时认为操作成功，默认为 load。可选事件包括：
  - 'domcontentloaded' - 当触发 DOMContentLoaded 事件时认为操作完成。
  - 'load' - 当触发 load 事件时认为操作完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒没有网络连接时认为操作完成。不要将此方法用于测试，应改用 web 断言来评估准备状态。
  - 'commit' - 当收到网络响应且文档开始加载时认为操作完成。

返回值

Promise<null | Response>#

waitForSelector

v1.9 之前添加

frame.waitForSelector

不推荐使用

建议改用断言可见性的 web 断言或基于定位器的 locator.waitFor()。了解更多关于定位器的信息。

当指定选择器对应的元素满足 state 选项时返回。如果等待的是 hidden 或 detached 状态则返回 null。

备注

Playwright 在执行操作前会自动等待元素准备就绪。使用 Locator 对象和 web 优先断言可以让代码无需使用 wait-for-selector。

等待 selector 满足 state 选项（在 DOM 中出现/消失，或变为可见/隐藏）。如果在调用方法时 selector 已经满足条件，该方法会立即返回。如果选择器在 timeout 毫秒内未满足条件，函数会抛出异常。

用法

此方法在页面导航时仍然有效：

const { chromium } = require('playwright');  // 或 'firefox' 或 'webkit'.

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  for (const currentURL of ['https://google.com', 'https://bbc.com']) {
    await page.goto(currentURL);
    const element = await page.mainFrame().waitForSelector('img');
    console.log('Loaded image: ' + await element.getAttribute('src'));
  }
  await browser.close();
})();

参数

selector string #

要查询的选择器。
options Object (可选)
- state "attached" | "detached" | "visible" | "hidden" (可选)#
  
  默认为 'visible'。可选值：
  - 'attached' - 等待元素存在于 DOM 中。
  - 'detached' - 等待元素不在 DOM 中。
  - 'visible' - 等待元素具有非空边界框且没有 visibility:hidden。注意：没有任何内容或 display:none 的元素具有空边界框，不被视为可见。
  - 'hidden' - 等待元素从 DOM 中分离，或具有空边界框或 visibility:hidden。这与 'visible' 选项相反。
- strict boolean (可选) v1.14 新增#
  
  为 true 时，要求选择器必须解析为单个元素。如果选择器解析出多个元素，调用会抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<null | ElementHandle>#

waitForTimeout

v1.9 之前添加

frame.waitForTimeout

不推荐

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

等待指定的毫秒级超时时间。

请注意 frame.waitForTimeout() 仅应用于调试目的。在生产测试中使用计时器会导致测试不稳定。应改用网络事件、选择器可见性等信号作为等待条件。

用法

await frame.waitForTimeout(timeout);

参数

timeout number #

需要等待的超时时间（毫秒）

返回值

Promise<void>#

方法​

addScriptTag​

addStyleTag​

childFrames​

content​

dragAndDrop​

evaluate​

evaluateHandle​

frameElement​

frameLocator​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

goto​

isDetached​

isEnabled​

locator​

name​

page​

parentFrame​

setContent​

title​

url​

waitForFunction​

waitForLoadState​

waitForURL​

已弃用​

$​

$$​

$eval​

$$eval​

check​

click​

dblclick​

dispatchEvent​

fill​

focus​

getAttribute​

hover​

innerHTML​

innerText​

inputValue​

isChecked​

isDisabled​

isEditable​

isHidden​

isVisible​

press​

selectOption​

setChecked​

setInputFiles​

tap​

textContent​

type​

uncheck​

waitForNavigation​

waitForSelector​

waitForTimeout​

方法

addScriptTag

addStyleTag

childFrames

content

dragAndDrop

evaluate

evaluateHandle

frameElement

frameLocator

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

goto

isDetached

isEnabled

locator

name

page

parentFrame

setContent

title

url

waitForFunction

waitForLoadState

waitForURL

已弃用

$

$$

$eval

$$eval

check

click

dblclick

dispatchEvent

fill

focus

getAttribute

hover

innerHTML

innerText

inputValue

isChecked

isDisabled

isEditable

isHidden

isVisible

press

selectOption

setChecked

setInputFiles

tap

textContent

type

uncheck

waitForNavigation

waitForSelector

waitForTimeout