跳转到主要内容

Page

Page 提供用于与 Browser 中的单个标签页，或 Chromium 中的 扩展后台页面 进行交互的方法。一个 Browser 实例可能包含多个 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 的可选参数（仅在传递函数时支持）。

返回

addLocatorHandler​

新增于: v1.42 page.addLocatorHandler

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

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

要记住的事情

  • 当覆盖层（overlay）可预测地出现时，我们建议在测试中显式等待它并在正常的测试流程中将其关闭，而不是使用 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 将等到覆盖层隐藏后才会继续执行触发处理程序的操作/断言。此选项允许选择退出此行为，以便在处理程序运行后覆盖层可以保持可见。

    • times number (可选)新增于：v1.44#

      指定此处理程序应被调用的最大次数。默认无限制。

返回

addScriptTag​

v1.9 之前添加 page.addScriptTag

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

用法

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

参数

  • options Object (可选)

    • content string (可选)#

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

    • path string (可选)#

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

    • type string (可选)#

      脚本类型。要加载 JavaScript ES6 模块，请使用 'module'。有关详细信息，请参阅 script。

    • url string (可选)#

      要添加的脚本的 URL。

返回

addStyleTag​

v1.9 之前添加 page.addStyleTag

向页面中添加一个带有所需 URL 的 <link rel="stylesheet"> 标签，或者一个带有内容的 <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。

返回

ariaSnapshot​

新增于: v1.59 page.ariaSnapshot

捕获页面的 aria 快照。阅读更多关于 aria 快照 的信息。

用法

await page.ariaSnapshot();
await page.ariaSnapshot(options);

参数

  • options Object (可选)

    • boxes boolean (可选)添加于: v1.60#

      当设为 true 时，会将每个元素的边界框追加为 [box=x,y,width,height] 到快照中。坐标相对于视口，单位为 CSS 像素，由 Element.getBoundingClientRect() 返回。默认值为 false。

    • depth number (可选)#

      指定时，限制快照的深度。

    • mode "ai" | "default" (可选)#

      当设置为 "ai" 时，返回针对 AI 使用优化的快照：包括元素引用（如 [ref=e2]）和 <iframe> 的快照。默认为 "default"。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

bringToFront​

v1.9 之前添加 page.bringToFront

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

用法

await page.bringToFront();

返回

cancelPickLocator​

新增于: v1.59 page.cancelPickLocator

通过停用选择定位器模式来取消正在进行的 page.pickLocator() 调用。如果当前没有激活选择定位器模式，则此方法为空操作。

用法

await page.cancelPickLocator();

返回

clearConsoleMessages​

新增于: v1.59 page.clearConsoleMessages

清除此页面中存储的所有控制台消息。后续对 page.consoleMessages() 的调用将仅返回清除后记录的消息。

用法

await page.clearConsoleMessages();

返回

clearPageErrors​

新增于: v1.59 page.clearPageErrors

清除此页面中存储的所有页面错误。后续对 page.pageErrors() 的调用将仅返回清除后抛出的错误。

用法

await page.clearPageErrors();

返回

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 页面处理程序。

返回

consoleMessages​

添加于: v1.56 page.consoleMessages

返回此页面最近（目前为）200 条控制台消息。详情请参见 page.on('console')。

用法

await page.consoleMessages();
await page.consoleMessages(options);

参数

  • options Object (可选)

    • filter "all" | "since-navigation" (可选)新增于: v1.59#

      控制返回哪些消息

返回

content​

v1.9 之前添加 page.content

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

用法

await page.content();

返回

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

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

  • target string#

    用于搜索要拖放到的元素的选取器。如果有多个元素满足选取器，则使用第一个。

  • options Object (可选)

    • force boolean (可选)#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • sourcePosition Object (可选)新增于：v1.14#

      在此点（相对于元素内边距框的左上角）点击源元素。如果未指定，则使用元素的某个可见点。

    • steps number (可选)Added in: v1.57#

      默认为 1。发送 n 个插值的 mousemove 事件以表示从 mousedown 到 mouseup 的拖动过程。当设置为 1 时，在目标位置发出单个 mousemove 事件。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • targetPosition Object (可选)新增于：v1.14#

      在此点（相对于元素内边距框的左上角）拖放到目标元素。如果未指定，则使用元素的某个可见点。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

    • trial boolean (可选)#

      设置时，此方法仅执行 可操作性 检查并跳过实际动作。默认值为 false。适用于在不执行动作的情况下等待元素就绪。

