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 function | string | Object #
- path string （可选）
  
  JavaScript 文件的路径。如果 path 是相对路径，则它相对于当前工作目录解析。可选。
- content string （可选）
  
  原始脚本内容。可选。
要在页面中执行的脚本。
arg Serializable （可选）#

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

返回值

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();

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

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

触发处理程序的定位器。
handler function(Locator):Promise<Object>#

一旦 locator 出现就应该运行的函数。此函数应消除阻止诸如单击之类的操作的元素。
options Object （可选）
- noWaitAfter boolean （可选）在 v1.44 中添加#
  
  默认情况下，在调用处理程序后，Playwright 将等待直到覆盖层变为隐藏，然后 Playwright 才会继续执行触发处理程序的操作/断言。此选项允许选择退出此行为，以便覆盖层可以在处理程序运行后保持可见。
- times number （可选）在 v1.44 中添加#
  
  指定应调用此处理程序的最大次数。默认情况下无限制。

返回值

Promise<void>#

addScriptTag

在 v1.9 之前添加

page.addScriptTag

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

用法

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

参数

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

返回值

Promise<ElementHandle>#

addStyleTag

在 v1.9 之前添加

page.addStyleTag

将 <link rel="stylesheet"> 标签添加到页面中，其中包含所需的 url 或包含内容的 <style type="text/css"> 标签。当样式表的 onload 事件触发或 CSS 内容注入到框架中时，返回添加的标签。

用法

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

参数

options Object （可选）
- content string （可选）#
  
  要注入到框架中的原始 CSS 内容。
- path string （可选）#
  
  要注入到框架中的 CSS 文件的路径。如果 path 是相对路径，则它相对于当前工作目录解析。
- url string （可选）#
  
  <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 boolean （可选）#
  
  默认为 false。是否运行 before unload 页面处理程序。

返回值

Promise<void>#

content

在 v1.9 之前添加

page.content

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

用法

await page.content();

返回值

Promise<string>#

context

在 v1.9 之前添加

page.context

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

用法

page.context();

返回值

BrowserContext #

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

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

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

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 null | "light" | "dark" | "no-preference" （可选）在 v1.9 中添加#
  
  模拟 prefers-colors-scheme 媒体功能，支持的值为 'light' 和 'dark'。传递 null 禁用颜色方案模拟。'no-preference' 已弃用。
- contrast null | "no-preference" | "more" （可选）在 v1.51 中添加#
  
  模拟 'prefers-contrast' 媒体功能，支持的值为 'no-preference'、'more'。传递 null 禁用对比度模拟。
- forcedColors null | "active" | "none" （可选）在 v1.15 中添加#
  
  模拟 'forced-colors' 媒体功能，支持的值为 'active' 和 'none'。传递 null 禁用强制颜色模拟。
- media null | "screen" | "print" （可选）在 v1.9 中添加#
  
  更改页面的 CSS 媒体类型。唯一允许的值为 'screen'、'print' 和 null。传递 null 禁用 CSS 媒体模拟。
- reducedMotion null | "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() 的函数返回非 Serializable 值，则 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 function | string #

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

传递给 pageFunction 的可选参数。

返回值

Promise<Serializable>#

evaluateHandle

在 v1.9 之前添加

page.evaluateHandle

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

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

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

传递给 pageFunction 的可选参数。

返回值

Promise<JSHandle>#

exposeBinding

在 v1.9 之前添加

page.exposeBinding

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

