Frame

在每个时间点，页面都通过 page.mainFrame() 和 frame.childFrames() 方法公开其当前帧树。

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

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

帧树示例

const { firefox } = require('playwright');  // Or 'chromium' or '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

Added before v1.9

frame.addScriptTag

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

将 <script> 标签添加到页面中，其中包含所需的 url 或内容。

用法

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

参数

options Object (可选)
- content string (可选)#
  
  要注入到帧中的原始 JavaScript 内容。
- path string (可选)#
  
  要注入到帧中的 JavaScript 文件的路径。如果 path 是相对路径，则它相对于当前工作目录解析。
- type string (可选)#
  
  脚本类型。使用 'module' 以加载 JavaScript ES6 模块。有关更多详细信息，请参阅 script。
- url string (可选)#
  
  要添加的脚本的 URL。

返回值

Promise<ElementHandle>#

addStyleTag

Added before v1.9

frame.addStyleTag

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

将 <link rel="stylesheet"> 标签添加到页面中，其中包含所需的 url，或者将包含内容的 <style type="text/css"> 标签添加到页面中。

用法

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

参数

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

返回值

Promise<ElementHandle>#

childFrames

Added before v1.9

frame.childFrames

用法

frame.childFrames();

返回值

Array<Frame>#

content

Added before v1.9

frame.content

获取帧的完整 HTML 内容，包括 doctype。

用法

await frame.content();

返回值

Promise<string>#

dragAndDrop

新增于: v1.13

frame.dragAndDrop

用法

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

参数

source string #

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

用于搜索要拖放到的元素的选择器。如果有多个元素满足选择器，则将使用第一个。
options Object (可选)
- force boolean (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- sourcePosition Object (可选)新增于: v1.14#
  - x number
  - y number
  单击源元素上相对于元素内边距框左上角的这个点。如果未指定，则使用元素的某个可见点。
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- targetPosition Object (可选)新增于: v1.14#
  - x number
  - y number
  在目标元素上相对于元素内边距框左上角的这个点上放置。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。
- trial boolean (可选)#
  
  设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待元素准备好进行操作而无需执行它。

返回值

Promise<void>#

evaluate

Added before 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); // prints "56"

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

console.log(await frame.evaluate('1 + 2')); // prints "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

Added before v1.9

frame.evaluateHandle

以 JSHandle 形式返回 pageFunction 的返回值。

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

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

用法

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

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

const aHandle = await frame.evaluateHandle('document'); // Handle for the '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 或 iframe 元素句柄。

这是 elementHandle.contentFrame() 的反向操作。请注意，返回的句柄实际上属于父帧。

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

用法

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

返回值

Promise<ElementHandle>#

frameLocator

新增于: v1.17

frame.frameLocator

当使用 iframe 时，您可以创建一个帧定位器，它将进入 iframe 并允许在该 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 属性定位输入元素。

用法

例如，此方法将在以下 DOM 中通过标签“Username”和“Password”查找输入

<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="[email protected]" />

您可以在通过占位符文本定位输入后填充它

await page
    .getByPlaceholder('[email protected]')
    .fill('[email protected]');

参数

text string | RegExp #

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

返回值

Locator #

getByRole

新增于: v1.27

frame.getByRole

允许通过元素的 ARIA role、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 属性。

// Set custom test id attribute from @playwright/test config:
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>

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

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

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

// Matches second <div>
page.getByText('Hello', { exact: true });

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

// Matches second <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

Added before v1.9

frame.goto

返回主资源响应。如果发生多次重定向，导航将使用最后一次重定向的响应来解决。

如果发生以下情况，此方法将抛出错误：

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

当远程服务器返回任何有效的 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 应包含 scheme（例如 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

Added before v1.9

frame.isDetached

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

用法

frame.isDetached();

返回值

boolean #

isEnabled

Added before v1.9

frame.isEnabled

返回元素是否为启用状态。

用法

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

参数

selector string #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
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 (可选)#
  
  将方法的搜索结果缩小到包含与此相对定位器匹配的元素的那些结果。例如，包含 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。
  
  内部定位器**必须相对于**外部定位器，并且从外部定位器匹配项开始查询，而不是从文档根目录开始查询。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将会失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator。
- hasNot Locator (可选)添加于: v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器查询的。例如，不包含 div 的 article 匹配 <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

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

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

注意

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

用法

frame.name();

返回值

string #

page

Added before v1.9

frame.page

返回包含此框架的页面。

用法

frame.page();

返回值

Page #

parentFrame

Added before v1.9