返回

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 会禁用减速运动模拟。

返回

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.evaluateHandle('document.body');
const html = await page.evaluate<string, HTMLElement>(([body, suffix]) =>
  body.innerHTML + suffix, [bodyHandle, 'hello']
);
await bodyHandle.dispose();

参数

返回

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

参数

返回

exposeBinding​

v1.9 之前添加 page.exposeBinding

此方法在页面中每个帧的 window 对象上添加一个名为 name 的函数。调用该函数时，它将执行 callback 并返回一个解析为 callback 返回值的 Promise。如果 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 string#

    窗口对象上函数的名称。

  • callback function#

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

返回

exposeFunction​

v1.9 之前添加 page.exposeFunction

该方法在页面中每个帧的 window 对象上添加一个名为 name 的函数。调用该函数时，它将执行 callback 并返回一个解析为 callback 返回值的 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 string#

    窗口对象上函数的名称

  • callback function#

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

返回

frame​

v1.9 之前添加 page.frame

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

用法

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

参数

  • frameSelector string | Object#

    • name string (可选)

      在 iframe 的 name 属性中指定的帧名称。可选。

    • url string | RegExp | [URLPattern] | function(URL):boolean (可选)

      一个 glob 模式、正则表达式、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 string#

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

返回

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

    用于定位元素的文本。

  • options Object (可选)

    • exact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 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 string | RegExp#

    用于定位元素的文本。

  • options Object (可选)

    • exact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 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 string | RegExp#

    用于定位元素的文本。

  • options Object (可选)

    • exact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

返回

getByRole​

新增于：v1.27 page.getByRole

允许通过元素的 ARIA 角色、ARIA 属性 和 可访问名称（accessible name） 来定位元素。

用法

考虑以下 DOM 结构。

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

您可以按其隐式角色定位每个元素

await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();

await page.getByRole('checkbox', { name: 'Subscribe' }).check();

await page.getByRole('button', { name: /submit/i }).click();

参数

  • role "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"#

    所需的 aria 角色。

  • options Object (可选)

    • checked boolean (可选)#

      通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。

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

    • description string | RegExp (可选)添加于: v1.60#

      用于匹配 可访问描述 的选项。默认情况下，匹配是不区分大小写的，并且搜索子字符串；使用 exact 来控制此行为。

      了解更多关于 可访问描述 的信息。

    • disabled boolean (可选)#

      通常由 aria-disabled 或 disabled 设置的属性。

      注意

      与大多数其他属性不同，disabled 通过 DOM 层级结构继承。了解更多关于 aria-disabled 的信息。

    • exact boolean (可选)新增于: v1.28#

      name 和 description 是否精确匹配：区分大小写且完整字符串匹配。默认为 false。当值为正则表达式时会被忽略。请注意，精确匹配仍会修剪空格。

    • expanded boolean (可选)#

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

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

    • includeHidden boolean (可选)#

      控制是否匹配隐藏元素的选项。默认情况下，角色选择器仅匹配 ARIA 定义 中的非隐藏元素。

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

    • level number (可选)#

      通常用于角色 heading、listitem、row、treeitem 的数字属性，<h1>-<h6> 元素具有默认值。

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

    • name string | RegExp (可选)#

      用于匹配 可访问名称 的选项。默认情况下，匹配是不区分大小写的，并且搜索子字符串；使用 exact 来控制此行为。

      了解更多关于 可访问名称 的信息。

    • pressed boolean (可选)#

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

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

    • selected boolean (可选)#

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

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

返回

详情

角色选择器 不替代 可访问性审计和合规性测试，而是提供有关 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();

参数

返回

详情

默认情况下，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 string | RegExp#

    用于定位元素的文本。

  • options Object (可选)

    • exact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 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 string | RegExp#

    用于定位元素的文本。

  • options Object (可选)

    • exact boolean (可选)#

      是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