回调函数的第一个参数包含有关调用者的信息：{ 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 string #

window 对象上函数的名称。
callback 函数 #

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

返回值

Promise<void>#

exposeFunction

在 v1.9 之前添加

page.exposeFunction

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

如果 callback 返回一个 Promise，它将被等待 (await)。

有关上下文范围内的公开函数，请参阅 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 字符串 #

window 对象上的函数名称
callback 函数 #

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

返回值

Promise<void>#

frame

在 v1.9 之前添加

page.frame

返回与指定条件匹配的 frame。必须指定 name 或 url。

用法

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

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

参数

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

返回值

null | Frame #

frameLocator

添加于版本: v1.17

page.frameLocator

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

用法

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

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

参数

selector 字符串 #

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

返回值

FrameLocator #

frames

在 v1.9 之前添加

page.frames

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

用法

page.frames();

返回值

Array<Frame>#

getByAltText

添加于版本: v1.27

page.getByAltText

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

用法

例如，此方法将通过 alt 文本 "Playwright logo" 查找图像

<img alt='Playwright logo'>

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

参数

text 字符串 | 正则表达式 #

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

返回值

Locator #

getByLabel

添加于版本: v1.27

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

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

返回值

Locator #

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。当通过正则表达式定位时忽略。请注意，完全匹配仍然会去除空格。

返回值

Locator #

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。

返回值

Locator #

详情

角色选择器不能替代可访问性审核和一致性测试，而是提供关于 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。

返回值

Locator #

详情

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

// Set custom test id attribute from @playwright/test config:
import { defineConfig } from '@playwright/test';

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

getByText

添加于版本: v1.27

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。当通过正则表达式定位时忽略。请注意，完全匹配仍然会去除空格。

返回值

Locator #

详情

即使使用完全匹配，按文本匹配也始终会规范化空格。例如，它将多个空格变成一个空格，将换行符变成空格，并忽略前导和尾随空格。

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

getByTitle

添加于版本: v1.27

page.getByTitle

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

用法

考虑以下 DOM 结构。

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

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

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

参数

text 字符串 | 正则表达式 #

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

返回值

Locator #

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

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

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 应包含 scheme，例如 https://。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时，它将通过 new URL() 构造函数合并。
options Object （可选）
- referer 字符串 (可选)#
  
  Referer 请求头的值。如果提供，它将优先于 page.setExtraHTTPHeaders() 设置的 referer 请求头值。
- 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<null | Response>#

isClosed

在 v1.9 之前添加

page.isClosed

指示页面是否已关闭。

用法

page.isClosed();

返回值

布尔值 #

locator

在 v1.14 中添加

page.locator

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

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

用法

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

参数

selector 字符串 #

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

返回值

Locator #

mainFrame

在 v1.9 之前添加

page.mainFrame

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

用法

page.mainFrame();

返回值

Frame #

opener

在 v1.9 之前添加

page.opener

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

用法

await page.opener();

返回值

Promise<null | Page>#

pause

在 v1.9 中添加

page.pause

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

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

注意

此方法要求 Playwright 在有头模式下启动，且 headless 选项为 falsy 值。

用法

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 - 毫米

format 选项是

Letter: 8.5 英寸 x 11 英寸
Legal: 8.5 英寸 x 14 英寸
Tabloid: 11 英寸 x 17 英寸
Ledger: 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. 模板内的脚本标签不会被评估。 > 2. 页面样式在模板内不可见。

参数

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

返回值

Promise<Buffer>#

reload

在 v1.9 之前添加

page.reload

此方法重新加载当前页面，方式与用户触发浏览器刷新相同。返回主资源响应。在发生多次重定向的情况下，导航将使用最后一次重定向的响应来解析。

用法

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

参数

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

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 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 拦截的请求。请参阅此问题。我们建议在使用请求拦截时禁用 Service Worker，方法是将 serviceWorkers 设置为 'block'。

注意

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 字符串 | RegExp | function(URL):boolean #

glob 模式、正则表达式模式或谓词，接收 URL 以在路由时进行匹配。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时，它将通过 new URL() 构造函数合并。
handler function(Route, Request):Promise<Object> | Object #

用于路由请求的处理函数。
options Object （可选）
- times number （可选）在 v1.15 中添加#
  
  路由应使用的频率。默认情况下，每次都会使用。

返回值

Promise<void>#

routeFromHAR

添加于：v1.23

page.routeFromHAR

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

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

用法

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

参数

har 字符串 #

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

返回值

Promise<void>#

routeWebSocket

添加于：v1.48

page.routeWebSocket

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

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

用法

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

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

参数

url 字符串 | RegExp | function(URL):boolean #

只有 url 与此模式匹配的 WebSocket 才会被路由。字符串模式可以是相对于 baseURL 上下文选项的相对路径。
handler function(WebSocketRoute):Promise<Object> | Object #

用于路由 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 Object (可选)#
  - x number
    
    剪切区域左上角的 x 坐标
  - y number
    
    剪切区域左上角的 y 坐标
  - width number
    
    剪切区域的宽度
  - height number
    
    剪切区域的高度
  一个指定结果图像剪切的对象。
- fullPage boolean (可选)#
  
  如果为 true，则拍摄整个可滚动页面的屏幕截图，而不是当前可见的视口。默认为 false。
- mask Array<Locator> (可选)#
  
  指定在截取屏幕截图时应被遮罩的定位器 (locators)。被遮罩的元素将被粉色框 #FF00FF (可通过 maskColor 自定义) 覆盖，完全遮盖其边界框。遮罩也适用于不可见元素，请参阅仅匹配可见元素以禁用此功能。
- maskColor string (可选)添加于: v1.35#
  
  指定遮罩元素的覆盖框颜色，使用 CSS 颜色格式。默认颜色为粉色 #FF00FF。
- omitBackground boolean (可选)#
  
  隐藏默认的白色背景，并允许捕获透明背景的屏幕截图。不适用于 jpeg 图像。默认为 false。
- path string (可选)#
  
  保存图像的文件路径。屏幕截图类型将从文件扩展名推断。如果 path 是相对路径，则它相对于当前工作目录解析。如果未提供路径，则图像不会保存到磁盘。
- quality number (可选)#
  
  图像质量，介于 0-100 之间。不适用于 png 图像。
- scale "css" | "device" (可选)#
  
  当设置为 "css" 时，屏幕截图的每个 css 像素对应一个像素。对于高 dpi 设备，这将保持屏幕截图较小。使用 "device" 选项将使每个设备像素对应一个像素，因此高 dpi 设备的屏幕截图将是两倍甚至更大。
  
  默认为 "device"。
- style string (可选)添加于: 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 #

一个 glob 模式、正则表达式模式或谓词，用于接收 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 number (可选)
  
  最大等待时间，单位为毫秒。默认为 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 #

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

返回值

Promise<void>#

workers

在 v1.9 之前添加

page.workers

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

注意

这不包含 ServiceWorkers

用法

page.workers();

返回值

Array<Worker>#

Properties

clock

添加于: v1.45

page.clock

Playwright 具有模拟时钟和时间流逝的能力。

用法

page.clock

Type

Clock

coverage

在 v1.9 之前添加

page.coverage

注意

目前仅适用于 Chromium。

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

用法

page.coverage

Type

Coverage

keyboard

在 v1.9 之前添加

page.keyboard

用法

page.keyboard

Type

Keyboard

mouse

在 v1.9 之前添加

page.mouse

用法

page.mouse

Type

Mouse

request

添加于: v1.16

page.request

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

用法

page.request

Type

APIRequestContext

touchscreen

在 v1.9 之前添加

page.touchscreen

用法

page.touchscreen

Type

Touchscreen

Events

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')

当一个 frame 被附加时，会发出该事件。

用法

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

事件数据

Frame

on('framedetached')

在 v1.9 中添加

page.on('framedetached')

当一个 frame 被分离时，会发出该事件。

用法

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

事件数据

Frame

on('framenavigated')

在 v1.9 中添加

page.on('framenavigated')

当一个 frame 导航到一个新的 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 的角度来看，HTTP 错误响应（如 404 或 503）仍然是成功的响应，因此请求将以 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.$

不鼓励使用

请改用基于 locator 的 page.locator()。阅读更多关于 locators 的信息。

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

用法

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

参数

selector string #

要查询的选择器。
options Object （可选）
- strict boolean （可选）在 v1.14 中添加#
  
  为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

返回值

Promise<null | ElementHandle>#

$$

在 v1.9 中添加

page.$$

不鼓励使用

请改用基于 locator 的 page.locator()。阅读更多关于 locators 的信息。

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

用法

await page.$$(selector);

参数

selector string #

要查询的选择器。

返回值

Promise<Array<ElementHandle>>#

$eval

在 v1.9 中添加

page.$eval

不鼓励使用

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

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

如果 pageFunction 返回一个 Promise，则 page.$eval() 将等待 promise resolve 并返回其值。

用法

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 boolean （可选）在 v1.14 中添加#
  
  为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。

返回值

Promise<Serializable>#

$$eval

在 v1.9 中添加

page.$$eval

不鼓励使用

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

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

如果 pageFunction 返回一个 Promise，则 page.$$eval() 将等待 promise resolve 并返回其值。

用法

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

Type

Accessibility

check

在 v1.9 之前添加

page.check

不鼓励使用

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

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

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

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

用法

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

参数

selector string #

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

返回值

Promise<void>#

click

在 v1.9 之前添加

page.click

不鼓励使用

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

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

查找与 selector 匹配的元素。如果没有找到，则等待直到匹配的元素附加到 DOM。
等待对匹配元素执行 actionability 检查，除非设置了 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 number
  - y number
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- strict boolean （可选）在 v1.14 中添加#
  
  为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- timeout number (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 false。用于等待元素准备好执行操作而无需实际执行操作。请注意，无论 trial 的值如何，都会按下键盘 modifiers，以允许测试仅在按下这些键时才可见的元素。

返回值

Promise<void>#

dblclick

在 v1.9 之前添加

page.dblclick

不鼓励使用

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

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

查找与 selector 匹配的元素。如果没有找到，则等待直到匹配的元素附加到 DOM。
等待对匹配元素执行 actionability 检查，除非设置了 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 number
  - y number
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- strict boolean （可选）在 v1.14 中添加#
  
  为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- timeout number (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 false。用于等待元素准备好执行操作而无需实际执行操作。请注意，无论 trial 的值如何，都会按下键盘 modifiers，以允许测试仅在按下这些键时才可见的元素。

返回值

Promise<void>#

dispatchEvent

在 v1.9 之前添加

page.dispatchEvent

不鼓励使用

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

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

用法

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

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

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

返回值

Promise<void>#

fill

在 v1.9 之前添加

page.fill

不鼓励使用

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

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

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

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

用法

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

参数

selector string #

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

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

返回值

Promise<void>#

focus

在 v1.9 之前添加

page.focus

不鼓励使用

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

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

用法

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

参数

selector string #

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

返回值

Promise<void>#

getAttribute

在 v1.9 之前添加

page.getAttribute

不鼓励使用

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

返回元素属性值。

用法

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

参数

selector string #

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

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

返回值

Promise<null | string>#

hover

在 v1.9 之前添加

page.hover

不鼓励使用

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

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

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

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

用法

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

参数

selector 字符串 #

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

返回值

Promise<void>#

innerHTML

在 v1.9 之前添加

page.innerHTML

不鼓励使用

使用基于 locator 的 locator.innerHTML() 代替。阅读更多关于 locators 的信息。

返回 element.innerHTML。

用法

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

参数

selector 字符串 #

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

返回值

Promise<字符串>#

innerText

在 v1.9 之前添加

page.innerText

不鼓励使用

使用基于 locator 的 locator.innerText() 代替。阅读更多关于 locators 的信息。

返回 element.innerText。

用法

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

参数

selector 字符串 #

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

返回值

Promise<字符串>#

inputValue

在 v1.13 中添加

page.inputValue

不鼓励使用

使用基于 locator 的 locator.inputValue() 代替。阅读更多关于 locators 的信息。

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

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

用法

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

参数

selector 字符串 #

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

返回值

Promise<字符串>#

isChecked

在 v1.9 之前添加

page.isChecked

不鼓励使用

使用基于 locator 的 locator.isChecked() 代替。阅读更多关于 locators 的信息。

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

用法

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

参数

selector 字符串 #

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

返回值

Promise<布尔值>#

isDisabled

在 v1.9 之前添加

page.isDisabled

不鼓励使用

使用基于 locator 的 locator.isDisabled() 代替。阅读更多关于 locators 的信息。

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

用法

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

参数

selector 字符串 #

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

返回值

Promise<布尔值>#

isEditable

在 v1.9 之前添加

page.isEditable

不鼓励使用

使用基于 locator 的 locator.isEditable() 代替。阅读更多关于 locators 的信息。

返回元素是否是可编辑的。

用法

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

参数

selector 字符串 #

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

返回值

Promise<布尔值>#

isEnabled

在 v1.9 之前添加

page.isEnabled

不鼓励使用

使用基于 locator 的 locator.isEnabled() 代替。阅读更多关于 locators 的信息。

返回元素是否是启用的。

用法

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

参数

selector 字符串 #

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

返回值

Promise<布尔值>#

isHidden

在 v1.9 之前添加

page.isHidden

不鼓励使用

使用基于 locator 的 locator.isHidden() 代替。阅读更多关于 locators 的信息。

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

用法

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

参数

selector 字符串 #

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

返回值

Promise<布尔值>#

isVisible

在 v1.9 之前添加

page.isVisible

不鼓励使用

使用基于 locator 的 locator.isVisible() 代替。阅读更多关于 locators 的信息。

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

用法

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

参数

selector 字符串 #

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

返回值

Promise<布尔值>#

press

在 v1.9 之前添加

page.press

不鼓励使用

使用基于 locator 的 locator.press() 代替。阅读更多关于 locators 的信息。

聚焦元素，然后使用 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 键将键入与大写 key 相对应的文本。

如果 key 是单个字符，则它区分大小写，因此值 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 boolean （可选）在 v1.14 中添加#
  
  为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

返回值

Promise<void>#

selectOption

在 v1.9 之前添加

page.selectOption

不鼓励使用

使用基于 locator 的 locator.selectOption() 代替。阅读更多关于 locators 的信息。

此方法等待与 selector 匹配的元素，等待 actionability 检查，等待所有指定的选项都存在于 <select> 元素中，并选择这些选项。

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

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

一旦所有提供的选项都被选中，就会触发 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 boolean (可选)在 v1.13 中添加#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- strict boolean （可选）在 v1.14 中添加#
  
  为 true 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或通过使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

返回值

Promise<数组<字符串>>#

setChecked

在 v1.15 中添加

page.setChecked

不鼓励使用

使用基于 locator 的 locator.setChecked() 代替。阅读更多关于 locators 的信息。

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

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

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

用法

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

参数

selector 字符串 #

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

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

返回值

Promise<void>#

setInputFiles

在 v1.9 之前添加

page.setInputFiles

不鼓励使用

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

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

此方法期望 selector 指向一个 input 元素。但是，如果元素位于具有关联 control 的 <label> 元素内，则目标是 control。

用法

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

参数

selector 字符串 #

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

返回值

Promise<void>#

tap

在 v1.9 之前添加

page.tap

不鼓励使用

使用基于 locator 的 locator.tap() 代替。阅读更多关于 locators 的信息。

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

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

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

注意

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

返回值

Promise<void>#

textContent

在 v1.9 之前添加

page.textContent

不鼓励使用

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

返回 element.textContent。

用法

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

参数

selector 字符串 #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个。
options Object （可选）
- strict boolean （可选）在 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 string #

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

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

返回值

Promise<void>#

uncheck

在 v1.9 之前添加

page.uncheck

不鼓励使用

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

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

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

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

用法

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

参数

selector string #

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

返回值

Promise<void>#

在 v1.9 之前添加

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 number (可选)#
  
  最大操作时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 navigationTimeout 选项更改，或者使用 browserContext.setDefaultNavigationTimeout()、browserContext.setDefaultTimeout()、page.setDefaultNavigationTimeout() 或 page.setDefaultTimeout() 方法。
- url string | RegExp | function(URL):boolean (可选)#
  
  一个 glob 模式、正则表达式模式或谓词，用于接收 URL 以在等待导航时进行匹配。请注意，如果参数是不带通配符的字符串，则该方法将等待导航到与该字符串完全相同的 URL。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#
  
  何时认为操作成功，默认为 load。事件可以是
  - 'domcontentloaded' - 当 DOMContentLoaded 事件被触发时，认为操作已完成。
  - 'load' - 当 load 事件被触发时，认为操作已完成。
  - 'networkidle' - 不推荐使用 当至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，请依赖 Web 断言来评估就绪状态。
  - 'commit' - 当接收到网络响应并且文档开始加载时，认为操作已完成。

返回值

Promise<null | Response>#

waitForSelector

在 v1.9 之前添加

page.waitForSelector

不鼓励使用

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

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

注意

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

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

用法

此方法跨导航工作

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

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

参数

selector string #

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

返回值

Promise<null | ElementHandle>#

waitForTimeout

在 v1.9 之前添加

page.waitForTimeout

不鼓励使用

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

等待给定的 timeout 毫秒数。

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

用法

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

参数

timeout number #

要等待的超时时间

返回值

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​

Properties​

clock​

coverage​

keyboard​

mouse​

request​

touchscreen​

Events​

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

Properties

clock

coverage

keyboard

mouse

request

touchscreen

Events

on('close')

on('console')

on('crash')

on('dialog')

on('domcontentloaded')

on('download')

on('filechooser')

on('frameattached')

on('framedetached')

on('framenavigated')

on('load')

on('pageerror')