frame.parentFrame

父框架（如果有）。分离的框架和主框架返回 null。

用法

frame.parentFrame();

返回值

null | Frame #

setContent

Added before 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

Added before v1.9

frame.title

返回页面标题。

用法

await frame.title();

返回值

Promise<string>#

url

Added before v1.9

frame.url

返回框架的 URL。

用法

frame.url();

返回值

string #

waitForFunction

Added before v1.9

frame.waitForFunction

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

用法

frame.waitForFunction() 可用于观察视口大小的变化

const { firefox } = require('playwright');  // Or 'chromium' or '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

Added before v1.9

frame.waitForLoadState

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

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

注意

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

用法

await frame.click('button'); // Click triggers navigation.
await frame.waitForLoadState(); // Waits for 'load' state by default.

参数

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

等待框架导航到给定的 URL。

用法

await frame.click('a.delayed-navigation'); // Clicking the link will indirectly cause a 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-first 断言。

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

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

注意

不鼓励使用 ElementHandle，请改用 Locator 对象。

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

用法

await frame.$$(selector);

参数

selector string #

要查询的选择器。

返回值

Promise<Array<ElementHandle>>#

$eval

添加于: v1.9

frame.$eval

不推荐使用

此方法不等待元素通过可操作性检查，因此可能导致测试不稳定。请改用 locator.evaluate()、其他 Locator 辅助方法或 web-first 断言。

返回 pageFunction 的返回值。

该方法在框架内查找与指定选择器匹配的元素，并将其作为第一个参数传递给 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 的返回值。

该方法在框架内查找与指定选择器匹配的所有元素，并将匹配元素的数组作为第一个参数传递给 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

Added before 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 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- force boolean (可选)#
  
  是否绕过 actionability 检查。默认为 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#
  
  设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待元素准备好进行操作而无需执行它。

返回值

Promise<void>#

click

Added before v1.9

frame.click

不推荐使用

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

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

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

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

用法

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

参数

selector 字符串 #

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

返回值

Promise<void>#

dblclick

Added before v1.9

frame.dblclick

不推荐使用

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

此方法通过执行以下步骤，双击与 selector 匹配的元素

查找与 selector 匹配的元素。如果不存在，则等待直到匹配的元素附加到 DOM。
等待对匹配元素进行可操作性检查，除非设置了 force 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 在元素的中心或指定的 position 中双击。如果 dblclick() 的第一次点击触发了导航事件，则此方法将抛出错误。

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

注意

frame.dblclick() 触发两次 click 事件和一个 dblclick 事件。

用法

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

参数

selector 字符串 #

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

返回值

Promise<void>#

dispatchEvent

Added before v1.9

frame.dispatchEvent

不推荐使用

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

以下代码片段在元素上触发 click 事件。无论元素的可见性状态如何，都会触发 click 事件。这等效于调用 element.click()。

用法

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

在底层，它基于给定的 type 创建一个事件实例，使用 eventInit 属性初始化它，并在元素上触发它。事件默认是 composed、cancelable 和 bubble 的。

由于 eventInit 是事件特定的，请参考事件文档以获取初始属性列表

如果您希望将实时对象传递到事件中，您还可以将 JSHandle 指定为属性值

// Note you can only create DataTransfer in Chromium and Firefox
const dataTransfer = await frame.evaluateHandle(() => new DataTransfer());
await frame.dispatchEvent('#source', 'dragstart', { dataTransfer });

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
type 字符串 #

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

可选的事件特定初始化属性。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<void>#

fill

Added before v1.9

frame.fill

不推荐使用

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

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

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，则此方法将抛出一个错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则将改为填充该 control。

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

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
value 字符串 #

要为 <input>、<textarea> 或 [contenteditable] 元素填充的值。
options Object (可选)
- force 布尔值 (可选)新增于: v1.13#
  
  是否绕过 actionability 检查。默认为 false。
- noWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<void>#

focus

Added before v1.9

frame.focus

不推荐使用

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

此方法获取与 selector 匹配的元素并聚焦它。如果不存在与 selector 匹配的元素，则该方法将等待直到匹配的元素出现在 DOM 中。

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<void>#

getAttribute

Added before v1.9

frame.getAttribute

不推荐使用

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

返回元素属性值。

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
name 字符串 #

要获取值的属性名称。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<null | 字符串>#

hover

Added before v1.9

frame.hover

不推荐使用

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

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

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

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

用法

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

参数

selector 字符串 #

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

返回值

Promise<void>#

innerHTML

Added before v1.9

