跳至主要内容

页面

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 函数 | 字符串 | 对象#

    • path 字符串 (可选)

      JavaScript 文件的路径。如果 path 是相对路径，则相对于当前工作目录解析。可选。

    • content 字符串 (可选)

      原始脚本内容。可选。

    要在页面中评估的脚本。

  • arg 可序列化 (可选)#

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

返回值

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 定位器#

    触发处理程序的定位器。

  • handler 函数(定位器):Promise<对象>#

    一旦 locator 出现就应该运行的函数。此函数应消除阻止诸如点击之类的操作的元素。

  • options 对象 (可选)

    • noWaitAfter 布尔值 (可选)添加于：v1.44

      #

      默认情况下，在调用处理程序后，Playwright 会等待覆盖层隐藏，只有在那之后，Playwright 才会继续执行触发处理程序的操作/断言。此选项允许选择退出此行为，以便覆盖层在处理程序运行后保持可见。

    • times 数字 (可选)添加于：v1.44

      #

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

返回值

addScriptTag​

在 v1.9 之前添加 page.addScriptTag

在页面中添加一个<script>标签，并使用所需的 url 或内容。当脚本的 onload 事件触发或脚本内容注入到框架时，返回添加的标签。

用法

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

参数

  • options 对象 (可选)

    • content 字符串 (可选)#

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

    • path 字符串 (可选)#

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

    • type 字符串 (可选)#

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

    • url 字符串 (可选)#

      要添加的脚本的 URL。

返回值

addStyleTag​

在 v1.9 之前添加 page.addStyleTag

在页面中添加一个<link rel="stylesheet">标签，并使用所需的 url 或一个带有内容的<style type="text/css">标签。当样式表的 onload 事件触发或 CSS 内容注入到框架时，返回添加的标签。

用法

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

参数

  • options 对象 (可选)

    • content 字符串 (可选)#

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

    • path 字符串 (可选)#

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

    • url 字符串 (可选)#

      <link>标签的 URL。

返回值

bringToFront​

在 v1.9 之前添加 page.bringToFront

将页面置于最前面（激活选项卡）。

用法

await page.bringToFront();

返回值

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

    • reason 字符串 (可选)新增于：v1.40#

      要报告给页面关闭中断的操作的原因。

    • runBeforeUnload 布尔值 (可选)#

      默认为false。是否运行before unload页面处理程序。

返回值

content​

在 v1.9 之前添加 page.content

获取页面的完整 HTML 内容，包括文档类型。

用法

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

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

  • target 字符串#

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

  • options 对象 (可选)

    • force 布尔值 (可选)#

      是否绕过可操作性检查。默认为false。

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • strict 布尔值 (可选)新增于：v1.14#

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

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

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

    • trial 布尔值 (可选)#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为false。在不执行操作的情况下，可用于等待元素准备好进行操作。

返回值

emulateMedia​

在 v1.9 之前添加 page.emulateMedia

此方法通过 `media` 参数和/或 `colorScheme` 参数更改 `CSS 媒体类型` 和 `'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
await page.evaluate(() => matchMedia('(prefers-color-scheme: no-preference)').matches);
// → false

参数

  • options 对象 (可选)

    • colorScheme null | "light" | "dark" | "no-preference" (可选)新增于：v1.9#

      模拟 `'prefers-colors-scheme'` 媒体特性，支持的值为 `'light'`、`'dark'`、`'no-preference'`。传递 `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() 的函数返回一个非 可序列化 的值，那么 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();

参数

返回值

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 并返回一个 Promise，该 Promise 解析为 callback 的返回值。如果 callback 返回一个 Promise，它将被等待。

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

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

注意

通过 page.exposeBinding() 安装的函数将在导航后继续存在。

用法

将页面 URL 公开给页面中所有框架的示例

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

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

参数

  • name string#

    window 对象上函数的名称。

  • callback function#

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

  • options 对象 (可选)

    • handle boolean (可选)#

      已弃用

      此选项将在将来移除。

      是否将参数作为句柄传递，而不是按值传递。传递句柄时，仅支持一个参数。按值传递时，支持多个参数。

返回值

exposeFunction​

