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

v1.9 之前添加

frame.addScriptTag

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

将带有所需 url 或内容的 <script> 标签添加到页面中。

用法

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

v1.9 之前添加

frame.addStyleTag

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

将带有所需 url 的 <link rel="stylesheet"> 标签或带有内容的 <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

v1.9 之前添加

frame.childFrames

用法

frame.childFrames();

Array<Frame>#

content

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 (可选)#
  
  是否绕过可操作性检查。默认为 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 (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 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); // 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

v1.9 之前添加

frame.evaluateHandle

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

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

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="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 属性。

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

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

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 无效。
导航期间 timeout 超时。
远程服务器无响应或不可达。
主资源加载失败。

当远程服务器返回任何有效的 HTTP 状态码时，该方法不会抛出错误，包括 404 "未找到" 和 500 "内部服务器错误"。此类响应的状态码可以通过调用 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

如果框架已分离，则返回 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 (可选)#
  
  将方法的结果缩小到那些包含与此相对定位器匹配的元素的元素。例如，具有 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

v1.9 之前添加

frame.name

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

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

注意

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

用法

frame.name();

string #

page

v1.9 之前添加

frame.page

返回包含此框架的页面。

用法

frame.page();

Page #

parentFrame

v1.9 之前添加

frame.parentFrame

父框架，如果有的话。分离的框架和主框架返回 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');  // 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

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 #

全局模式、正则表达式模式或接收 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()。了解更多关于定位器的信息。

返回指向框架元素的 ElementHandles。

注意

不鼓励使用 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

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()。了解更多关于定位器的信息。

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

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

当所有步骤在指定的 timeout 内未完成时，此方法将抛出 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()。了解更多关于定位器的信息。

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

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

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

注意

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

用法

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

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Object (可选)
- button "left" | "right" | "middle" (可选)#
  
  默认为 left。
- delay 数字 (可选)#
  
  mousedown 和 mouseup 之间等待的毫秒数。默认为 0。
- force 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 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。在不执行操作的情况下等待元素准备好进行操作时很有用。请注意，无论 trial 如何，都会按下键盘 modifiers 以允许测试仅在按下这些键时才可见的元素。

Promise<void>#

dispatchEvent

v1.9 之前添加

frame.dispatchEvent

不推荐

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

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

用法

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

在底层，它根据给定的类型创建一个事件实例，用 eventInit 属性初始化它，并在元素上分派它。事件默认是 composed、cancelable 和冒泡的。

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

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
type 字符串 #

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

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

Promise<void>#

fill

v1.9 之前添加

frame.fill

不推荐

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

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

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

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

用法

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

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
value 字符串 #

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

Promise<void>#

focus

v1.9 之前添加

frame.focus

不推荐

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

此方法获取匹配选择器的元素并将其聚焦。如果没有匹配选择器的元素，此方法将等待直到 DOM 中出现匹配元素。

用法

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

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Object (可选)
- strict boolean (可选)添加于: v1.14#
  
  如果为 true，则调用要求选取器解析为单个元素。如果给定选取器解析为多个元素，则调用会抛出异常。
- timeout 数字 (可选)#
  
  最大时间（毫秒）。默认为 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 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
name 字符串 #

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

Promise<null | 字符串>#

hover

v1.9 之前添加

frame.hover

不推荐

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

此方法通过执行以下步骤悬停在匹配选择器的元素上：

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

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

用法

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

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Object (可选)
- force 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 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。在不执行操作的情况下等待元素准备好进行操作时很有用。请注意，无论 trial 如何，都会按下键盘 modifiers 以允许测试仅在按下这些键时才可见的元素。

Promise<void>#

innerHTML

v1.9 之前添加

frame.innerHTML

不推荐

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

返回 element.innerHTML。

用法

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

参数

selector 字符串 #

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

Promise<字符串>#

innerText

v1.9 之前添加

frame.innerText

不推荐

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

返回 element.innerText。

用法

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

参数

selector 字符串 #

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

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

用法

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

参数

selector 字符串 #

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

