Page

Page 提供了与浏览器中的单个标签页或 Chromium 中的扩展后台页交互的方法。一个浏览器实例可以有多个 Page 实例。

此示例创建一个页面，导航到 URL，然后保存屏幕截图

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

(async () => {
  const browser = await webkit.launch();
  const context = await browser.newContext();
  const page = await context.newPage();
  await page.goto('https://example.com');
  await page.screenshot({ path: 'screenshot.png' });
  await browser.close();
})();

Page 类会发出各种事件（如下所述），可以使用 Node 的任何原生 EventEmitter 方法（例如 on、once 或 removeListener）进行处理。

此示例记录单个页面 load 事件的消息

page.once('load', () => console.log('Page loaded!'));

要取消订阅事件，请使用 removeListener 方法

function logRequest(interceptedRequest) {
  console.log('A request was made:', interceptedRequest.url());
}
page.on('request', logRequest);
// Sometime later...
page.removeListener('request', logRequest);

方法

addInitScript

v1.9 之前添加

page.addInitScript

添加一个脚本，该脚本将在以下情况之一中进行评估：

每当页面导航时。
每当子框架附加或导航时。在这种情况下，脚本在新附加框架的上下文中进行评估。

脚本在文档创建后但在任何脚本运行之前进行评估。这对于修改 JavaScript 环境非常有用，例如，为 Math.random 设置种子。

用法

在页面加载之前覆盖 Math.random 的示例

// preload.js
Math.random = () => 42;

// In your playwright script, assuming the preload.js file is in same directory
await page.addInitScript({ path: './preload.js' });

await page.addInitScript(mock => {
  window.mock = mock;
}, mock);

注意

通过 browserContext.addInitScript() 和 page.addInitScript() 安装的多个脚本的评估顺序未定义。

参数

script 函数 | 字符串 | 对象 #
- path string (可选)
  
  JavaScript 文件的路径。如果 path 是相对路径，则它相对于当前工作目录解析。可选。
- content string (可选)
  
  原始脚本内容。可选。
要在页面中评估的脚本。
arg 可序列化 (可选)#

传递给脚本的可选参数（仅在传递函数时支持）。

Promise<void>#

addLocatorHandler

新增于: v1.42

page.addLocatorHandler

在测试网页时，有时会出现意想不到的覆盖层，例如“注册”对话框，并阻止您想要自动执行的操作，例如单击按钮。这些覆盖层并不总是以相同的方式或在相同的时间出现，这使得它们在自动化测试中难以处理。

此方法允许您设置一个特殊函数，称为处理程序，当它检测到覆盖层可见时激活。处理程序的任务是删除覆盖层，让您的测试继续，就像覆盖层不存在一样。

要记住的事情

当覆盖层可预测地显示时，我们建议在测试中明确等待它并将其作为正常测试流程的一部分进行关闭，而不是使用 page.addLocatorHandler()。
Playwright 每次在执行或重试需要可操作性检查的操作，或在执行自动等待断言检查之前，都会检查覆盖层。当覆盖层可见时，Playwright 首先调用处理程序，然后继续执行操作/断言。请注意，处理程序仅在您执行操作/断言时调用——如果覆盖层变得可见但您不执行任何操作，则处理程序不会触发。
执行处理程序后，Playwright 将确保触发处理程序的覆盖层不再可见。您可以使用 noWaitAfter 选择退出此行为。
处理程序的执行时间计入执行处理程序的操作/断言的超时。如果您的处理程序花费时间过长，可能会导致超时。
您可以注册多个处理程序。但是，一次只能运行一个处理程序。请确保处理程序内的操作不依赖于另一个处理程序。

警告

运行处理程序将改变您的页面在测试中期的状态。例如，它将改变当前聚焦的元素并移动鼠标。请确保在处理程序之后运行的操作是自包含的，并且不依赖于焦点和鼠标状态保持不变。

例如，考虑一个调用 locator.focus() 后跟 keyboard.press() 的测试。如果您的处理程序在这两个动作之间单击了一个按钮，则聚焦的元素很可能是错误的，并且按键将发生在意外的元素上。请改用 locator.press() 来避免此问题。

另一个例子是一系列鼠标动作，其中 mouse.move() 后跟 mouse.down()。同样，当处理程序在这两个动作之间运行时，鼠标位置在鼠标按下时将是错误的。建议使用自包含的动作，例如 locator.click()，这些动作不依赖于处理程序不会改变状态。

用法

一个在“注册新闻通讯”对话框出现时关闭它的示例

// Setup the handler.
await page.addLocatorHandler(page.getByText('Sign up to the newsletter'), async () => {
  await page.getByRole('button', { name: 'No thanks' }).click();
});

// Write the test as usual.
await page.goto('https://example.com');
await page.getByRole('button', { name: 'Start here' }).click();

一个在显示“确认您的安全详细信息”页面时跳过它的示例

// Setup the handler.
await page.addLocatorHandler(page.getByText('Confirm your security details'), async () => {
  await page.getByRole('button', { name: 'Remind me later' }).click();
});

// Write the test as usual.
await page.goto('https://example.com');
await page.getByRole('button', { name: 'Start here' }).click();

一个示例，每次可操作性检查时都会有一个自定义回调。它使用一个始终可见的 `` 定位器，因此在每次可操作性检查之前都会调用处理程序。指定 noWaitAfter 很重要，因为处理程序不会隐藏 `` 元素。

// Setup the handler.
await page.addLocatorHandler(page.locator('body'), async () => {
  await page.evaluate(() => window.removeObstructionsForTestIfNeeded());
}, { noWaitAfter: true });

// Write the test as usual.
await page.goto('https://example.com');
await page.getByRole('button', { name: 'Start here' }).click();

处理程序将原始定位器作为参数。您还可以通过设置 times，在调用次数达到一定数量后自动删除处理程序

await page.addLocatorHandler(page.getByLabel('Close'), async locator => {
  await locator.click();
}, { times: 1 });

参数

locator 定位器 #

触发处理程序的定位器。
handler 函数(定位器):Promise<对象>#

一旦定位器出现，应该运行的函数。此函数应该消除阻碍点击等操作的元素。
options Object (可选)
- noWaitAfter 布尔值 （可选）新增于：v1.44#
  
  默认情况下，在调用处理程序后，Playwright 将等待覆盖层隐藏，然后 Playwright 才会继续执行触发处理程序的动作/断言。此选项允许选择退出此行为，以便在处理程序运行后覆盖层可以保持可见。
- times 数字 (可选)新增于：v1.44#
  
  指定此处理程序应被调用的最大次数。默认无限制。

Promise<void>#

addScriptTag

v1.9 之前添加

page.addScriptTag

将带有所需 URL 或内容的 <script> 标签添加到页面中。当脚本的 onload 事件触发或脚本内容注入到框架中时，返回添加的标签。

用法

await page.addScriptTag();
await page.addScriptTag(options);

参数

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

Promise<ElementHandle>#

addStyleTag

v1.9 之前添加

page.addStyleTag

向页面添加一个具有所需 URL 的 `<link rel="stylesheet">` 标签，或一个具有内容的 `<style type="text/css">` 标签。当样式表加载完成或 CSS 内容被注入到框架中时，返回添加的标签。

用法

await page.addStyleTag();
await page.addStyleTag(options);

参数

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

Promise<ElementHandle>#

bringToFront

v1.9 之前添加

page.bringToFront

将页面带到前面（激活标签页）。

用法

await page.bringToFront();

Promise<void>#

close

v1.9 之前添加

page.close

如果 runBeforeUnload 为 false，则不运行任何卸载处理程序，并等待页面关闭。如果 runBeforeUnload 为 true，该方法将运行卸载处理程序，但不会等待页面关闭。