在 v1.9 之前添加 page.exposeFunction

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

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

    window 对象上函数的名称

  • 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 | function(URL):boolean (可选)

      一个 glob 模式、正则表达式模式或接收框架 `url` 作为 URL 对象的谓词。可选。

    框架名称或其他框架查找选项。

返回值

frameLocator​

新增于：v1.17 page.frameLocator

当处理 iframe 时，您可以创建一个 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 元素时使用的选择器。

返回值

frames​

在 v1.9 之前添加 page.frames

页面上所有 frame 的数组。

用法

page.frames();

返回值

getByAltText​

新增于：v1.27 page.getByAltText

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

用法

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

<img alt='Playwright logo'>
await page.getByAltText('Playwright logo').click();

参数

  • text 字符串 | 正则表达式#

    要查找的元素的文本。

  • options 对象 (可选)

    • exact 布尔值 (可选)#

      是否查找完全匹配：区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍然会修剪空格。

返回值

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

    • exact 布尔值 (可选)#

      是否查找完全匹配：区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍然会修剪空格。

返回值

getByPlaceholder​

新增于：v1.27 page.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

<input type="email" placeholder="[email protected]" />

您可以通过占位符文本定位输入后填充输入

await page
    .getByPlaceholder('[email protected]')
    .fill('[email protected]');

参数

  • text 字符串 | 正则表达式#

    要查找的元素的文本。

  • options 对象 (可选)

    • exact 布尔值 (可选)#

      是否查找完全匹配：区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍然会修剪空格。

返回值

getByRole​

新增于：v1.27 page.getByRole

允许通过其 ARIA 角色、ARIA 属性 和 可访问名称 定位元素。

用法

考虑以下 DOM 结构。

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

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

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

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

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

参数

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

    必需的 aria 角色。

  • options 对象 (可选)

    • checked 布尔值 (可选)#

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

      详细了解 aria-checked。

    • disabled 布尔值 (可选)#

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

      注意

      与大多数其他属性不同，disabled 在 DOM 层次结构中是继承的。详细了解 aria-disabled。

    • exact 布尔值 (可选)新增于：v1.28#

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

    • expanded 布尔值 (可选)#

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

      详细了解 aria-expanded。

    • includeHidden 布尔值 (可选)#

      控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（如 ARIA 所定义）才会通过角色选择器匹配。

      详细了解 aria-hidden。

    • level 数字 (可选)#

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

      详细了解 aria-level。

    • name 字符串 | 正则表达式 (可选)#

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

      详细了解 可访问名称。

    • pressed 布尔值 (可选)#

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

      详细了解 aria-pressed。

    • selected 布尔值 (可选)#

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

      详细了解 aria-selected。

返回值

详情

角色选择器**不会取代**辅助功能审计和一致性测试，而是提供有关 ARIA 指南的早期反馈。

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

getByTestId​

新增于：v1.27 page.getByTestId

通过测试 id 定位元素。

用法

考虑以下 DOM 结构。

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

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

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

参数

返回值

详情

默认情况下，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 对象 (可选)

    • exact 布尔值 (可选)#

      是否查找完全匹配：区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍然会修剪空格。

返回值

详情

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

类型为 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>

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

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

参数

  • text 字符串 | 正则表达式#

    要查找的元素的文本。

  • options 对象 (可选)

    • exact 布尔值 (可选)#

      是否查找完全匹配：区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍然会修剪空格。

返回值

goBack​

在 v1.9 之前添加 page.goBack

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

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

用法

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

参数

  • options 对象 (可选)

    • timeout 数字 (可选)#

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

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

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

      • 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，认为操作已完成。
      • 'load' - 当触发 load 事件时，认为操作已完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠网络断言来评估准备情况。
      • 'commit' - 当收到网络响应并开始加载文档时，认为操作已完成。

返回值

goForward​

在 v1.9 之前添加 page.goForward

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

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

用法

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

参数

  • options 对象 (可选)

    • timeout 数字 (可选)#

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

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

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

      • 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，认为操作已完成。
      • 'load' - 当触发 load 事件时，认为操作已完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠网络断言来评估准备情况。
      • 'commit' - 当收到网络响应并开始加载文档时，认为操作已完成。

返回值

goto​

在 v1.9 之前添加 page.goto

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