返回

goBack​

v1.9 之前添加 page.goBack

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

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

用法

await page.goBack();
await page.goBack(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' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

goForward​

v1.9 之前添加 page.goForward

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

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

用法

await page.goForward();
await page.goForward(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' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

goto​

v1.9 之前添加 page.goto

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

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

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

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

注意

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

注意

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

用法

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

参数

  • url string#

    导航到的 URL。URL 应包含协议，例如 https://。当通过上下文选项提供了 baseURL 且传入的 URL 是路径时，它会通过 new URL() 构造函数进行合并。

  • options Object (可选)

    • referer string (可选)#

      Referer 请求头值。如果提供，它将优先于由 page.setExtraHTTPHeaders() 设置的 referer 请求头值。

    • timeout number (可选)#

      最大操作时间（以毫秒为单位）。默认为 0 - 不超时。可以通过配置中的 navigationTimeout 选项，或使用 browserContext.setDefaultNavigationTimeout()、browserContext.setDefaultTimeout()、page.setDefaultNavigationTimeout() 或 page.setDefaultTimeout() 方法更改默认值。

    • waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

      何时认为操作成功，默认为 load。事件可以是以下之一

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
      • 'load' - 当 load 事件触发时，认为操作完成。
      • 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
      • 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

hideHighlight​

添加于: v1.60 page.hideHighlight

隐藏页面上之前由 locator.highlight() 添加的所有定位器高亮覆盖层。

用法

await page.hideHighlight();

返回

isClosed​

v1.9 之前添加 page.isClosed

指示页面已关闭。

用法

page.isClosed();

返回

locator​

新增于：v1.14 page.locator

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

了解更多关于定位器.

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • has Locator (可选)#

      将方法的返回结果缩小到包含匹配此相对定位器的元素的结果。例如，article 包含 text=Playwright 匹配 <article><div>Playwright</div></article>。

      内部定位器必须相对于外部定位器，并且从外部定位器匹配而不是文档根开始查询。例如，你可以在 <article><content><div>Playwright</div></content></article> 中查找包含 div 的 content。但是，查找包含 article div 的 content 会失败，因为内部定位器必须是相对的，不应使用 content 之外的任何元素。

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

    • hasNot Locator (可选)新增于：v1.33#

      匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器查询的。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。

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

    • hasNotText string | RegExp (可选)新增于：v1.33#

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

    • hasText string | RegExp (可选)#

      匹配包含指定文本的元素，可能在子元素或后代元素中。当传入 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 可以匹配 <article><div>Playwright</div></article>。

返回

mainFrame​

v1.9 之前添加 page.mainFrame

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

用法

page.mainFrame();

返回

opener​

v1.9 之前添加 page.opener

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

用法

await page.opener();

返回

pageErrors​

添加于: v1.56 page.pageErrors

返回此页面最近（目前为）200 条页面错误。详情请参见 page.on('pageerror')。

用法

await page.pageErrors();
await page.pageErrors(options);

参数

  • options Object (可选)

    • filter "all" | "since-navigation" (可选)新增于: v1.59#

      控制返回哪些错误

返回

pause​

添加于：v1.9 page.pause

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

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

注意

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

用法

await page.pause();

返回

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 选项包括

  • 信纸: 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. 模板内的脚本标签不会被计算。> 2. 页面样式在模板内不可见。

参数

  • options Object (可选)

    • displayHeaderFooter boolean (可选)#

      显示页眉和页脚。默认为 false。

    • footerTemplate string (可选)#

      用于打印页脚的 HTML 模板。应使用与 headerTemplate 相同的格式。

    • format string (可选)#

      纸张格式。如果设置，优先级高于 width 或 height 选项。默认为 'Letter'。

    • headerTemplate string (可选)#

      打印页眉的 HTML 模板。应为有效 HTML 标记，其中以下类用于注入打印值

      • 'date' 格式化的打印日期
      • 'title' 文档标题
      • 'url' 文档位置
      • 'pageNumber' 当前页码
      • 'totalPages' 文档总页数

    • height string | number (可选)#

      纸张高度，接受带单位的值。

    • landscape boolean (可选)#

      纸张方向。默认为 false。

    • margin Object (可选)#

      • top string | number (可选)

        上边距，接受带单位的值。默认为 0。

      • right string | number (可选)

        右边距，接受带单位的值。默认为 0。

      • bottom string | number (可选)

        下边距，接受带单位的值。默认为 0。

      • left string | number (可选)

        左边距，接受带单位的值。默认为 0。

      纸张边距，默认为无。

    • outline boolean (可选)新增于: v1.42#

      是否将文档大纲嵌入 PDF。默认为 false。

    • pageRanges string (可选)#

      要打印的页面范围，例如 '1-5, 8, 11-13'。默认为空字符串，表示打印所有页面。

    • path string (可选)#

      保存 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 string | number (可选)#

      纸张宽度，接受带单位的值。

返回

pickLocator​

新增于: v1.59 page.pickLocator

进入选择定位器模式，在该模式下悬停在页面元素上会突出显示它们并显示相应的定位器。一旦用户点击某个元素，该模式即被停用，并返回所选元素的 Locator。

用法

const locator = await page.pickLocator();
console.log(locator);

返回

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' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

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 string (可选)#
  • options Object (可选)

    • behavior "wait" | "ignoreErrors" | "default" (可选)#

      指定是否等待已经运行的监听器以及如果它们抛出错误该怎么做

      • 'default' - 不等待当前监听器调用（如果有的话）完成，如果监听器抛出错误，可能会导致未处理的错误
      • 'wait' - 等待当前监听器调用（如果有的话）完成
      • 'ignoreErrors' - 不等待当前监听器调用（如果有的话）完成，监听器在移除后抛出的所有错误都将被静默捕获

返回

removeLocatorHandler​

新增于：v1.44 page.removeLocatorHandler

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

用法

await page.removeLocatorHandler(locator);

参数

返回

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

返回

requests​

添加于: v1.56 page.requests

返回此页面最近（目前为）100 条网络请求。详情请参见 page.on('request')。

应立即访问返回的请求，否则可能会收集它们以防止随着新请求的到来而无限制地增长内存。一旦收集，检索请求的大部分信息是不可能的。

请注意，通过 page.on('request') 报告的请求不会被收集，因此在利用 page.requests() 进行高效内存使用和通过 page.on('request') 报告可用信息量之间存在权衡。

用法

await page.requests();

返回

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 string | RegExp | [URLPattern] | function(URL):boolean#

    一个 glob 模式、正则表达式、URL 模式或接收 URL 进行匹配的谓词。如果上下文选项中设置了 baseURL 且提供的 URL 是不以 * 开头的字符串，它将使用 new URL() 构造函数进行解析。

  • handler function(Route, Request):Promise<Object> | Object#

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

  • options Object (可选)

    • times number (可选)新增于: v1.15#

      路由应该被使用多少次。默认情况下，每次都会使用。

返回

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

    包含预录制网络数据的 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 信息中不用于从 HAR 重放的大小、时间、页面、cookie、安全性和其他类型的信息。默认为 minimal。

    • url string | RegExp (可选)#

      一个 glob 模式、正则表达式或谓词，用于匹配请求 URL。只有 URL 匹配模式的请求将从 HAR 文件中提供。如果未指定，所有请求都将从 HAR 文件中提供。

返回

routeWebSocket​

新增于: v1.48 page.routeWebSocket

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

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

用法

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

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

参数

返回

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> (可选)#

      指定截图时应遮盖的定位器。被遮盖的元素将覆盖一个粉色的框 #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。

返回

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' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

setDefaultNavigationTimeout​

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 标头的对象。所有标头值必须是字符串。

返回

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

      页面高度（像素）。

返回

title​

v1.9 之前添加 page.title

返回页面的标题。

用法

await page.title();

返回

unroute​

v1.9 之前添加 page.unroute

移除使用 page.route() 创建的路由。当未指定 handler 时，会移除 url 的所有路由。

用法

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

参数

返回

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' - 不等待当前处理程序调用 (如果有) 完成，取消路由后处理程序抛出的所有错误都将被静默捕获

返回

url​

v1.9 之前添加 page.url

用法

page.url();

返回

video​

v1.9 之前添加 page.video

与此页面关联的视频对象。当使用 recordVideo 上下文选项时，可用于访问视频文件。

用法

page.video();

返回

viewportSize​

v1.9 之前添加 page.viewportSize

用法

page.viewportSize();

返回

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 (可选)#

    一个接收事件的谓词或一个选项对象。可选。

  • options Object (可选)

    • predicate function (可选)#

      接收事件数据，并在等待应该解决时解析为真值。

返回

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

参数

返回

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 (可选)

返回

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;

参数

返回

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;

参数

返回

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 | [URLPattern] | function(URL):boolean#

    导航时匹配的 glob 模式、正则模式、URL 模式或接收 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' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

workers​

v1.9 之前添加 page.workers

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

注意

这不包含 ServiceWorkers

用法

page.workers();

返回

属性​

clock​

新增于: v1.45 page.clock

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

用法

page.clock

类型

coverage​

v1.9 之前添加 page.coverage
注意

目前仅适用于 Chromium。

浏览器特定的 Coverage 实现。有关更多详情，请参见 Coverage。

用法

page.coverage

类型

keyboard​

v1.9 之前添加 page.keyboard

用法

page.keyboard

类型

localStorage​

添加于：v1.61 page.localStorage

提供对当前源页面 localStorage 的访问。参见 WebStorage。

await page.localStorage.setItem('token', 'abc');
const token = await page.localStorage.getItem('token');

用法

page.localStorage

类型

mouse​

v1.9 之前添加 page.mouse

用法

page.mouse

类型

request​

添加于：v1.16 page.request

与此页面关联的 API 测试辅助工具。此方法返回与页面上下文上的 browserContext.request 相同的实例。有关更多详情，请参见 browserContext.request。

用法

page.request

类型

screencast​

新增于: v1.59 page.screencast

与此页面关联的 Screencast 对象。

用法

page.screencast.on('screencastFrame', data => {
  console.log('received frame, jpeg size:', data.length);
});
await page.screencast.start();
// ... perform actions ...
await page.screencast.stop();

类型

sessionStorage​

添加于：v1.61 page.sessionStorage

提供对当前源页面 sessionStorage 的访问。参见 WebStorage。

await page.sessionStorage.setItem('flag', '1');
const flag = await page.sessionStorage.getItem('flag');

用法

page.sessionStorage

类型

touchscreen​

v1.9 之前添加 page.touchscreen

用法

page.touchscreen

类型

Events​

on('close')​

v1.9 之前添加 page.on('close')

当页面关闭时发出。

用法

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

事件数据

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

事件数据

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 => {});

事件数据

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') 监听器时，所有对话框都会自动关闭。

事件数据

on('domcontentloaded')​

添加于：v1.9 page.on('domcontentloaded')

当 JavaScript DOMContentLoaded 事件被分发时触发。

用法

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

事件数据

on('download')​

v1.9 之前添加 page.on('download')

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

用法

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

事件数据

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 => {});