frame.innerHTML

不推荐使用

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

返回 element.innerHTML。

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<字符串>#

innerText

Added before v1.9

frame.innerText

不推荐使用

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

返回 element.innerText。

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<字符串>#

inputValue

新增于: v1.13

frame.inputValue

不推荐使用

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

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

对于非输入元素会抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则返回该 control 的值。

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<字符串>#

isChecked

Added before v1.9

frame.isChecked

不推荐使用

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

返回元素是否被选中。如果元素不是复选框或单选按钮输入，则抛出错误。

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<布尔值>#

isDisabled

Added before v1.9

frame.isDisabled

不推荐使用

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

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

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<布尔值>#

isEditable

Added before v1.9

frame.isEditable

不推荐使用

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

返回元素是否可编辑。

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<布尔值>#

isHidden

Added before v1.9

frame.isHidden

不推荐使用

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

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

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  已弃用
  此选项将被忽略。frame.isHidden() 不会等待元素变为隐藏，并立即返回。

返回值

Promise<布尔值>#

isVisible

Added before v1.9

frame.isVisible

不推荐使用

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

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

用法

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

参数

selector 字符串 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout 数字 (可选)#
  
  已弃用
  此选项将被忽略。frame.isVisible() 不会等待元素变为可见，并立即返回。

返回值

Promise<布尔值>#

press

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

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
key 字符串 #

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

返回值

Promise<void>#

selectOption

Added before v1.9

frame.selectOption

不推荐使用

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

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

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

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

一旦所有提供的选项都被选择，则触发 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', { label: 'Blue' });

// multiple selection
frame.selectOption('select#colors', 'red', 'green', 'blue');

参数

selector 字符串 #

要查询的选择器。
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 布尔值 (可选)新增于: v1.13#
  
  是否绕过 actionability 检查。默认为 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 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
checked boolean #

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

返回值

Promise<void>#

setInputFiles

Added before v1.9

frame.setInputFiles

不推荐使用

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

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

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

用法

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

参数

selector string #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
files string | Array<string> | Object | Array<Object>#
- name string
  
  文件名
- mimeType string
  
  文件类型
- buffer Buffer
  
  文件内容
options Object (可选)
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout number (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<void>#

tap

Added before 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 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- force boolean (可选)#
  
  是否绕过 actionability 检查。默认为 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。用于等待直到元素准备好执行操作，但不执行它。请注意，键盘 modifiers 将始终被按下，无论 trial 的值如何，以允许测试仅在按下这些键时才可见的元素。

返回值

Promise<void>#

textContent

Added before v1.9

frame.textContent

不推荐使用

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

返回 element.textContent。

用法

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

参数

selector string #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- strict boolean (可选)新增于: v1.14#
  
  当为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- timeout number (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

返回值

Promise<null | string>#

type

Added before v1.9

frame.type

已弃用

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

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

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

用法

参数

selector string #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
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

Added before 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 #

用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素，则将使用第一个元素。
options Object (可选)
- force boolean (可选)#
  
  是否绕过 actionability 检查。默认为 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#
  
  设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于等待元素准备好进行操作而无需执行它。

返回值

Promise<void>#

Added before v1.9

frame.waitForNavigation

已弃用

此方法本质上是存在竞争条件的，请使用 frame.waitForURL() 代替。

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

用法

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

// Start waiting for navigation before clicking. Note no 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 (可选)#
  
  在等待导航时要匹配的 glob 模式、正则表达式模式或谓词，用于接收 URL。请注意，如果参数是不带通配符的字符串，则该方法将等待导航到与该字符串完全相同的 URL。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#
  
  何时认为操作成功，默认为 load。事件可以是：
  - 'domcontentloaded' - 当 DOMContentLoaded 事件被触发时，认为操作已完成。
  - 'load' - 当 load 事件被触发时，认为操作已完成。
  - 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作已完成。请勿将此方法用于测试，而应依靠 Web 断言来评估就绪状态。
  - 'commit' - 当收到网络响应并且文档开始加载时，认为操作已完成。

返回值

Promise<null | Response>#

waitForSelector

Added before v1.9

frame.waitForSelector

不推荐使用

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

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

注意

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

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

用法

此方法跨导航工作

const { chromium } = require('playwright');  // Or 'firefox' or '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

Added before v1.9

frame.waitForTimeout

不推荐使用

永远不要在生产环境等待超时。等待时间的测试本质上是不稳定的。请使用 Locator 操作和自动等待的 Web 断言。

等待给定的 timeout 毫秒数。

请注意，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