如果出现以下情况，该方法将抛出错误：

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

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

注意

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

注意

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

用法

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

参数

  • url 字符串#

    要导航到的页面 URL。url 应包含方案，例如 https://。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时，它将通过 new URL() 构造函数合并。

  • options 对象 (可选)

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

返回值

isClosed​

在 v1.9 之前添加 page.isClosed

指示页面已关闭。

用法

page.isClosed();

返回值

locator​

新增于：v1.14 page.locator

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

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

用法

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

参数

  • selector 字符串#

    解析 DOM 元素时使用的选择器。

  • options 对象 (可选)

    • has 定位器 (可选)#

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

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

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

    • hasNot 定位器 (可选)新增于：v1.33#

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

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

    • hasNotText 字符串 | 正则表达式 (可选)新增于：v1.33#

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

    • hasText 字符串 | 正则表达式 （可选）#

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

返回值

mainFrame​

在 v1.9 之前添加 page.mainFrame

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

用法

page.mainFrame();

返回值

opener​

在 v1.9 之前添加 page.opener

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

用法

await page.opener();

返回值

pause​

新增于：v1.9 page.pause

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

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

注意

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

用法

await page.pause();

返回值

pdf​

在 v1.9 之前添加 page.pdf

返回 PDF 缓冲区。

注意

目前仅在 Chromium 无头模式下支持生成 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 对象 (可选)

    • displayHeaderFooter 布尔值 （可选）#

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

    • footerTemplate 字符串 （可选）#

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

    • format 字符串 （可选）#

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

    • headerTemplate 字符串 （可选）#

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

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

    • height 字符串 | 数字 （可选）#

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

    • landscape 布尔值 （可选）#

      纸张方向。默认为 false。

    • margin 对象 （可选）#

      • top 字符串 | 数字 （可选）

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

      • right 字符串 | 数字 （可选）

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

      • bottom 字符串 | 数字 （可选）

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

      • left 字符串 | 数字 （可选）

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

      纸张边距，默认为无。

    • outline 布尔值 （可选）添加于：v1.42#

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

    • pageRanges 字符串 （可选）#

      要打印的纸张范围，例如“1-5、8、11-13”。默认为空字符串，这意味着打印所有页面。

    • path 字符串 （可选）#

      保存 PDF 的文件路径。如果 path 是相对路径，则相对于当前工作目录解析。如果未提供路径，则 PDF 不会保存到磁盘。

    • preferCSSPageSize 布尔值 （可选）#

      优先于页面中声明的任何 CSS @page 大小，而不是 width 和 height 或 format 选项中声明的内容。默认为 false，这将缩放内容以适合纸张大小。

    • printBackground 布尔值 （可选）#

      打印背景图形。默认为 false。

    • scale 数字 （可选）#

      网页渲染的比例。默认为 1。比例值必须在 0.1 到 2 之间。

    • tagged 布尔值 （可选）添加于：v1.42#

      是否生成带标签（可访问）的 PDF。默认为 false。

    • width 字符串 | 数字 （可选）#

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

返回值

  • Promise<Buffer>#

reload​

在 v1.9 之前添加 page.reload

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

用法

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

参数

  • options 对象 (可选)

    • timeout number (可选)#

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

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

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

      • 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，认为操作已完成。
      • 'load' - 当触发 load 事件时，认为操作已完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠网络断言来评估准备情况。
      • 'commit' - 当收到网络响应并开始加载文档时，认为操作已完成。

返回值

  • Promise<null | Response>#

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

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

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

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

返回值

  • Promise<void>#

removeLocatorHandler​

添加于：v1.44

 page.removeLocatorHandler

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

用法

await page.removeLocatorHandler(locator);

参数

返回值

  • 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 Workers，方法是将 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();

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

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

    用于路由时匹配的 glob 模式、正则表达式模式或接收 URL 的谓词。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时，它将通过 new URL() 构造函数合并。

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

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

  • options 对象 (可选)

    • times 数字 (可选)新增于：v1.15#

      路由应使用的频率。默认情况下，它将每次使用。

返回值

  • Promise<void>#

routeFromHAR​

新增于：v1.23 page.routeFromHAR