默认情况下，page.close() 不运行 beforeunload 处理程序。

注意

如果 runBeforeUnload 被设置为 true，可能会弹出一个 `beforeunload` 对话框，应通过 page.on('dialog') 事件手动处理。

用法

await page.close();
await page.close(options);

参数

options Object (可选)
- reason string (可选)添加于：v1.40#
  
  要报告给因页面关闭而中断的操作的原因。
- runBeforeUnload 布尔值 (可选)#
  
  默认为 false。是否运行 before unload 页面处理程序。

Promise<void>#

content

v1.9 之前添加

page.content

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

用法

await page.content();

Promise<字符串>#

context

v1.9 之前添加

page.context

获取页面所属的浏览器上下文。

用法

page.context();

浏览器上下文 #

dragAndDrop

添加于：v1.13

page.dragAndDrop

此方法将源元素拖动到目标元素。它将首先移动到源元素，执行 mousedown，然后移动到目标元素并执行 mouseup。

用法

await page.dragAndDrop('#source', '#target');
// or specify exact positions relative to the top-left corners of the elements:
await page.dragAndDrop('#source', '#target', {
  sourcePosition: { x: 34, y: 7 },
  targetPosition: { x: 10, y: 20 },
});

参数

source 字符串 #

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

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

Promise<void>#

emulateMedia

v1.9 之前添加

page.emulateMedia

此方法通过 media 参数更改 CSS 媒体类型，并通过 colorScheme 参数更改 'prefers-colors-scheme' 媒体功能。

用法

await page.evaluate(() => matchMedia('screen').matches);
// → true
await page.evaluate(() => matchMedia('print').matches);
// → false

await page.emulateMedia({ media: 'print' });
await page.evaluate(() => matchMedia('screen').matches);
// → false
await page.evaluate(() => matchMedia('print').matches);
// → true

await page.emulateMedia({});
await page.evaluate(() => matchMedia('screen').matches);
// → true
await page.evaluate(() => matchMedia('print').matches);
// → false

await page.emulateMedia({ colorScheme: 'dark' });
await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
// → true
await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
// → false

参数

options Object (可选)
- colorScheme 空 | "light" | "dark" | "no-preference" (可选)添加于：v1.9#
  
  模拟 prefers-colors-scheme 媒体特性，支持的值为 'light' 和 'dark'。传入 null 会禁用颜色方案模拟。'no-preference' 已弃用。
- contrast 空 | "no-preference" | "more" (可选)添加于: v1.51#
  
  模拟 `prefers-contrast` 媒体特性，支持的值为 `no-preference`、`more`。传入 `null` 会禁用对比度模拟。
- forcedColors 空 | "active" | "none" (可选)新增于: v1.15#
  
  模拟 `forced-colors` 媒体特性，支持的值为 `active` 和 `none`。传入 `null` 会禁用强制颜色模拟。
- media 空 | "screen" | "print" (可选)添加于：v1.9#
  
  更改页面的 CSS 媒体类型。唯一允许的值是 'screen'、'print' 和 null。传入 null 会禁用 CSS 媒体模拟。
- reducedMotion 空 | "reduce" | "no-preference" (可选)添加于：v1.12#
  
  模拟 'prefers-reduced-motion' 媒体功能，支持的值为 'reduce'、'no-preference'。传递 null 会禁用减速运动模拟。

Promise<void>#

evaluate

v1.9 之前添加

page.evaluate

返回 pageFunction 调用的值。

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

如果传递给 page.evaluate() 的函数返回一个不可序列化的值，则 page.evaluate() 解析为 undefined。Playwright 还支持传输一些 JSON 不可序列化的额外值：-0、NaN、Infinity、-Infinity。

用法

向 pageFunction 传递参数

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

也可以传递字符串而不是函数

console.log(await page.evaluate('1 + 2')); // prints "3"
const x = 10;
console.log(await page.evaluate(`1 + ${x}`)); // prints "11"

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

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

参数

pageFunction 函数 | 字符串 #

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

传递给 pageFunction 的可选参数。

Promise<可序列化>#

evaluateHandle

v1.9 之前添加

page.evaluateHandle

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

page.evaluate() 和 page.evaluateHandle() 之间的唯一区别是 page.evaluateHandle() 返回 JSHandle。

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

用法

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

也可以传递字符串而不是函数

const aHandle = await page.evaluateHandle('document'); // Handle for the 'document'

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

const aHandle = await page.evaluateHandle(() => document.body);
const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
console.log(await resultHandle.jsonValue());
await resultHandle.dispose();

参数

pageFunction 函数 | 字符串 #

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

传递给 pageFunction 的可选参数。

Promise<JSHandle>#

exposeBinding

v1.9 之前添加

page.exposeBinding

该方法在页面中每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。如果 callback 返回一个 Promise，它将被等待。

callback 函数的第一个参数包含调用者信息：{ browserContext: BrowserContext, page: Page, frame: Frame }。

有关上下文范围的版本，请参阅 browserContext.exposeBinding()。

注意

通过 page.exposeBinding() 安装的函数在导航时仍然有效。

用法

将页面 URL 暴露给页面中所有框架的示例

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

(async () => {
  const browser = await webkit.launch({ headless: false });
  const context = await browser.newContext();
  const page = await context.newPage();
  await page.exposeBinding('pageURL', ({ page }) => page.url());
  await page.setContent(`
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.pageURL();
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
  `);
  await page.click('button');
})();

参数

name 字符串 #

窗口对象上函数的名称。
callback 函数 #

将在 Playwright 上下文中调用的回调函数。
options Object (可选)
- handle 布尔值 (可选)#
  
  已弃用
  此选项将在未来版本中移除。
  
  是否将参数作为句柄传递，而不是按值传递。当传递句柄时，只支持一个参数。当按值传递时，支持多个参数。

Promise<void>#

exposeFunction

v1.9 之前添加

page.exposeFunction

该方法在页面中每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。

如果回调返回一个 Promise，它将被等待。

有关上下文范围的暴露函数，请参阅 browserContext.exposeFunction()。

注意

通过 page.exposeFunction() 安装的函数在导航时仍然有效。

用法

向页面添加 sha256 函数的示例

const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
const crypto = require('crypto');

(async () => {
  const browser = await webkit.launch({ headless: false });
  const page = await browser.newPage();
  await page.exposeFunction('sha256', text =>
    crypto.createHash('sha256').update(text).digest('hex'),
  );
  await page.setContent(`
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
  `);
  await page.click('button');
})();

参数

name 字符串 #

窗口对象上函数的名称
callback 函数 #

将在 Playwright 上下文中调用的回调函数。

Promise<void>#

frame

v1.9 之前添加

page.frame

返回符合指定条件的帧。必须指定 name 或 url。

用法

const frame = page.frame('frame-name');

const frame = page.frame({ url: /.*domain.*/ });

参数

frameSelector 字符串 | 对象 #
- name 字符串 （可选）
  
  在 iframe 的 name 属性中指定的框架名称。可选。
- url 字符串 | 正则表达式 | 函数(URL):布尔值 (可选)
  
  一个全局模式、正则表达式模式或接收帧的 url 作为 URL 对象的谓词。可选。
帧名称或其他帧查找选项。

空 | 帧 #

frameLocator

新增于: v1.17

page.frameLocator

使用 iframe 时，您可以创建一个框架定位器，它将进入 iframe 并允许选择 iframe 中的元素。

用法

以下代码片段在 id 为 my-frame 的 iframe 中查找文本为“提交”的元素，例如 <iframe id="my-frame">

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

参数

selector 字符串 #

用于解析 DOM 元素的选取器。

FrameLocator #

frames

v1.9 之前添加

page.frames

