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

Frame 对象的生命周期由三个事件控制，这些事件在页面对象上分发：

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

转储框架树的一个示例：

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​

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

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

用法

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

参数

• options Object (optional)

  • content string (可选)#

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

  • path string (可选)#

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

  • type string (可选)#

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

  • url string (可选)#

    要添加的脚本的URL。

返回

• Promise<ElementHandle>#

addStyleTag​

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

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

用法

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

参数

• options Object (optional)

  • content string (可选)#

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

  • path string (可选)#

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

  • url string (可选)#

    标签的URL地址。

返回

• Promise<ElementHandle>#

子框架​

用法

frame.childFrames();

返回

• Array<Frame>#

内容​

Gets the full HTML contents of the frame, including the doctype.

用法

await frame.content();

返回

• Promise<string>#

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

评估​

返回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​

将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​

返回与此框架对应的frame或iframe元素句柄。

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

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

用法

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

返回

• Promise<ElementHandle>#

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​

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

用法

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

<img alt='Playwright logo'>

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

参数

• text string | RegExp#

  用于定位元素的文本。

• options Object (可选)

  • exact boolean (可选)#

    是否查找完全匹配：区分大小写且全字符串匹配。默认为false。使用正则表达式定位时忽略此选项。请注意完全匹配仍会修剪空白字符。

返回

• 定位器#

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。使用正则表达式定位时忽略此选项。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

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。当使用正则表达式定位时会被忽略。请注意完全匹配仍会修剪空白字符。

返回

• 定位器#

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或原生控件设置的属性。

    了解更多关于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等角色中，对于

    -

    元素有默认值。

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

  • name string | RegExp (可选)#

    用于匹配accessible name的选项。默认情况下匹配不区分大小写并搜索子字符串，使用exact来控制此行为。

    了解更多关于accessible name的信息。

  • pressed boolean (可选)#

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

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

  • selected boolean (可选)#

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

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

返回

• 定位器#

详情

角色选择器不能替代无障碍审计和合规性测试，而是提供关于ARIA指南的早期反馈。

Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

getByTestId​

通过测试ID定位元素。

用法

考虑以下DOM结构。

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

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

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

参数

• testId string | RegExp#

  用于定位元素的ID。

返回

• 定位器#

详情

默认情况下，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​

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

另请参阅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。使用正则表达式定位时忽略此选项。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

详情

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

类型为button和submit的输入元素是通过它们的value值而非文本内容来匹配的。例如，通过文本"Log in"定位会匹配到<input type=button value="Log in">。

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。使用正则表达式定位时忽略此选项。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

前往​

返回主资源响应。在多次重定向的情况下，导航将解析为最后一次重定向的响应。

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

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

当远程服务器返回任何有效的HTTP状态码时，该方法不会抛出错误，包括404"未找到"和500"内部服务器错误"。可以通过调用response.status()来获取此类响应的状态码。

用法

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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• Promise<null | Response>#

isDetached​

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

用法

frame.isDetached();

返回

• boolean#

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

定位器​

该方法返回一个元素定位器，可用于在此页面/框架上执行操作。定位器在执行操作前会立即解析为对应元素，因此同一定位器上的一系列操作实际上可能作用于不同的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时，会匹配

    Playwright
    。

    请注意外部和内部定位器必须属于同一个框架。内部定位器不能包含FrameLocator。

  • hasNotText string | RegExp (可选) 添加于: v1.33#

    匹配内部某处不包含指定文本的元素，可能在子元素或后代元素中。当传入string时，匹配不区分大小写并搜索子字符串。

  • hasText string | RegExp (可选)#

    匹配内部某处包含指定文本的元素，可能在子元素或后代元素中。当传入string时，匹配不区分大小写并搜索子字符串。例如，"Playwright"会匹配

    Playwright
    。

返回

• 定位器#

名称​

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

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

用法

frame.name();

返回

• string#

页面​

返回包含此框架的页面。

用法

frame.page();

返回

• 页面#

parentFrame​

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

用法

frame.parentFrame();

返回

• null | Frame#

setContent​

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

用法

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

参数

• html string#

  HTML markup to assign to the page.

• 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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• Promise<void>#

标题​

返回页面标题。

用法

await frame.title();

返回

• Promise<string>#

网址​

返回框架的URL。

用法

frame.url();

返回