事件数据

on('frameattached')​

添加于：v1.9 page.on('frameattached')

当框架附加时发出。

用法

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

事件数据

on('framedetached')​

添加于：v1.9 page.on('framedetached')

当框架分离时发出。

用法

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

事件数据

on('framenavigated')​

添加于：v1.9 page.on('framenavigated')

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

用法

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

事件数据

on('load')​

v1.9 之前添加 page.on('load')

当 JavaScript load 事件被分发时触发。

用法

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

事件数据

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 => {});

事件数据

on('popup')​

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 => {});

事件数据

on('request')​

v1.9 之前添加 page.on('request')

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

用法

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

事件数据

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 => {});

事件数据

on('requestfinished')​

添加于：v1.9 page.on('requestfinished')

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

用法

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

事件数据

on('response')​

v1.9 之前添加 page.on('response')

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

用法

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

事件数据

on('websocket')​

添加于：v1.9 page.on('websocket')

当发送 WebSocket 请求时触发。

用法

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

事件数据

on('worker')​

v1.9 之前添加 page.on('worker')

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

用法

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

事件数据

已弃用​

$​

添加于：v1.9 page.$
不推荐

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

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

用法

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

参数

  • selector string#

    要查询的选择器。

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

返回

$$​

添加于：v1.9 page.$$
不推荐

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

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