附加到页面的所有帧的数组。

用法

page.frames();

数组<帧>#

getByAltText

新增于：v1.27

page.getByAltText

允许根据元素的 alt 文本定位元素。

用法

例如，此方法将通过 alt 文本“Playwright logo”找到图像

<img alt='Playwright logo'>

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

参数

text 字符串 | 正则表达式 #

用于定位元素的文本。
options Object (可选)
- exact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

getByLabel

新增于：v1.27

page.getByLabel

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

用法

例如，此方法将在以下 DOM 中通过标签“用户名”和“密码”找到输入

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

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

参数

text 字符串 | 正则表达式 #

用于定位元素的文本。
options Object (可选)
- exact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

getByPlaceholder

新增于：v1.27

page.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

您可以按占位符文本定位输入框后填充它

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

参数

text 字符串 | 正则表达式 #

用于定位元素的文本。
options Object (可选)
- exact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

getByRole

新增于：v1.27

page.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 布尔值 (可选)#
  
  通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。
  
  了解更多关于 aria-checked 的信息。
- disabled 布尔值 (可选)#
  
  通常由 aria-disabled 或 disabled 设置的属性。
  
  注意
  与大多数其他属性不同，disabled 在 DOM 层次结构中是继承的。了解更多关于 aria-disabled 的信息。
- exact 布尔值 （可选）新增于: v1.28#
  
  name 是否完全匹配：区分大小写，且匹配整个字符串。默认为 false。当 name 为正则表达式时，此项被忽略。请注意，完全匹配仍会去除空白字符。
- expanded 布尔值 (可选)#
  
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded 的信息。
- includeHidden 布尔值 (可选)#
  
  控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（由 ARIA 定义）由角色选择器匹配。
  
  了解更多关于 aria-hidden 的信息。
- level 数字 (可选)#
  
  通常用于角色 heading、listitem、row、treeitem 的数字属性，<h1>-<h6> 元素具有默认值。
  
  了解更多关于 aria-level 的信息。
- name 字符串 | 正则表达式 (可选)#
  
  匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 exact 控制此行为。
  
  了解更多关于可访问名称的信息。
- pressed 布尔值 (可选)#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- selected 布尔值 (可选)#
  
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected 的信息。

定位器 #

详情

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

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

getByTestId

新增于：v1.27

page.getByTestId

按测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

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

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

参数

testId 字符串 | 正则表达式 #

用于定位元素的 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

新增于：v1.27

page.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 字符串 | 正则表达式 #

用于定位元素的文本。
options Object (可选)
- exact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

详情

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

类型为 button 和 submit 的输入元素通过其 value 而不是文本内容进行匹配。例如，通过文本 "登录" 定位匹配 <input type=button value="登录">。

getByTitle

新增于：v1.27

page.getByTitle

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

用法

考虑以下 DOM 结构。

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

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

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

参数

text 字符串 | 正则表达式 #

用于定位元素的文本。
options Object (可选)
- exact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

goBack

v1.9 之前添加

page.goBack

返回主资源响应。如果存在多次重定向，导航将解析为最后一次重定向的响应。如果无法返回，则返回 null。

导航到历史记录中的上一页。

用法

await page.goBack();
await page.goBack(options);

参数

options Object (可选)
- timeout 数字 (可选)#
  
  最大操作时间（毫秒）。默认为 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<空 | 响应>#

goForward

v1.9 之前添加

page.goForward

返回主资源响应。如果存在多次重定向，导航将解析为最后一次重定向的响应。如果无法前进，则返回 null。

导航到历史记录中的下一页。

用法

await page.goForward();
await page.goForward(options);

参数

options Object (可选)
- timeout 数字 (可选)#
  
  最大操作时间（毫秒）。默认为 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<空 | 响应>#

goto

v1.9 之前添加

page.goto

返回主资源响应。如果存在多次重定向，导航将解析为第一个非重定向响应。

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

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

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

注意

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

注意

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

用法

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

参数

url 字符串 #

要导航到的页面 URL。URL 应包含方案，例如 https://。如果通过上下文选项提供了 baseURL 且传入的 URL 是一个路径，它将通过 new URL() 构造函数合并。
options Object (可选)
- referer 字符串 (可选)#
  
  引荐来源网址头部值。如果提供，它将优先于 page.setExtraHTTPHeaders() 设置的引荐来源网址头部值。
- timeout 数字 (可选)#
  
  最大操作时间（毫秒）。默认为 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<空 | 响应>#

isClosed

v1.9 之前添加

page.isClosed

指示页面已关闭。

用法

page.isClosed();

布尔值 #

locator

新增于：v1.14

page.locator

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

了解更多关于定位器.

用法

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

参数

selector 字符串 #

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

定位器 #

mainFrame

v1.9 之前添加

page.mainFrame

页面的主框架。页面保证有一个在导航期间持久存在的主框架。

用法

page.mainFrame();

帧 #

opener

v1.9 之前添加

page.opener

对于弹出页面返回打开者，对于其他页面返回 null。如果打开者已经关闭，则返回 null。

用法

await page.opener();

Promise<空 | 页面>#

pause

添加于：v1.9

page.pause

暂停脚本执行。Playwright 将停止执行脚本，并等待用户点击页面覆盖中的“恢复”按钮，或者在 DevTools 控制台中调用 playwright.resume()。

用户可以在暂停时检查选择器或执行手动步骤。恢复将从暂停的位置继续运行原始脚本。

注意

此方法要求 Playwright 在有头模式下启动，并带有虚假的无头选项。

用法

await page.pause();

Promise<void>#

pdf

v1.9 之前添加

page.pdf

返回 PDF 缓冲区。

page.pdf() 使用 print CSS 媒体生成页面的 pdf。要使用 screen 媒体生成 pdf，请在调用 page.pdf() 之前调用 page.emulateMedia()

注意

默认情况下，page.pdf() 会生成一个修改了打印颜色的 pdf。使用 -webkit-print-color-adjust 属性强制渲染精确颜色。

用法

// Generates a PDF with 'screen' media type.
await page.emulateMedia({ media: 'screen' });
await page.pdf({ path: 'page.pdf' });

width、height 和 margin 选项接受带单位的值。未标记的值被视为像素。

一些示例

page.pdf({width: 100}) - 打印宽度设置为 100 像素
page.pdf({width: '100px'}) - 打印宽度设置为 100 像素
page.pdf({width: '10cm'}) - 打印宽度设置为 10 厘米。

所有可能的单位是

px - 像素
in - 英寸
cm - 厘米
mm - 毫米

格式选项为

信纸: 8.5 英寸 x 11 英寸
法律: 8.5 英寸 x 14 英寸
Tabloid: 11 英寸 x 17 英寸
账本: 17 英寸 x 11 英寸
A0: 33.1 英寸 x 46.8 英寸
A1: 23.4 英寸 x 33.1 英寸
A2: 16.54 英寸 x 23.4 英寸
A3: 11.7 英寸 x 16.54 英寸
A4: 8.27 英寸 x 11.7 英寸
A5: 5.83 英寸 x 8.27 英寸
A6: 4.13 英寸 x 5.83 英寸

注意

headerTemplate 和 footerTemplate 标记有以下限制： > 1. 模板中的 script 标签不会被评估。 > 2. 页面样式在模板中不可见。

参数

options Object (可选)
- displayHeaderFooter 布尔值 (可选)#
  
  显示页眉和页脚。默认为 false。
- footerTemplate 字符串 (可选)#
  
  打印页脚的 HTML 模板。应使用与 headerTemplate 相同的格式。
- format 字符串 (可选)#
  
  纸张格式。如果设置，则优先于 width 或 height 选项。默认为 'Letter'。