如果指定，则页面发出的网络请求将从 HAR 文件中提供服务。详细了解 从 HAR 重新播放。

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

用法

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

参数

  • har string#

    具有预先录制的网络数据的 HAR 文件的路径。如果 path 是相对路径，则相对于当前工作目录解析。

  • options 对象 (可选)

    • 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 路由所需的信息。这省略了大小、时间、页面、cookie、安全和其他在从 HAR 重新播放时未使用的 HAR 信息类型。默认为 minimal。

    • url string | RegExp (可选)#

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

返回值

  • Promise<void>#

routeWebSocket​

新增于：v1.48 page.routeWebSocket

此方法允许修改页面发出的 websocket 连接。

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

用法

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

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

参数

返回值

截图​

在 v1.9 之前添加 page.screenshot

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

用法

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

参数

  • options 对象 (可选)

    • animations "disabled" | "allow" (可选)#

      设置为"disabled"时，停止 CSS 动画、CSS 过渡和 Web 动画。动画根据其持续时间获得不同的处理方式

      • 有限动画被快速转发到完成，因此它们将触发transitionend事件。
      • 无限动画被取消到初始状态，然后在截图后播放。

      默认为"allow"，保持动画不变。

    • caret "hide" | "initial" (可选)#

      设置为"hide"时，截图将隐藏文本光标。设置为"initial"时，文本光标行为不会更改。默认为"hide"。

    • clip 对象 (可选)#

      • x 数字

        剪辑区域左上角的 x 坐标

      • y 数字

        剪辑区域左上角的 y 坐标

      • width 数字

        剪辑区域的宽度

      • height 数字

        剪辑区域的高度

      一个指定结果图像剪辑的对象。

    • fullPage 布尔值 (可选)#

      如果为真，则截取整个可滚动页面的屏幕截图，而不是当前可见的视口。默认为false。

    • mask 数组<定位器> (可选)#

      指定在截取屏幕截图时应屏蔽的定位器。屏蔽的元素将覆盖一个完全覆盖其边界框的粉红色框#FF00FF（由maskColor自定义）。

    • maskColor 字符串 (可选)新增于：v1.35#

      以CSS 颜色格式指定屏蔽元素的覆盖框的颜色。默认颜色为粉红色#FF00FF。

    • omitBackground 布尔值 (可选)#

      隐藏默认的白色背景，并允许捕获具有透明度的屏幕截图。不适用于jpeg图像。默认为false。

    • path 字符串 (可选)#

      保存图像到的文件路径。屏幕截图类型将从文件扩展名推断。如果path是相对路径，则相对于当前工作目录解析。如果未提供路径，则图像不会保存到磁盘。

    • quality 数字 (可选)#

      图像的质量，介于 0-100 之间。不适用于png图像。

    • scale "css" | "device" (可选)#

      设置为"css"时，屏幕截图将每个 css 像素对应一个像素。对于高 dpi 设备，这将使屏幕截图保持较小尺寸。使用"device"选项将生成每个设备像素对应一个像素，因此高 dpi 设备的屏幕截图将是两倍甚至更大的尺寸。

      默认为"device"。

    • style 字符串 (可选)新增于：v1.41#

      要应用于制作屏幕截图时的样式表的文本。在这里，您可以隐藏动态元素，使元素不可见或更改其属性以帮助您创建可重复的屏幕截图。此样式表穿透 Shadow DOM 并应用于内部框架。

    • timeout 数字 (可选)#

      最大毫秒数。默认为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 字符串#

    要分配给页面的 HTML 标记。

  • options 对象 (可选)

    • timeout 数字 (可选)#

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

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

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

      • 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，认为操作已完成。
      • 'load' - 当触发 load 事件时，认为操作已完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠网络断言来评估准备情况。
      • 'commit' - 当收到网络响应并开始加载文档时，认为操作已完成。

返回值

setDefaultNavigationTimeout​

在 v1.9 之前添加 page.setDefaultNavigationTimeout

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

注意

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

用法

page.setDefaultNavigationTimeout(timeout);

参数

  • timeout 数字#

    以毫秒为单位的最大导航时间

setDefaultTimeout​

在 v1.9 之前添加 page.setDefaultTimeout

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

注意

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

用法