Promise<字符串>#

isChecked

v1.9 之前添加

frame.isChecked

不推荐

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

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

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

isDisabled

v1.9 之前添加

frame.isDisabled

不推荐

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

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

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

isEditable

v1.9 之前添加

frame.isEditable

不推荐

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

返回元素是否可编辑。

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

isHidden

v1.9 之前添加

frame.isHidden

不推荐

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

返回元素是否隐藏，与可见相反。选择器未匹配任何元素被视为隐藏。

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

isVisible

v1.9 之前添加

frame.isVisible

不推荐

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

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

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

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

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

v1.9 之前添加

frame.selectOption

不推荐

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

此方法等待匹配选择器的元素，等待可操作性检查，等待所有指定的选项都存在于 <select> 元素中，然后选择这些选项。

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

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

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

用法

// Single selection matching the value or label
frame.selectOption('select#colors', 'blue');

// single selection matching both the value and the label
frame.selectOption('select#colors', { label: 'Blue' });

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

参数

selector 字符串 #

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

Promise<数组<字符串>>#

setChecked

添加于：v1.15

frame.setChecked

不推荐

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

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

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

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

用法

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

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
checked 布尔值 #

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

Promise<void>#

setInputFiles

v1.9 之前添加

frame.setInputFiles

不推荐

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

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

此方法要求选择器指向一个输入元素。但是，如果元素位于具有关联控件的 <label> 元素内，则会改为针对该控件。

用法

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

参数

selector 字符串 #

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

Promise<void>#

tap

v1.9 之前添加

frame.tap

不推荐

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

此方法通过执行以下步骤轻触匹配选择器的元素：

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

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

注意

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

用法

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

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Object (可选)
- force 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 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。在不执行操作的情况下等待元素准备好进行操作时很有用。请注意，无论 trial 如何，都会按下键盘 modifiers 以允许测试仅在按下这些键时才可见的元素。

Promise<void>#

textContent

v1.9 之前添加

frame.textContent

不推荐

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

返回 element.textContent。

用法

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

参数

selector 字符串 #

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

Promise<null | 字符串>#

type

v1.9 之前添加

frame.type

已弃用

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

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

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

用法

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
text 字符串 #

要键入到焦点元素中的文本。
options Object (可选)
- delay 数字 (可选)#
  
  两次按键之间等待的毫秒数。默认为 0。
- noWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- strict boolean (可选)添加于: v1.14#
  
  如果为 true，则调用要求选取器解析为单个元素。如果给定选取器解析为多个元素，则调用会抛出异常。
- timeout 数字 (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

uncheck

v1.9 之前添加

frame.uncheck

不推荐

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

此方法通过执行以下步骤取消选中匹配选择器的元素：

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

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

用法

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

参数

selector 字符串 #

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

Promise<void>#

v1.9 之前添加

frame.waitForNavigation

已弃用

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

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

用法

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

// 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 数字 (可选)#
  
  最大操作时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 navigationTimeout 选项更改，或通过使用 browserContext.setDefaultNavigationTimeout()、browserContext.setDefaultTimeout()、page.setDefaultNavigationTimeout() 或 page.setDefaultTimeout() 方法更改。
- url 字符串 | RegExp | 函数(URL):布尔值 (可选)#
  
  全局模式、正则表达式模式或接收 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-first 断言可以使代码摆脱 wait-for-selector。

等待选择器满足 state 选项（从 DOM 中出现/消失，或变为可见/隐藏）。如果在调用方法时选择器已经满足条件，该方法将立即返回。如果选择器在 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 字符串 #

要查询的选取器。
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 数字 (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<null | ElementHandle>#

waitForTimeout

v1.9 之前添加

frame.waitForTimeout

不推荐

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

等待给定的超时毫秒数。

请注意，frame.waitForTimeout() 只能用于调试。在生产环境中使用计时器的测试将会不稳定。请改用网络事件、选择器变为可见等信号。

用法

await frame.waitForTimeout(timeout);

参数

timeout 数字 #

要等待的超时时间。

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