- headerTemplate 字符串 (可选)#
  
  打印页眉的 HTML 模板。应为有效 HTML 标记，其中以下类用于注入打印值
  - 'date' 格式化的打印日期
  - 'title' 文档标题
  - 'url' 文档位置
  - 'pageNumber' 当前页码
  - 'totalPages' 文档总页数
- height 字符串 | 数字 (可选)#
  
  纸张高度，接受带单位的值。
- landscape 布尔值 (可选)#
  
  纸张方向。默认为 false。
- margin 对象 (可选)#
  - top 字符串 | 数字 (可选)
    
    上边距，接受带单位的值。默认为 0。
  - right 字符串 | 数字 (可选)
    
    右边距，接受带单位的值。默认为 0。
  - bottom 字符串 | 数字 (可选)
    
    下边距，接受带单位的值。默认为 0。
  - left 字符串 | 数字 (可选)
    
    左边距，接受带单位的值。默认为 0。
  纸张边距，默认为无。
- outline 布尔值 (可选)新增于: v1.42#
  
  是否将文档大纲嵌入 PDF。默认为 false。
- pageRanges 字符串 (可选)#
  
  要打印的页面范围，例如 '1-5, 8, 11-13'。默认为空字符串，表示打印所有页面。
- path 字符串 (可选)#
  
  保存 PDF 的文件路径。如果 path 是相对路径，则它将相对于当前工作目录解析。如果未提供路径，则 PDF 将不会保存到磁盘。
- preferCSSPageSize 布尔值 (可选)#
  
  使页面中声明的任何 CSS @page 大小优先于 width 和 height 或 format 选项中声明的尺寸。默认为 false，这将缩放内容以适应纸张大小。
- printBackground 布尔值 (可选)#
  
  打印背景图形。默认为 false。
- scale 数字 (可选)#
  
  网页渲染的比例。默认为 1。比例值必须在 0.1 到 2 之间。
- tagged 布尔值 (可选)新增于: v1.42#
  
  是否生成带标签（可访问）的 PDF。默认为 false。
- width 字符串 | 数字 (可选)#
  
  纸张宽度，接受带单位的值。

Promise<Buffer>#

reload

v1.9 之前添加

page.reload

此方法重新加载当前页面，就像用户触发了浏览器刷新一样。返回主资源响应。在多次重定向的情况下，导航将解析为最后一次重定向的响应。

用法

await page.reload();
await page.reload(options);

参数

options Object (可选)
- timeout 数字 (可选)#
  
  最大操作时间（毫秒）。默认为 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<空 | 响应>#

removeAllListeners

添加于：v1.47

page.removeAllListeners

删除给定类型的所有侦听器（如果未给定类型，则删除所有已注册的侦听器）。允许等待异步侦听器完成或忽略这些侦听器随后的错误。

用法

page.on('request', async request => {
  const response = await request.response();
  const body = await response.body();
  console.log(body.byteLength);
});
await page.goto('https://playwright.net.cn', { waitUntil: 'domcontentloaded' });
// Waits for all the reported 'request' events to resolve.
await page.removeAllListeners('request', { behavior: 'wait' });

参数

type 字符串 (可选)#
options Object (可选)
- behavior "wait" | "ignoreErrors" | "default" (可选)#
  
  指定是否等待已经运行的监听器以及如果它们抛出错误该怎么做
  - 'default' - 不等待当前监听器调用（如果有的话）完成，如果监听器抛出错误，可能会导致未处理的错误
  - 'wait' - 等待当前监听器调用（如果有的话）完成
  - 'ignoreErrors' - 不等待当前监听器调用（如果有的话）完成，监听器在移除后抛出的所有错误都将被静默捕获

Promise<void>#

removeLocatorHandler

新增于：v1.44

page.removeLocatorHandler

删除通过 page.addLocatorHandler() 为特定定位器添加的所有定位器处理程序。

用法

await page.removeLocatorHandler(locator);

参数

locator 定位器 #

传递给 page.addLocatorHandler() 的定位器。

Promise<void>#

requestGC

新增于: v1.48

page.requestGC

请求页面执行垃圾回收。请注意，不能保证所有不可达对象都会被收集。

这有助于检测内存泄漏。例如，如果您的页面有一个可能泄漏的大对象 'suspect'，您可以使用 WeakRef 来检查它是否泄漏。

// 1. In your page, save a WeakRef for the "suspect".
await page.evaluate(() => globalThis.suspectWeakRef = new WeakRef(suspect));
// 2. Request garbage collection.
await page.requestGC();
// 3. Check that weak ref does not deref to the original object.
expect(await page.evaluate(() => !globalThis.suspectWeakRef.deref())).toBe(true);

用法

await page.requestGC();

Promise<void>#

route

v1.9 之前添加

page.route

路由提供了修改页面发出的网络请求的能力。

一旦启用路由，每个匹配 URL 模式的请求都将暂停，除非它被继续、完成或中止。

注意

如果响应是重定向，则处理程序将只针对第一个 URL 调用。

注意

page.route() 不会拦截 Service Worker 拦截的请求。请参阅此问题。我们建议在使用请求拦截时通过将 serviceWorkers 设置为 'block' 来禁用 Service Workers。

注意

page.route() 将不会拦截弹出页面的第一个请求。请改用 browserContext.route()。

用法

一个简单地中止所有图片请求的处理程序示例

const page = await browser.newPage();
await page.route('**/*.{png,jpg,jpeg}', route => route.abort());
await page.goto('https://example.com');
await browser.close();

或者使用正则表达式模式的相同片段

const page = await browser.newPage();
await page.route(/(\.png$)|(\.jpg$)/, route => route.abort());
await page.goto('https://example.com');
await browser.close();

可以检查请求以决定路由操作。例如，模拟所有包含某些 POST 数据的请求，并保留所有其他请求不变

await page.route('/api/**', async route => {
  if (route.request().postData().includes('my-string'))
    await route.fulfill({ body: 'mocked-data' });
  else
    await route.continue();
});

当请求同时匹配页面路由和浏览器上下文路由时（通过 browserContext.route() 设置），页面路由优先级更高。

要删除带有处理程序的路由，可以使用 page.unroute()。

注意

启用路由会禁用 HTTP 缓存。

参数

url 字符串 | 正则表达式 | 函数(URL):布尔值 #

一个全局模式、正则表达式模式或谓词，它接收一个 URL，用于在路由期间进行匹配。如果在上下文选项中设置了 baseURL 并且提供的 URL 是一个不以 * 开头的字符串，它将使用 new URL() 构造函数解析。
handler 函数(路由, 请求):Promise<对象> | 对象 #

用于路由请求的处理函数。
options Object (可选)
- times 数字 (可选)新增于: v1.15#
  
  路由应该被使用多少次。默认情况下，每次都会使用。

Promise<void>#

routeFromHAR

添加于：v1.23

page.routeFromHAR

如果指定，页面中发出的网络请求将从 HAR 文件提供。阅读更多关于从 HAR 重放的信息。

Playwright 不会从 HAR 文件中提供 Service Worker 拦截的请求。请参阅此问题。我们建议在使用请求拦截时通过将 serviceWorkers 设置为 'block' 来禁用 Service Workers。

用法

await page.routeFromHAR(har);
await page.routeFromHAR(har, options);

参数

har 字符串 #

带有预录网络数据的 HAR 文件路径。如果 path 是相对路径，则它相对于当前工作目录解析。
options Object (可选)
- notFound "abort" | "fallback" (可选)#
  - 如果设置为 'abort'，则 HAR 文件中未找到的任何请求都将被中止。
  - 如果设置为 'fallback'，则缺失的请求将被发送到网络。
  默认为中止。