page.setDefaultTimeout(timeout);

参数

  • timeout 数字#

    以毫秒为单位的最大时间

setExtraHTTPHeaders​

在 v1.9 之前添加 page.setExtraHTTPHeaders

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

注意

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

用法

await page.setExtraHTTPHeaders(headers);

参数

  • headers 对象<字符串, 字符串>#

    包含要与每个请求一起发送的其他 HTTP 标头的对象。所有标头值必须为字符串。

返回值

setViewportSize​

在 v1.9 之前添加 page.setViewportSize

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

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

用法

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

参数

  • viewportSize Object#

    • width 数字

      页面宽度（以像素为单位）。

    • height 数字

      页面高度（以像素为单位）。

返回值

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

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

      指定是否等待已运行的处理程序以及如果它们抛出错误该怎么办

      • 'default' - 不要等待当前处理程序调用（如果有）完成，如果取消路由的处理程序抛出错误，则可能导致未处理的错误
      • 'wait' - 等待当前处理程序调用（如果有）完成
      • 'ignoreErrors' - 不要等待当前处理程序调用（如果有）完成，取消路由后，处理程序抛出的所有错误都会被静默捕获

返回值

url​

在 v1.9 之前添加 page.url

用法

page.url();

返回值

video​

在 v1.9 之前添加 page.video

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

用法

page.video();

返回值

viewportSize​

在 v1.9 之前添加 page.viewportSize

用法

page.viewportSize();

返回值

  • null | Object#

    • width 数字

      页面宽度（以像素为单位）。

    • height 数字

      页面高度（以像素为单位）。

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

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

返回值

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

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

  • options 对象 (可选)

    • timeout number （可选）#

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

    • waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" （可选）#

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

      • 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，认为操作已完成。
      • 'load' - 当触发 load 事件时，认为操作已完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠网络断言来评估准备情况。
      • 'commit' - 当收到网络响应并开始加载文档时，认为操作已完成。

返回值

workers​

在 v1.9 之前添加 page.workers

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

注意

这并不包含 ServiceWorkers

用法

page.workers();

返回值

属性​

clock​

新增于：v1.45 page.clock

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

用法

page.clock

类型

coverage​

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

目前仅适用于 Chromium。

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

用法

page.coverage

类型

keyboard​

在 v1.9 之前添加 page.keyboard

用法

page.keyboard

类型

mouse​

在 v1.9 之前添加 page.mouse

用法

page.mouse

类型

request​

新增于：v1.16 page.request

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

用法

page.request

类型

touchscreen​

在 v1.9 之前添加 page.touchscreen

用法

page.touchscreen

类型

事件​

on('close')​

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

页面关闭时发出。

用法

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

事件数据

on('console')​

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

当页面中的 JavaScript 调用其中一个控制台 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错误响应，例如404或503，从HTTP的角度来看仍然是成功的响应，因此请求将使用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 字符串#

    要查询的选择器。

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

返回值

$$​

新增于：v1.9 page.$$
不推荐

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

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

用法

await page.$$(selector);

参数

返回值

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

    要查询的选择器。

  • pageFunction 函数(元素) | 字符串#

    在页面上下文中要执行的函数。

  • arg EvaluationArgument (可选)#

    要传递给pageFunction的可选参数。

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：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);

参数

返回值

辅助功能​

在 v1.9 之前添加 page.accessibility
已弃用

不建议使用此属性。如果您需要测试页面可访问性，请使用其他库，例如Axe。有关与 Axe 集成的信息，请参阅我们的 Node.js 指南。

用法

page.accessibility

类型

check​

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

请改用基于定位器的 locator.check()。详细了解定位器。

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • force 布尔值 (可选)#

      是否绕过可操作性检查。默认为false。

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)新增于：v1.11#

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

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

    • trial 布尔值 (可选)新增于：v1.11#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为false。在不执行操作的情况下，可用于等待元素准备好进行操作。

返回值

click​

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