用法

await page.$$(selector);

参数

  • selector string#

    要查询的选择器。

返回

$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 boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

返回

$$eval​

添加于：v1.9 page.$$eval
不推荐

在大多数情况下，locator.evaluateAll()、其他 Locator 辅助方法和基于 Web 的断言能做得更好。

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

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

用法

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

参数

返回

check​

v1.9 之前添加 page.check
不推荐

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

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

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

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

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • force boolean (可选)#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position Object (可选)添加于：v1.11#

      相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

    • trial boolean (可选)添加于：v1.11#

      设置时，此方法仅执行 可操作性 检查并跳过实际动作。默认值为 false。适用于在不执行动作的情况下等待元素就绪。

返回

click​

v1.9 之前添加 page.click
不推荐

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

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

  1. 查找匹配 selector 的元素。如果没有，等待直到匹配的元素附加到 DOM。
  2. 等待对匹配元素的 可操作性 检查，除非设置了 force 选项。如果在检查过程中元素被分离，则会重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.mouse 点击元素中心，或指定的 position。
  5. 等待已启动的导航成功或失败，除非设置了 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 (可选)#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#

      要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项将来默认为 true。

      发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。

    • position Object (可选)#

      相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

    • trial boolean (可选)添加于：v1.11#

      设置时，此方法仅执行 可操作性 检查并跳过实际动作。默认值为 false。适用于在不执行动作的情况下等待元素就绪。注意，无论是否处于 trial 模式，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回