- update 布尔值 (可选)#
  
  如果指定，则使用实际的网络信息更新给定的 HAR，而不是从文件提供。文件在调用 browserContext.close() 时写入磁盘。
- updateContent "embed" | "attach" (可选)新增于: v1.32#
  
  可选设置以控制资源内容管理。如果指定 attach，资源将作为单独的文件或 ZIP 档案中的条目持久化。如果指定 embed，内容将内联存储在 HAR 文件中。
- updateMode "full" | "minimal" (可选)新增于: v1.32#
  
  当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这会省略 HAR 信息中不用于从 HAR 重放的大小、时间、页面、cookie、安全性和其他类型的信息。默认为 minimal。
- url 字符串 | 正则表达式 (可选)#
  
  一个 glob 模式、正则表达式或谓词，用于匹配请求 URL。只有 URL 匹配模式的请求将从 HAR 文件中提供。如果未指定，所有请求都将从 HAR 文件中提供。

Promise<void>#

routeWebSocket

新增于: v1.48

page.routeWebSocket

此方法允许修改页面建立的 websocket 连接。

请注意，只有在此方法调用后创建的 WebSocket 才会进行路由。建议在导航页面之前调用此方法。

用法

下面是一个简单模拟的示例，它响应单个消息。有关更多详细信息和示例，请参阅 WebSocketRoute。

await page.routeWebSocket('/ws', ws => {
  ws.onMessage(message => {
    if (message === 'request')
      ws.send('response');
  });
});

参数

url 字符串 | 正则表达式 | 函数(URL):布尔值 #

只有 URL 与此模式匹配的 WebSocket 才会路由。字符串模式可以相对于 baseURL 上下文选项。
handler 函数(WebSocketRoute):Promise<对象> | 对象 #

用于路由 WebSocket 的处理函数。

Promise<void>#

screenshot

v1.9 之前添加

page.screenshot

返回包含捕获的屏幕截图的缓冲区。

用法

await page.screenshot();
await page.screenshot(options);

参数

options Object (可选)
- animations "disabled" | "allow" (可选)#
  
  设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。动画的处理方式因其持续时间而异
  - 有限动画会快进到完成，因此它们会触发 transitionend 事件。
  - 无限动画会取消到初始状态，然后在截图后重新播放。
  默认为 "allow"，保持动画不变。
- caret "hide" | "initial" (可选)#
  
  设置为 "hide" 时，截图将隐藏文本插入符号。设置为 "initial" 时，文本插入符号行为不会更改。默认为 "hide"。
- clip 对象 (可选)#
  - x 数字
    
    裁剪区域左上角的 x 坐标
  - y 数字
    
    裁剪区域左上角的 y 坐标
  - width number
    
    裁剪区域的宽度
  - height number
    
    裁剪区域的高度
  一个指定结果图像裁剪的对象。
- fullPage 布尔值 (可选)#
  
  当为 true 时，截取整个可滚动页面的截图，而不是当前可见的视口。默认为 false。
- mask 数组<定位器> (可选)#
  
  指定在截屏时应遮罩的定位器。被遮罩的元素将覆盖一个粉色方框 #FF00FF（由 maskColor 自定义），完全覆盖其边界框。遮罩也适用于不可见元素，请参阅仅匹配可见元素以禁用此功能。
- maskColor 字符串 (可选)添加于：v1.35#
  
  指定遮盖元素的覆盖框颜色，采用 CSS 颜色格式。默认颜色为粉红色 #FF00FF。
- omitBackground 布尔值 (可选)#
  
  隐藏默认的白色背景并允许捕获透明截图。不适用于 jpeg 图像。默认为 false。
- path 字符串 (可选)#
  
  用于保存图像的文件路径。屏幕截图类型将从文件扩展名中推断。如果path是相对路径，则它会相对于当前工作目录进行解析。如果未提供路径，则图像不会保存到磁盘。
- quality number （可选）#
  
  图像质量，介于 0-100 之间。不适用于 png 图像。
- scale "css" | "device" （可选）#
  
  当设置为 "css" 时，截图将为页面上的每个 CSS 像素提供一个像素。对于高 DPI 设备，这将使截图保持较小。使用 "device" 选项将为每个设备像素生成一个像素，因此高 DPI 设备的截图将是两倍甚至更大。
  
  默认为 "device"。
- style 字符串 (可选)新增于: v1.41#
  
  在进行屏幕截图时应用的样式表文本。在这里，您可以隐藏动态元素，使元素不可见或更改其属性，以帮助您创建可重复的屏幕截图。此样式表会穿透 Shadow DOM 并应用于内部框架。
- timeout number （可选）#
  
  最大超时时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- type "png" | "jpeg" （可选）#
  
  指定截图类型，默认为 png。

Promise<Buffer>#

setContent

v1.9 之前添加

page.setContent

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

用法

await page.setContent(html);
await page.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>#

v1.9 之前添加

page.setDefaultNavigationTimeout

此设置将更改以下方法和相关快捷方式的默认最大导航时间

注意

page.setDefaultNavigationTimeout() 优先于 page.setDefaultTimeout()、browserContext.setDefaultTimeout() 和 browserContext.setDefaultNavigationTimeout()。

用法

page.setDefaultNavigationTimeout(timeout);

参数

timeout number #

最大导航时间（毫秒）

setDefaultTimeout

v1.9 之前添加

page.setDefaultTimeout

此设置将更改所有接受 timeout 选项的方法的默认最大时间。

注意

page.setDefaultNavigationTimeout() 优先于 page.setDefaultTimeout()。

用法

page.setDefaultTimeout(timeout);

参数

timeout number #

最大时间（毫秒）。传入 0 禁用超时。

setExtraHTTPHeaders

v1.9 之前添加

page.setExtraHTTPHeaders

额外的 HTTP 头将随页面发起的每个请求一起发送。

注意

page.setExtraHTTPHeaders() 不保证传出请求中头部的顺序。

用法

await page.setExtraHTTPHeaders(headers);

参数

headers Object<string, string>#

一个包含要随每个请求发送的额外 HTTP 标头的对象。所有标头值必须是字符串。

Promise<void>#

setViewportSize

v1.9 之前添加

page.setViewportSize

在一个浏览器中有多个页面时，每个页面可以有自己的视口大小。但是，browser.newContext() 允许一次性为上下文中的所有页面设置视口大小（以及更多）。

page.setViewportSize() 将调整页面大小。许多网站不期望手机改变大小，因此您应该在导航到页面之前设置视口大小。page.setViewportSize() 还会重置 screen 大小，如果您需要更好地控制这些属性，请使用带有 screen 和 viewport 参数的 browser.newContext()。

用法

const page = await browser.newPage();
await page.setViewportSize({
  width: 640,
  height: 480,
});
await page.goto('https://example.com');

参数

viewportSize Object#
- width number
  
  页面宽度（像素）。
- height number
  
  页面高度（像素）。

Promise<void>#

title

v1.9 之前添加

page.title

返回页面的标题。

用法

await page.title();

Promise<string>#

unroute

v1.9 之前添加

page.unroute

移除通过 page.route() 创建的路由。如果未指定 handler，则移除 url 的所有路由。

用法

await page.unroute(url);
await page.unroute(url, handler);

参数

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

一个全局模式、正则表达式模式或接收 URL 的谓词，用于路由时匹配。
handler function(Route, Request):Promise<Object> | Object （可选）#

可选的处理函数，用于路由请求。

Promise<void>#

unrouteAll

新增于: v1.41

page.unrouteAll

移除所有通过 page.route() 和 page.routeFromHAR() 创建的路由。

用法

await page.unrouteAll();
await page.unrouteAll(options);

参数