请改用基于定位器的 locator.click()。详细了解定位器。

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • button "left" | "right" | "middle" (可选)#

      默认为 left。

    • clickCount 数字 (可选)#

      默认为 1。请参阅UIEvent.detail。

    • delay 数字 (可选)#

      在毫秒内等待 mousedown 和 mouseup 之间的时间。默认为 0。

    • force 布尔值 (可选)#

      是否绕过可操作性检查。默认为false。

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

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项将来将默认为 true。

      启动导航的操作将等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择不等待。您只需要在特殊情况下（例如导航到不可访问的页面）使用此选项。默认为 false。

    • position 对象 (可选)#

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

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

    • trial 布尔值 (可选)新增于：v1.11#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于在元素准备好执行操作之前等待，而无需执行它。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试仅在按下这些键时可见的元素。

返回值

dblclick​

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

请改用基于定位器的 locator.dblclick()。详细了解定位器。

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

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

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

注意

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • button "left" | "right" | "middle" (可选)#

      默认为 left。

    • delay 数字 (可选)#

      在毫秒内等待 mousedown 和 mouseup 之间的时间。默认为 0。

    • force 布尔值 (可选)#

      是否绕过可操作性检查。默认为false。

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

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)#

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

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

    • trial 布尔值 (可选)新增于：v1.11#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于在元素准备好执行操作之前等待，而无需执行它。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试仅在按下这些键时可见的元素。

返回值

dispatchEvent​

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

请改用基于定位器的 locator.dispatchEvent()。详细了解定位器。

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

用法

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

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

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

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

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

参数

  • selector 字符串#

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

  • type 字符串#

    DOM 事件类型："click"、"dragstart" 等。

  • eventInit EvaluationArgument （可选）#

    可选的特定于事件的初始化属性。

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 （可选）#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

fill​

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

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

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

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

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

用法

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

参数

  • selector 字符串#

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

  • value 字符串#

    要为 <input>、<textarea> 或 [contenteditable] 元素填充的值。

  • options 对象 (可选)

    • force 布尔值 （可选）新增于：v1.13#

      是否绕过可操作性检查。默认为false。

    • noWaitAfter 布尔值 （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 （可选）#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

focus​

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 （可选）#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

getAttribute​

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

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

返回元素属性值。

用法

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

参数

  • selector 字符串#

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

  • name 字符串#

    要获取其值的属性名称。

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 （可选）#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

hover​

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

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

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • force 布尔值 （可选）#

      是否绕过可操作性检查。默认为false。

    • modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> （可选）#

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

    • noWaitAfter 布尔值 (可选)新增于：v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 （可选）#

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

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 （可选）#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

    • trial 布尔值 (可选)新增于：v1.11#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于在元素准备好执行操作之前等待，而无需执行它。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试仅在按下这些键时可见的元素。

返回值

innerHTML​

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

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

返回 element.innerHTML。

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 （可选）#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

innerText​

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

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

返回 element.innerText。

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 （可选）#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

inputValue​

新增于：v1.13 page.inputValue
不推荐

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

isChecked​

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

isDisabled​

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

isEditable​

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

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

返回元素是否 可编辑。

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

isEnabled​

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

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

返回元素是否 启用。

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

isHidden​

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      已弃用

      此选项被忽略。 page.isHidden() 不会等待元素隐藏，并立即返回。

返回值

isVisible​

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      已弃用

      此选项被忽略。 page.isVisible() 不会等待元素可见，并立即返回。

返回值

press​

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

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

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

key 可以指定预期的 keyboardEvent.key 值或生成文本的单个字符。可以在 此处 找到 key 值的超集。键的示例包括

F1 - F12、Digit0- Digit9、KeyA- KeyZ、Backquote、Minus、Equal、Backslash、Backspace、Tab、Delete、Escape、ArrowDown、End、Enter、Home、Insert、PageDown、PageUp、ArrowRight、ArrowUp 等。

还支持以下修饰键快捷方式：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

按住 Shift 将以大写形式键入与 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 对象 (可选)

    • delay 数字 (可选)#

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项将来将默认为 true。

      启动导航的操作将等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择不等待。您只需要在特殊情况下（例如导航到不可访问的页面）使用此选项。默认为 false。

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

selectOption​

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

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

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

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

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

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

用法

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

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

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