• string#

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​

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

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

用法

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​

等待框架导航到给定的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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• Promise<void>#

已弃用​

$​

返回指向框架元素的ElementHandle。

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

用法

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

参数

• selector string#

  用于查询的选择器。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

返回

• Promise<null | ElementHandle>#

$$​

返回指向框架元素的ElementHandles。

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

用法

await frame.$$(selector);

参数

• selector string#

  用于查询的选择器。

返回

• Promise<Array<ElementHandle>>#

$eval​

返回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​

返回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>#

检查​

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

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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>#

点击​

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

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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>#

双击​

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

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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​

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

用法

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

在底层实现中，它会根据给定的type创建一个事件实例，使用eventInit属性进行初始化，并在元素上派发该事件。默认情况下，事件是composed、cancelable且支持冒泡的。

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

• DeviceMotionEvent
• DeviceOrientationEvent
• DragEvent
• 事件
• FocusEvent
• KeyboardEvent
• MouseEvent
• PointerEvent
• TouchEvent
• WheelEvent

如果希望将实时对象传递到事件中，您也可以将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 string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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​

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

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• value string#

  要为、或[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​

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    最大时间，单位为毫秒。默认为 0 - 表示无超时限制。默认值可以通过配置文件中的 actionTimeout 选项进行修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法进行设置。

返回

• Promise<void>#

getAttribute​

返回元素的属性值。

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• name string#

  要获取值的属性名称。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    最大时间，单位为毫秒。默认为 0 - 表示无超时限制。默认值可以通过配置文件中的 actionTimeout 选项进行修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法进行设置。

返回

• Promise<null | string>#

悬停​

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

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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​

Returns 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​

返回 element.innerText。

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    最大时间，单位为毫秒。默认为 0 - 表示无超时限制。默认值可以通过配置文件中的 actionTimeout 选项进行修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法进行设置。

返回

• Promise<string>#

inputValue​

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    最大时间，单位为毫秒。默认为 0 - 表示无超时限制。默认值可以通过配置文件中的 actionTimeout 选项进行修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法进行设置。

返回

• Promise<string>#

isChecked​

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    最大时间，单位为毫秒。默认为 0 - 表示无超时限制。默认值可以通过配置文件中的 actionTimeout 选项进行修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法进行设置。

返回

• Promise<boolean>#

isDisabled​

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    最大时间，单位为毫秒。默认为 0 - 表示无超时限制。默认值可以通过配置文件中的 actionTimeout 选项进行修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法进行设置。

返回

• Promise<boolean>#

isEditable​

返回该元素是否可编辑。

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    最大时间，单位为毫秒。默认为 0 - 表示无超时限制。默认值可以通过配置文件中的 actionTimeout 选项进行修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法进行设置。

返回

• Promise<boolean>#

isHidden​

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    已弃用

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

返回

• Promise<boolean>#

isVisible​

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• options Object (可选)

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

    当为true时，要求选择器必须解析为单个元素。如果给定的选择器解析出多个元素，调用将抛出异常。

  • timeout number (可选)#

    已弃用

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

返回

• Promise<boolean>#

按下​

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#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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​

该方法等待匹配selector的元素，等待actionability可操作性检查，直到<select>元素中出现所有指定选项并选择这些选项。

如果目标元素不是<select>元素，此方法将抛出错误。但是，如果该元素位于具有关联control的<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 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​

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

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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​

将文件输入的值设置为这些文件路径或文件。如果某些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>#

点击​

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

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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​

返回 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>#

类型​

发送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>#

取消勾选​

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

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

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

用法

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

参数

• selector string#

  用于搜索元素的CSS选择器。如果有多个元素满足该选择器条件，将使用第一个匹配的元素。

• 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>#

等待导航​

等待框架导航并返回主资源响应。在多次重定向的情况下，导航将以最后一次重定向的响应结果。如果导航到不同的锚点或由于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;

参数

• options Object (optional)

  • 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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• Promise<null | Response>#

等待选择器​

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

等待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​

等待给定的timeout毫秒。

请注意frame.waitForTimeout()仅应用于调试。在生产环境中使用计时器的测试将变得不稳定。建议改用网络事件、选择器可见性变化等信号机制。

用法

await frame.waitForTimeout(timeout);

参数

• timeout number#

  等待的超时时间

返回

• Promise<void>#