options Object (可选)
- behavior "wait" | "ignoreErrors" | "default" （可选）#
  
  指定是否等待已运行的处理程序以及如果它们抛出错误该怎么做
  - 'default' - 不等待当前处理程序调用 (如果有) 完成，如果未路由的处理程序抛出错误，可能会导致未处理的错误
  - 'wait' - 等待当前处理程序调用 (如果有) 完成
  - 'ignoreErrors' - 不等待当前处理程序调用 (如果有) 完成，取消路由后处理程序抛出的所有错误都将被静默捕获

Promise<void>#

url

v1.9 之前添加

page.url

用法

page.url();

string #

video

v1.9 之前添加

page.video

与此页面关联的视频对象。

用法

page.video();

null | Video #

viewportSize

v1.9 之前添加

page.viewportSize

用法

page.viewportSize();

null | Object#
- width number
  
  页面宽度（像素）。
- height number
  
  页面高度（像素）。

waitForEvent

v1.9 之前添加

page.waitForEvent

等待事件触发并将其值传递给谓词函数。当谓词返回真值时返回。如果页面在事件触发之前关闭，将抛出错误。返回事件数据值。

用法

// Start waiting for download before clicking. Note no await.
const downloadPromise = page.waitForEvent('download');
await page.getByText('Download file').click();
const download = await downloadPromise;

参数

event string #

事件名称，通常传递给 *.on(event) 的相同名称。
optionsOrPredicate function | Object （可选）#
- predicate function
  
  接收事件数据，并在等待应该解决时解析为真值。
- timeout 数字 (可选)
  
  最大等待时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
一个接收事件的谓词或一个选项对象。可选。
options Object (可选)
- predicate function （可选）#
  
  接收事件数据，并在等待应该解决时解析为真值。

Promise<Object>#

waitForFunction

v1.9 之前添加

page.waitForFunction

当 pageFunction 返回一个真值时返回。它解析为真值的 JSHandle。

用法

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

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

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

将参数传递给 page.waitForFunction() 函数的谓词

const selector = '.foo';
await page.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 之前添加

page.waitForLoadState

当达到所需加载状态时返回。

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

注意

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

用法

await page.getByRole('button').click(); // Click triggers navigation.
await page.waitForLoadState(); // The promise resolves after 'load' event.

const popupPromise = page.waitForEvent('popup');
await page.getByRole('button').click(); // Click triggers a popup.
const popup = await popupPromise;
await popup.waitForLoadState('domcontentloaded'); // Wait for the 'DOMContentLoaded' event.
console.log(await popup.title()); // Popup is ready to use.

参数

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

waitForRequest

v1.9 之前添加

page.waitForRequest

等待匹配的请求并返回它。有关事件的更多详细信息，请参阅等待事件。

用法

// Start waiting for request before clicking. Note no await.
const requestPromise = page.waitForRequest('https://example.com/resource');
await page.getByText('trigger request').click();
const request = await requestPromise;

// Alternative way with a predicate. Note no await.
const requestPromise = page.waitForRequest(request =>
  request.url() === 'https://example.com' && request.method() === 'GET',
);
await page.getByText('trigger request').click();
const request = await requestPromise;

参数

urlOrPredicate string | RegExp | function(Request):boolean | Promise<boolean>#

请求 URL 字符串、正则表达式或接收 Request 对象的谓词。
options Object (可选)
- timeout number （可选）#
  
  最大等待时间，单位为毫秒，默认为 30 秒，传递 0 可禁用超时。默认值可以通过 page.setDefaultTimeout() 方法更改。

Promise<Request>#

waitForResponse

v1.9 之前添加

page.waitForResponse

返回匹配的响应。有关事件的更多详细信息，请参阅等待事件。

用法

// Start waiting for response before clicking. Note no await.
const responsePromise = page.waitForResponse('https://example.com/resource');
await page.getByText('trigger response').click();
const response = await responsePromise;

// Alternative way with a predicate. Note no await.
const responsePromise = page.waitForResponse(response =>
  response.url() === 'https://example.com' && response.status() === 200
      && response.request().method() === 'GET'
);
await page.getByText('trigger response').click();
const response = await responsePromise;

参数

urlOrPredicate string | RegExp | function(Response):boolean | Promise<boolean>#

请求 URL 字符串、正则表达式或接收 Response 对象的谓词。如果通过上下文选项提供了 baseURL 且传入的 URL 是一个路径，则它将通过 new URL() 构造函数进行合并。
options Object (可选)
- timeout number （可选）#
  
  最大等待时间，单位为毫秒，默认为 30 秒，传递 0 可禁用超时。默认值可以通过 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<Response>#

waitForURL

添加于：v1.11

page.waitForURL

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

用法

await page.click('a.delayed-navigation'); // Clicking the link will indirectly cause a navigation
await page.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>#

workers

v1.9 之前添加

page.workers

此方法返回与页面关联的所有专用 WebWorkers。

注意

这不包含 ServiceWorkers

用法

page.workers();

Array<Worker>#

属性

clock

新增于: v1.45

page.clock

Playwright 能够模拟时钟和时间流逝。

用法

page.clock

类型

时钟

coverage

v1.9 之前添加

page.coverage

注意

目前仅适用于 Chromium。

浏览器特定的 Coverage 实现。有关更多详细信息，请参阅 Coverage。

用法

page.coverage

类型

Coverage

keyboard

v1.9 之前添加

page.keyboard

用法

page.keyboard

类型

Keyboard

mouse

v1.9 之前添加

page.mouse

用法

page.mouse

类型

Mouse

request

添加于：v1.16

page.request

与此页面关联的 API 测试助手。此方法返回与页面上下文上的 browserContext.request 相同的实例。有关更多详细信息，请参阅 browserContext.request。

用法

page.request

类型

APIRequestContext

touchscreen

v1.9 之前添加

page.touchscreen

用法

page.touchscreen

类型

Touchscreen

事件

on('close')

v1.9 之前添加

page.on('close')

当页面关闭时发出。

用法

page.on('close', data => {});

事件数据

Page

on('console')

v1.9 之前添加

page.on('console')

当页面中的 JavaScript 调用其中一个 console API 方法（例如 console.log 或 console.dir）时触发。

传递给 console.log 的参数可在 ConsoleMessage 事件处理程序参数中获取。

用法

page.on('console', async msg => {
  const values = [];
  for (const arg of msg.args())
    values.push(await arg.jsonValue());
  console.log(...values);
});
await page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));

事件数据

ConsoleMessage

on('crash')

v1.9 之前添加

page.on('crash')

当页面崩溃时发出。如果浏览器页面尝试分配过多内存，可能会崩溃。当页面崩溃时，正在进行和后续操作将抛出异常。

处理崩溃最常见的方法是捕获异常

try {
  // Crash might happen during a click.
  await page.click('button');
  // Or while waiting for an event.
  await page.waitForEvent('popup');
} catch (e) {
  // When the page crashes, exception message contains 'crash'.
}

用法

page.on('crash', data => {});

事件数据

Page

on('dialog')

v1.9 之前添加

page.on('dialog')

当 JavaScript 对话框出现时触发，例如 alert、prompt、confirm 或 beforeunload。监听器**必须** dialog.accept() 或 dialog.dismiss() 对话框，否则页面将冻结等待对话框，并且像点击这样的操作将永远无法完成。

用法

page.on('dialog', dialog => dialog.accept());

注意

当没有 page.on('dialog') 或 browserContext.on('dialog') 监听器存在时，所有对话框都会自动关闭。

事件数据

Dialog

on('domcontentloaded')

添加于：v1.9

page.on('domcontentloaded')

当 JavaScript DOMContentLoaded 事件被分派时发出。

用法

page.on('domcontentloaded', data => {});

事件数据

Page

on('download')