参数

  • selector 字符串#

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

  • values null | 字符串 | ElementHandle | 数组<字符串> | 对象 | 数组<ElementHandle> | 数组<对象>#

    • value 字符串 (可选)

      根据 option.value 匹配。可选。

    • label 字符串 (可选)

      根据 option.label 匹配。可选。

    • index 数字 (可选)

      根据索引匹配。可选。

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

  • options 对象 (可选)

    • force 布尔值 （可选）新增于：v1.13#

      是否绕过可操作性检查。默认为false。

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

setChecked​

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

请改用基于定位器的 locator.setChecked()。详细了解 定位器。

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

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

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

用法

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

参数

  • selector 字符串#

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

  • checked 布尔值#

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

  • options 对象 (可选)

    • force 布尔值 (可选)#

      是否绕过可操作性检查。默认为false。

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)#

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

    • strict 布尔值 (可选)#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

    • trial 布尔值 (可选)#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为false。在不执行操作的情况下，可用于等待元素准备好进行操作。

返回值

setInputFiles​

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

请改用基于定位器的 locator.setInputFiles()。详细了解 定位器。

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

此方法期望 选择器 指向 输入元素。但是，如果元素位于具有关联 控件 的 <label> 元素内部，则将目标定位到该控件。

用法

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

参数

返回值

tap​

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

请改用基于定位器的 locator.tap()。详细了解 定位器。

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

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

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

注意

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • force 布尔值 (可选)#

      是否绕过可操作性检查。默认为false。

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

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)#

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

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

    • trial 布尔值 (可选)新增于：v1.11#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于在元素准备好执行操作之前等待，而无需执行它。请注意，无论 trial 如何，键盘 modifiers 都会被按下，以允许测试仅在按下这些键时可见的元素。

返回值

textContent​

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

请使用基于定位器的 locator.textContent() 方法。了解更多关于 定位器 的信息。

返回 element.textContent。

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为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 字符串#

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

  • text 字符串#

    要输入到聚焦元素中的文本。

  • options 对象 (可选)

    • delay 数字 (可选)#

      按键之间等待的时间（毫秒）。默认为 0。

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

uncheck​

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

请使用基于定位器的 locator.uncheck() 方法。了解更多关于 定位器 的信息。

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options 对象 (可选)

    • force 布尔值 (可选)#

      是否绕过可操作性检查。默认为false。

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)新增于：v1.11#

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

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

    • trial 布尔值 (可选)新增于：v1.11#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为false。在不执行操作的情况下，可用于等待元素准备好进行操作。

返回值

waitForNavigation​

在 v1.9 之前添加 page.waitForNavigation
已弃用

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

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

使用 历史记录 API 更改 URL 被视为导航。

参数

  • options 对象 (可选)

    • timeout 数字 (可选)#

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

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

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

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

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

      • 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，认为操作已完成。
      • 'load' - 当触发 load 事件时，认为操作已完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠网络断言来评估准备情况。
      • 'commit' - 当收到网络响应并开始加载文档时，认为操作已完成。

返回值

waitForSelector​

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

请使用断言可见性或基于定位器的 locator.waitFor() 方法。了解更多关于 定位器 的信息。

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

注意

Playwright 会自动等待元素准备好后再执行操作。使用 Locator 对象和 Web-first 断言可以使代码无需使用 waitForSelector。

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

用法

此方法可在导航之间使用

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

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

参数

  • selector 字符串#

    要查询的选择器。

  • options 对象 (可选)

    • state "attached" | "detached" | "visible" | "hidden" (可选)#

      默认为 'visible'。可以是以下之一：

      • 'attached' - 等待元素出现在 DOM 中。
      • 'detached' - 等待元素从 DOM 中消失。
      • 'visible' - 等待元素具有非空边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空边界框，并且不被视为可见。
      • 'hidden' - 等待元素从 DOM 中分离，或具有空边界框或 visibility:hidden。这与 'visible' 选项相反。

    • strict 布尔值 (可选)新增于：v1.14#

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

    • timeout 数字 (可选)#

      最大毫秒数。默认为0 - 无超时。默认值可以通过配置中的actionTimeout选项更改，或者使用browserContext.setDefaultTimeout()或page.setDefaultTimeout()方法更改。

返回值

waitForTimeout​

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

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

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

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

用法

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

参数

  • timeout 数字#

    要等待的超时时间

返回值