dblclick​

v1.9 之前添加 page.dblclick
不推荐

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

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

  1. 查找匹配 selector 的元素。如果没有，等待直到匹配的元素附加到 DOM。
  2. 等待对匹配元素的 可操作性 检查，除非设置了 force 选项。如果在检查过程中元素被分离，则会重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 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 (可选)#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#

      要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position Object (可选)#

      相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

    • trial boolean (可选)添加于：v1.11#

      设置时，此方法仅执行 可操作性 检查并跳过实际动作。默认值为 false。适用于在不执行动作的情况下等待元素就绪。注意，无论是否处于 trial 模式，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回

dispatchEvent​

v1.9 之前添加 page.dispatchEvent
不推荐

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

下面的代码片段在元素上分发 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 boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

fill​

v1.9 之前添加 page.fill
不推荐

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

此方法等待匹配 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 boolean (可选)添加于：v1.13#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

focus​

v1.9 之前添加 page.focus
不推荐

请改为使用基于定位器的 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() 方法来设置。

返回

getAttribute​

v1.9 之前添加 page.getAttribute
不推荐

请改为使用基于定位器的 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() 方法来设置。

返回

hover​

v1.9 之前添加 page.hover
不推荐

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

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

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

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

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • force boolean (可选)#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#

      要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

    • noWaitAfter boolean (可选)新增于: v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • position Object (可选)#

      相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

    • trial boolean (可选)添加于：v1.11#

      设置时，此方法仅执行 可操作性 检查并跳过实际动作。默认值为 false。适用于在不执行动作的情况下等待元素就绪。注意，无论是否处于 trial 模式，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回

innerHTML​

v1.9 之前添加 page.innerHTML
不推荐

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

返回 element.innerHTML。

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

innerText​

v1.9 之前添加 page.innerText
不推荐

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

返回 element.innerText。

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

inputValue​

添加于：v1.13 page.inputValue
不推荐

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

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

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

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

isChecked​

v1.9 之前添加 page.isChecked
不推荐

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

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

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

isDisabled​

v1.9 之前添加 page.isDisabled
不推荐

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

返回元素是否处于禁用状态，与 enabled 相反。

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

isEditable​

v1.9 之前添加 page.isEditable
不推荐

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

返回元素是否可编辑。

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

isEnabled​

v1.9 之前添加 page.isEnabled
不推荐

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

返回元素是否 启用。

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

isHidden​

v1.9 之前添加 page.isHidden
不推荐

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

返回元素是否处于隐藏状态，即 可见（visible） 的反义词。不匹配任何元素的 选择器 将被视为隐藏。

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      已弃用

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