v1.9 之前添加

page.on('download')

附件下载开始时触发。用户可以通过传入的 Download 实例访问下载内容的基本文件操作。

用法

page.on('download', data => {});

事件数据

Download

on('filechooser')

添加于：v1.9

page.on('filechooser')

当文件选择器应该出现时触发，例如在点击 <input type=file> 之后。Playwright 可以通过使用 fileChooser.setFiles() 设置输入文件来响应，这些文件之后可以上传。

page.on('filechooser', async fileChooser => {
  await fileChooser.setFiles(path.join(__dirname, '/tmp/myfile.pdf'));
});

用法

page.on('filechooser', data => {});

事件数据

FileChooser

on('frameattached')

添加于：v1.9

page.on('frameattached')

当框架附加时发出。

用法

page.on('frameattached', data => {});

事件数据

Frame

on('framedetached')

添加于：v1.9

page.on('framedetached')

当框架分离时发出。

用法

page.on('framedetached', data => {});

事件数据

Frame

on('framenavigated')

添加于：v1.9

page.on('framenavigated')

当框架导航到新的 URL 时发出。

用法

page.on('framenavigated', data => {});

事件数据

Frame

on('load')

v1.9 之前添加

page.on('load')

当 JavaScript load 事件被分派时发出。

用法

page.on('load', data => {});

事件数据

Page

on('pageerror')

添加于：v1.9

page.on('pageerror')

当页面内发生未捕获异常时发出。

// Log all uncaught errors to the terminal
page.on('pageerror', exception => {
  console.log(`Uncaught exception: "${exception}"`);
});

// Navigate to a page with an exception.
await page.goto('data:text/html,<script>throw new Error("Test")</script>');

用法

page.on('pageerror', data => {});

事件数据

错误

v1.9 之前添加

page.on('popup')

当页面打开新标签页或窗口时触发。此事件除了 browserContext.on('page') 之外还会触发，但仅适用于与此页面相关的弹出窗口。

页面可用的最早时刻是它导航到初始 URL 时。例如，当使用 window.open('http://example.com') 打开一个弹出窗口时，当对 "http://example.com" 的网络请求完成并且其响应开始在弹出窗口中加载时，此事件将触发。如果您想路由/监听此网络请求，请分别使用 browserContext.route() 和 browserContext.on('request')，而不是 Page 上的类似方法。

// Start waiting for popup before clicking. Note no await.
const popupPromise = page.waitForEvent('popup');
await page.getByText('open the popup').click();
const popup = await popupPromise;
console.log(await popup.evaluate('location.href'));

注意

使用 page.waitForLoadState() 等待页面达到特定状态（大多数情况下您不需要它）。

用法

page.on('popup', data => {});

事件数据

Page

on('request')

v1.9 之前添加

page.on('request')

当页面发出请求时触发。request 对象是只读的。要拦截和修改请求，请参阅 page.route() 或 browserContext.route()。

用法

page.on('request', data => {});

事件数据

Request

on('requestfailed')

添加于：v1.9

page.on('requestfailed')

当请求失败时发出，例如由于超时。

page.on('requestfailed', request => {
  console.log(request.url() + ' ' + request.failure().errorText);
});

注意

HTTP 错误响应，例如 404 或 503，从 HTTP 角度来看仍然是成功的响应，因此请求将以 page.on('requestfinished') 事件完成，而不是以 page.on('requestfailed') 事件完成。只有当客户端无法从服务器获取 HTTP 响应时，例如由于网络错误 net::ERR_FAILED，请求才会被视为失败。

用法

page.on('requestfailed', data => {});

事件数据

Request

on('requestfinished')

添加于：v1.9

page.on('requestfinished')

当请求成功下载响应体后完成时发出。对于成功的响应，事件序列是 request、response 和 requestfinished。

用法

page.on('requestfinished', data => {});

事件数据

Request

on('response')

v1.9 之前添加

page.on('response')

当请求收到 response 状态和头部时触发。对于成功的响应，事件序列是 request、response 和 requestfinished。

用法

page.on('response', data => {});

事件数据

Response

on('websocket')

添加于：v1.9

page.on('websocket')

当发送 WebSocket 请求时触发。

用法

page.on('websocket', data => {});

事件数据

WebSocket

on('worker')

v1.9 之前添加

page.on('worker')

当页面生成专用 WebWorker 时发出。

用法

page.on('worker', data => {});

事件数据

Worker

已弃用

$

添加于：v1.9

page.$

不推荐

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

此方法在页面中查找与指定选择器匹配的元素。如果没有元素与选择器匹配，则返回值解析为 null。要等待页面上的元素，请使用 locator.waitFor()。

用法

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

参数

selector string #

要查询的选择器。
options Object (可选)
- strict 布尔值 （可选）新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

Promise<null | ElementHandle>#

$$

添加于：v1.9

page.$$

不推荐

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

此方法在页面中查找与指定选择器匹配的所有元素。如果没有元素匹配选择器，返回值解析为 []。

用法

await page.$$(selector);

参数

selector string #

要查询的选择器。

Promise<Array<ElementHandle>>#

$eval

添加于：v1.9

page.$eval

不推荐

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

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

如果 pageFunction 返回一个 Promise，那么 page.$eval() 将等待 Promise 解决并返回其值。

用法

const searchValue = await page.$eval('#search', el => el.value);
const preloadHref = await page.$eval('link[rel=preload]', el => el.href);
const html = await page.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');
// In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);

参数

selector string #

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

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

可选参数，传递给 pageFunction。
options Object (可选)
- strict 布尔值 （可选）新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

Promise<Serializable>#

$$eval

添加于：v1.9

page.$$eval

不推荐

在大多数情况下，locator.evaluateAll()、其他 Locator 辅助方法和 web-first 断言做得更好。

此方法在页面中查找所有与指定选择器匹配的元素，并将匹配元素的数组作为第一个参数传递给 pageFunction。返回 pageFunction 调用的结果。

如果 pageFunction 返回一个 Promise，那么 page.$$eval() 将等待 Promise 解决并返回其值。

用法

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

参数

selector string #

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

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

可选参数，传递给 pageFunction。

Promise<Serializable>#

accessibility

v1.9 之前添加

page.accessibility

已弃用

不推荐此属性。如果您需要测试页面可访问性，请使用其他库，例如 Axe。请参阅我们的 Node.js 指南以集成 Axe。

用法

page.accessibility

类型

Accessibility

check

v1.9 之前添加

page.check

不推荐

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

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

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

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

用法

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

参数

selector string #

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

Promise<void>#

click

v1.9 之前添加

page.click

不推荐

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

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

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

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

用法

await page.click(selector);
await page.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 数字
  - y 数字
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- strict 布尔值 （可选）新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- timeout number （可选）#
  
  最大超时时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而不实际执行。请注意，无论 trial 如何，键盘 modifiers 都将按下，以允许测试仅在这些键按下时才可见的元素。

Promise<void>#

dblclick

v1.9 之前添加

page.dblclick

不推荐

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

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

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

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

注意

page.dblclick() 分派两次 click 事件和一次 dblclick 事件。

用法

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

参数

selector string #

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

Promise<void>#

dispatchEvent

v1.9 之前添加

page.dispatchEvent

不推荐

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

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

用法

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

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

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

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

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

参数

selector string #

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

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

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

Promise<void>#

fill

v1.9 之前添加

page.fill

不推荐

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

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

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

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

用法

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

参数

selector string #

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

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

Promise<void>#

focus

v1.9 之前添加

page.focus

不推荐

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

此方法使用 selector 获取元素并聚焦它。如果没有元素与 selector 匹配，则该方法将等待直到 DOM 中出现匹配元素。

用法

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

参数

selector string #

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

Promise<void>#

getAttribute

v1.9 之前添加

page.getAttribute

不推荐

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

返回元素属性值。

用法

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

参数

selector string #

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

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

Promise<null | string>#

hover

v1.9 之前添加

page.hover

不推荐

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

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

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

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

用法

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

参数

selector string #

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

Promise<void>#

innerHTML

v1.9 之前添加

page.innerHTML

不推荐

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

返回 element.innerHTML。

用法

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

参数

selector string #

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

Promise<string>#

innerText

v1.9 之前添加

page.innerText

不推荐

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

返回 element.innerText。

用法

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

参数

selector string #

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

Promise<string>#

inputValue

添加于：v1.13

page.inputValue

不推荐

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

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

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

用法

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

参数

selector 字符串 #

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

Promise<字符串>#

isChecked

v1.9 之前添加

page.isChecked

不推荐

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

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

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

isDisabled

v1.9 之前添加

page.isDisabled

不推荐

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

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

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

isEditable

v1.9 之前添加

page.isEditable

不推荐

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

返回元素是否可编辑。

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

isEnabled

v1.9 之前添加

page.isEnabled

不推荐

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

返回元素是否启用。

用法

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

参数

selector 字符串 #

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

Promise<布尔值>#

isHidden

v1.9 之前添加

page.isHidden

不推荐

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

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

用法

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

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Object (可选)
- strict 布尔值 （可选）新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- timeout 数字 (可选)#
  
  已弃用
  此选项被忽略。page.isHidden() 不会等待元素变为隐藏状态，而是立即返回。

Promise<布尔值>#

isVisible

v1.9 之前添加

page.isVisible

不推荐

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

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

用法

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

参数

selector 字符串 #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Object (可选)
- strict 布尔值 （可选）新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- timeout 数字 (可选)#
  
  已弃用
  此选项被忽略。page.isVisible() 不会等待元素变为可见状态，而是立即返回。

Promise<布尔值>#

press

v1.9 之前添加

page.press

不推荐

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

聚焦元素，然后使用 keyboard.down() 和 keyboard.up()。

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键将输入与键对应的大写文本。

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

也支持快捷键，例如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T"。当与修饰符一起指定时，修饰符在按下后续键时被按下并保持。

用法

const page = await browser.newPage();
await page.goto('https://keycode.info');
await page.press('body', 'A');
await page.screenshot({ path: 'A.png' });
await page.press('body', 'ArrowLeft');
await page.screenshot({ path: 'ArrowLeft.png' });
await page.press('body', 'Shift+O');
await page.screenshot({ path: 'O.png' });
await browser.close();

参数

selector 字符串 #

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

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

Promise<void>#

selectOption

v1.9 之前添加

page.selectOption

不推荐

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

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

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

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

一旦所有提供的选项都已选中，将触发 change 和 input 事件。

用法

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

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

// multiple selection
page.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 布尔值 （可选）新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- timeout 数字 (可选)#
  
  最大超时时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<数组<字符串>>#

setChecked

新增于: v1.15

page.setChecked

不推荐

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

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

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

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

用法

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

参数

selector 字符串 #

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

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

Promise<void>#

setInputFiles

v1.9 之前添加

page.setInputFiles

不推荐

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

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

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

用法

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

参数

selector 字符串 #

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

Promise<void>#

tap

v1.9 之前添加

page.tap

不推荐

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

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

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

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

注意

如果浏览器上下文的hasTouch选项为 false，则page.tap()方法将抛出异常。

用法

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

参数

selector 字符串 #

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

Promise<void>#

textContent

v1.9 之前添加

page.textContent

不推荐

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

返回 element.textContent。

用法

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

参数

selector 字符串 #

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

Promise<null | 字符串>#

type

v1.9 之前添加

page.type

已弃用

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

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

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

用法

参数

selector 字符串 #

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

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

Promise<void>#

uncheck

v1.9 之前添加

page.uncheck

不推荐

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

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

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

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

用法

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

参数

selector 字符串 #

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

Promise<void>#

v1.9 之前添加

page.waitForNavigation

已弃用

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

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

用法

当页面导航到新URL或重新加载时，此方法会解决。它适用于您运行的代码间接导致页面导航的情况。例如，点击目标有一个onclick处理程序，该处理程序通过setTimeout触发导航。考虑以下示例

// 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 字符串 | 正则表达式 | 函数(URL):布尔值 (可选)#
  
  一个全局模式、正则表达式模式或接收 URL 的谓词，用于等待导航时匹配。请注意，如果参数是没有通配符的字符串，该方法将等待导航到与该字符串完全相同的 URL。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#
  
  何时认为操作成功，默认为 load。事件可以是以下之一
  - 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
  - 'load' - 当 load 事件触发时，认为操作完成。
  - 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
  - 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

Promise<null | Response>#

waitForSelector

v1.9 之前添加

page.waitForSelector

不推荐

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

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

注意

Playwright 会在执行操作之前自动等待元素准备就绪。使用定位器对象和 Web 优先断言可以使代码摆脱 wait-for-selector。

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

用法

此方法适用于跨导航

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.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 布尔值 （可选）新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- timeout 数字 (可选)#
  
  最大超时时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<null | ElementHandle>#

waitForTimeout

v1.9 之前添加

page.waitForTimeout

不推荐

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

等待给定的超时（以毫秒为单位）。

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

用法

// wait for 1 second
await page.waitForTimeout(1000);

参数

timeout 数字 #

要等待的超时时间。

Promise<void>#

方法​

addInitScript​

addLocatorHandler​

addScriptTag​

addStyleTag​

bringToFront​

close​

content​

context​

dragAndDrop​

emulateMedia​

evaluate​

evaluateHandle​

exposeBinding​

exposeFunction​

frame​

frameLocator​

frames​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

goBack​

goForward​

goto​

isClosed​

locator​

mainFrame​

opener​

pause​

pdf​

reload​

removeAllListeners​

removeLocatorHandler​

requestGC​

route​

routeFromHAR​

routeWebSocket​

screenshot​

setContent​

setDefaultNavigationTimeout​

setDefaultTimeout​

setExtraHTTPHeaders​

setViewportSize​

title​

unroute​

unrouteAll​

url​

video​

viewportSize​

waitForEvent​

waitForFunction​

waitForLoadState​

waitForRequest​

waitForResponse​

waitForURL​

workers​

属性​

clock​

coverage​

keyboard​

mouse​

request​

touchscreen​

事件​

on('close')​

on('console')​

on('crash')​

on('dialog')​

on('domcontentloaded')​

on('download')​

on('filechooser')​

on('frameattached')​

on('framedetached')​

on('framenavigated')​

on('load')​

on('pageerror')​

方法

addInitScript

addLocatorHandler

addScriptTag

addStyleTag

bringToFront

close

content

context

dragAndDrop

emulateMedia

evaluate

evaluateHandle

exposeBinding

exposeFunction

frame

frameLocator

frames

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

goBack

goForward

goto

isClosed

locator

mainFrame

opener

pause

pdf

reload

removeAllListeners

removeLocatorHandler

requestGC

route

routeFromHAR

routeWebSocket

screenshot

setContent

setDefaultNavigationTimeout

setDefaultTimeout

setExtraHTTPHeaders

setViewportSize

title

unroute

unrouteAll

url

video

viewportSize

waitForEvent

waitForFunction

waitForLoadState

waitForRequest

waitForResponse

waitForURL

workers

属性

clock

coverage

keyboard

mouse

request

touchscreen

事件

on('close')

on('console')

on('crash')

on('dialog')

on('domcontentloaded')

on('download')

on('filechooser')

on('frameattached')

on('framedetached')

on('framenavigated')

on('load')

on('pageerror')