返回

isVisible​

v1.9 之前添加 page.isVisible
不推荐

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

返回元素是否 可见（visible）。不匹配任何元素的 选择器 将被视为不可见。

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      已弃用

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

返回

press​

v1.9 之前添加 page.press
不推荐

请改用基于定位器的 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 string#

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

  • key string#

    要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。

  • options Object (可选)

    • delay number (可选)#

      keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项将来默认为 true。

      发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

selectOption​

v1.9 之前添加 page.selectOption
不推荐

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

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

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

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

  • values null | string | ElementHandle | Array<string> | Object | Array<ElementHandle> | Array<Object>#

    • value string (可选)

      按 option.value 匹配。可选。

    • label string (可选)

      按 option.label 匹配。可选。

    • index number (可选)

      按索引匹配。可选。

    要选择的选项。如果 <select> 具有 multiple 属性，则选择所有匹配的选项，否则仅选择与传入选项之一匹配的第一个选项。字符串值同时匹配值和标签。当所有指定的属性都匹配时，认为选项匹配。

  • options Object (可选)

    • force boolean (可选)添加于：v1.13#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

setChecked​

新增于: v1.15 page.setChecked
不推荐

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

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

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

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

用法

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

参数

  • selector string#

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

  • checked boolean#

    是否选中或取消选中复选框。

  • options Object (可选)

    • force boolean (可选)#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position Object (可选)#

      相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

    • strict boolean (可选)#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

    • trial boolean (可选)#

      设置时，此方法仅执行 可操作性 检查并跳过实际动作。默认值为 false。适用于在不执行动作的情况下等待元素就绪。

返回

setInputFiles​

v1.9 之前添加 page.setInputFiles
不推荐

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

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

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

用法

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

参数

  • selector string#

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

  • files string | Array<string> | Object | Array<Object>#

  • options Object (可选)

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

tap​

v1.9 之前添加 page.tap
不推荐

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

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

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

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

注意

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

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • force boolean (可选)#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#

      要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position Object (可选)#

      相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

    • trial boolean (可选)添加于：v1.11#

      设置时，此方法仅执行 可操作性 检查并跳过实际动作。默认值为 false。适用于在不执行动作的情况下等待元素就绪。注意，无论是否处于 trial 模式，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回

textContent​

v1.9 之前添加 page.textContent
不推荐

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

返回 element.textContent。

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

返回

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() 方法来设置。

返回

uncheck​

v1.9 之前添加 page.uncheck
不推荐

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

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

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

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

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • force boolean (可选)#

      是否绕过 可操作性（actionability） 检查。默认值为 false。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position Object (可选)添加于：v1.11#

      相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。

    • strict boolean (可选)新增于：v1.14#

      如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

    • timeout number (可选)#

      最长等待时间（以毫秒为单位）。默认为 0，表示无超时。默认值可以通过配置中的 actionTimeout 选项进行更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来设置。

    • trial boolean (可选)添加于：v1.11#

      设置时，此方法仅执行 可操作性 检查并跳过实际动作。默认值为 false。适用于在不执行动作的情况下等待元素就绪。

返回

waitForNavigation​

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 | [URLPattern] | function(URL):boolean (可选)#

      导航时匹配的 glob 模式、正则模式、URL 模式或接收 URL 的谓词。请注意，如果参数是一个没有通配符的字符串，该方法将等待导航到完全等于该字符串的 URL。

    • waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

      何时认为操作成功，默认为 load。事件可以是以下之一

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
      • 'load' - 当 load 事件触发时，认为操作完成。
      • 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
      • 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

返回

waitForSelector​

v1.9 之前添加 page.waitForSelector
不推荐

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

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

注意

Playwright 在执行操作前会自动等待元素就绪。使用 定位器（Locator） 对象和 Web 优先断言可以让代码无需手动 waitForSelector。

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

用法

此方法适用于跨导航

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() 方法来设置。

返回

waitForTimeout​

v1.9 之前添加 page.waitForTimeout
不推荐

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

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

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

用法

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

参数

  • timeout number#

    要等待的超时时间。

返回