跳到主要内容

Page

Page 提供了与 Browser 中的单个标签页或 Chromium 中的 扩展后台页面 交互的方法。一个 Browser 实例可能包含多个 Page 实例。

以下示例创建了一个页面，导航到指定 URL，然后保存截图：

const { webkit } = require('playwright');  // 也可以使用 'chromium' 或 '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('页面已加载！'));

要取消事件订阅，可以使用 removeListener 方法：

function logRequest(interceptedRequest) {
  console.log('发起了一个请求:', interceptedRequest.url());
}
page.on('request', logRequest);
// 稍后...
page.removeListener('request', logRequest);

方法​

addInitScript​

v1.9 之前添加 page.addInitScript

添加一个脚本，该脚本将在以下任一场景中被执行：

  • 每当页面发生导航时
  • 每当子框架被附加或导航时。在这种情况下，脚本会在新附加的框架上下文中执行

脚本会在文档创建后但任何脚本运行前被评估。这对于修改 JavaScript 环境很有用，例如修改 Math.random 的种子值。

用法

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

// preload.js
Math.random = () => 42;
// 在你的 playwright 脚本中，假设 preload.js 文件在同一目录下
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 (可选)#

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

返回值

addLocatorHandler​

v1.42 版本新增 page.addLocatorHandler

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

该方法允许你设置一个特殊函数（称为处理程序），当检测到覆盖层可见时激活。处理程序的任务是移除覆盖层，让你的测试能够像覆盖层不存在一样继续执行。

注意事项：

  • 当覆盖层可预测地出现时，我们建议在测试中显式等待它并将其关闭作为正常测试流程的一部分，而不是使用 page.addLocatorHandler()。
  • Playwright 在执行或重试需要可操作性检查的操作之前，或执行自动等待断言检查之前，都会检查覆盖层。当覆盖层可见时，Playwright 会先调用处理程序，然后继续执行操作/断言。注意处理程序只在执行操作/断言时被调用 - 如果覆盖层出现但你不执行任何操作，处理程序不会被触发。
  • 执行处理程序后，Playwright 会确保触发处理程序的覆盖层不再可见。你可以通过 noWaitAfter 选项禁用此行为。
  • 处理程序的执行时间会计入执行该处理程序的操作/断言超时时间。如果你的处理程序耗时过长，可能会导致超时。
  • 你可以注册多个处理程序。但同一时间只会运行一个处理程序。确保处理程序内的操作不依赖于另一个处理程序。
注意

运行处理程序会在测试过程中改变页面状态。例如它会改变当前聚焦元素和鼠标位置。确保在处理程序之后运行的操作是自包含的，不依赖于焦点和鼠标状态保持不变。

例如，考虑一个调用 locator.focus() 后接 keyboard.press() 的测试。如果你的处理程序在这两个操作之间点击了一个按钮，聚焦元素很可能会出错，按键会发生在意外元素上。使用 locator.press() 可以避免这个问题。

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

用法

一个关闭"注册新闻简报"对话框的示例：

// 设置处理程序
await page.addLocatorHandler(page.getByText('Sign up to the newsletter'), async () => {
  await page.getByRole('button', { name: 'No thanks' }).click();
});

// 正常编写测试
await page.goto('https://example.com');
await page.getByRole('button', { name: 'Start here' }).click();

一个跳过"确认安全信息"页面的示例：

// 设置处理程序
await page.addLocatorHandler(page.getByText('Confirm your security details'), async () => {
  await page.getByRole('button', { name: 'Remind me later' }).click();
});

// 正常编写测试
await page.goto('https://example.com');
await page.getByRole('button', { name: 'Start here' }).click();

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

// 设置处理程序
await page.addLocatorHandler(page.locator('body'), async () => {
  await page.evaluate(() => window.removeObstructionsForTestIfNeeded());
}, { noWaitAfter: true });

// 正常编写测试
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>#

    当定位器出现时应运行的函数。该函数应移除阻塞点击等操作的元素。

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

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

    • url string (可选)#

      要添加的脚本 URL。

返回值

addStyleTag​

v1.9 版本前添加 page.addStyleTag

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

用法

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

参数

  • options Object (可选)

    • content string (可选)#

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

    • path string (可选)#

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

    • url string (可选)#

      <link> 标签的 URL。

返回值

bringToFront​

v1.9 版本前添加 page.bringToFront

将页面置于前台（激活标签页）。

用法

await page.bringToFront();

返回值

close​

v1.9 之前版本添加 page.close

如果 runBeforeUnload 设为 false，则不会执行任何卸载处理程序并等待页面关闭。如果设为 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 处理程序。

返回值

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');
// 或者指定相对于元素左上角的精确位置：
await page.dragAndDrop('#source', '#target', {
  sourcePosition: { x: 34, y: 7 },
  targetPosition: { x: 10, y: 20 },
});

参数

  • source string#

    用于查找要拖拽元素的选择器。如果有多个元素匹配选择器，将使用第一个。

  • target string#

    用于查找要放置元素的选择器。如果有多个元素匹配选择器，将使用第一个。

  • options Object (可选)

    • force boolean (可选)#

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

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • sourcePosition Object (可选) 添加于: v1.14#

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

    • 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); // 输出 "56"

也可以传递字符串代替函数：

console.log(await page.evaluate('1 + 2')); // 输出 "3"
const x = 10;
console.log(await page.evaluate(`1 + ${x}`)); // 输出 "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() 的唯一区别在于后者返回的是 JSHandle。

如果传递给 page.evaluateHandle() 的函数返回一个 Promise，则该方法会等待 Promise 解析后返回其值。

用法

// 获取 window 对象的句柄
const aWindowHandle = await page.evaluateHandle(() => Promise.resolve(window));

也可以传递字符串代替函数：

const aHandle = await page.evaluateHandle('document'); // 获取 '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，其解析值为 callback 的返回值。如果 callback 返回一个 Promise，则会等待其解析。

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

上下文级别的版本请参见 browserContext.exposeBinding()。

:::注意 通过 page.exposeBinding() 安装的函数在页面导航后仍然有效。 :::

用法示例

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

const { webkit } = require('playwright');  // 或 'chromium' 或 '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 Object (可选)

    • handle boolean (可选)#

      :::警告[已弃用] 此选项将在未来版本中移除。 :::

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

返回值

exposeFunction​

v1.9 之前版本添加 page.exposeFunction

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

如果 callback 返回一个 Promise，则会等待其解析。

上下文范围内暴露的函数请参见 browserContext.exposeFunction()。

:::注意 通过 page.exposeFunction() 安装的函数在页面导航后仍然有效。 :::

用法示例

在页面添加 sha256 函数的示例：

const { webkit } = require('playwright');  // 或 'chromium' 或 '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

返回符合指定条件的 frame。必须指定 name 或 url 参数。

用法

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

参数

  • frameSelector string | Object#

    • name string (可选)

      在 iframe 的 name 属性中指定的 frame 名称。可选参数。

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

      接收 frame 的 url 作为 URL 对象的通配符模式、正则表达式模式或谓词函数。可选参数。

    Frame 名称或其他 frame 查找选项。

返回值

frameLocator​

v1.17 版本新增 page.frameLocator

在处理 iframe 时，可以创建一个 frame locator 来进入该 iframe 并选择其中的元素。

用法

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

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

参数

  • selector string#

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

返回值

frames​

v1.9 之前版本已存在 page.frames

当前页面中所有附加的 iframe 数组。

用法

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 中通过标签 "Username" 和 "Password" 找到输入框：

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
await page.getByLabel('Username').fill('john');
await page.getByLabel('Password').fill('secret');

参数

  • text string | RegExp#

    用于定位元素的文本

  • options Object (可选)

    • exact boolean (可选)#

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

返回值

getByPlaceholder​

添加于: 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 属性 和 可访问名称 来定位元素。

用法示例

考虑以下 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。

    • disabled boolean (可选)#

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

      :::注意

      与大多数其他属性不同，disabled 属性会在 DOM 层次结构中继承。了解更多关于 aria-disabled。 :::

    • exact boolean (可选) 发布于: v1.28#

      是否精确匹配 name：区分大小写且全字符串匹配。默认为 false。当 name 是正则表达式时忽略此选项。注意精确匹配仍会修剪空白字符。

    • expanded boolean (可选)#

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

      了解更多关于 aria-expanded。

    • includeHidden boolean (可选)#

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

      了解更多关于 aria-hidden。

    • level number (可选)#

      通常出现在 heading、listitem、row、treeitem 角色中的数字属性，对于 <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 属性。

// 从 @playwright/test 配置中设置自定义测试 ID 属性：
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>

可以通过文本子串、精确字符串或正则表达式进行定位：

// 匹配 <span>
page.getByText('world');

// 匹配第一个 <div>
page.getByText('Hello world');

// 匹配第二个 <div>
page.getByText('Hello', { exact: true });

// 匹配两个 <div>
page.getByText(/Hello/);

// 匹配第二个 <div>
page.getByText(/^hello$/i);

参数

  • text string | RegExp#

    用于定位元素的文本。

  • options Object (可选)

    • exact boolean (可选)#

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

返回

详细信息

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

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

getByTitle​

添加于: v1.27 page.getByTitle

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

用法

考虑以下 DOM 结构：

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

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

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

参数

  • text string | RegExp#

    用于定位元素的文本

  • options Object (可选)

    • exact boolean (可选)#

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

返回

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 无效
  • 导航过程中超过超时时间
  • 远程服务器无响应或无法访问
  • 主资源加载失败

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

:::注意 该方法要么抛出错误，要么返回主资源响应。唯一的例外是导航到 about:blank 或导航到相同 URL 但哈希值不同的情况，这些情况会成功并返回 null。 :::

:::注意 无头模式不支持导航到 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' - 当收到网络响应且文档开始加载时认为操作完成

返回

isClosed​

在 v1.9 之前添加 page.isClosed

表示页面是否已关闭。

用法

page.isClosed();

返回值

locator​

Added in: v1.14 page.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 (可选) Added in: v1.33#

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

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

    • hasNotText string | RegExp (可选) Added in: v1.33#

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

    • hasText string | RegExp (可选)#

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

返回值

mainFrame​

Added before v1.9 page.mainFrame

页面的主框架。页面保证有一个主框架，该框架在导航过程中持续存在。

用法

page.mainFrame();

返回值

opener​

Added before v1.9 page.opener

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

用法

await page.opener();

返回值

pause​

Added in: v1.9 page.pause

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

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

备注

此方法要求 Playwright 以非无头模式启动，即 headless 选项设为 false。

用法

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 属性可以强制渲染精确颜色。 :::

用法

// 生成 'screen' 媒体类型的 PDF
await page.emulateMedia({ media: 'screen' });
await page.pdf({ path: 'page.pdf' });

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

几个示例：

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

所有可能的单位：

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

format 选项包括：

  • Letter: 8.5 英寸 x 11 英寸
  • Legal: 8.5 英寸 x 14 英寸
  • Tabloid: 11 英寸 x 17 英寸
  • Ledger: 17 英寸 x 11 英寸
  • A0: 33.1 英寸 x 46.8 英寸
  • A1: 23.4 英寸 x 33.1 英寸
  • A2: 16.54 英寸 x 23.4 英寸
  • A3: 11.7 英寸 x 16.54 英寸
  • A4: 8.27 英寸 x 11.7 英寸
  • A5: 5.83 英寸 x 8.27 英寸
  • A6: 4.13 英寸 x 5.83 英寸

:::注意

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

参数

  • options Object (可选)

    • displayHeaderFooter boolean (可选)#

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

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

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

返回

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.dev', { waitUntil: 'domcontentloaded' });
// 等待所有已触发的'request'事件处理完成
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​

Added in: v1.48 page.requestGC

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

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

// 1. 在页面中，为 "suspect" 保存一个 WeakRef。
await page.evaluate(() => globalThis.suspectWeakRef = new WeakRef(suspect));
// 2. 请求垃圾回收。
await page.requestGC();
// 3. 检查弱引用是否不再指向原始对象。
expect(await page.evaluate(() => !globalThis.suspectWeakRef.deref())).toBe(true);

用法

await page.requestGC();

返回值

route​

v1.9 之前添加 page.route

路由功能允许修改页面发出的网络请求。

启用路由后，所有匹配 URL 模式的请求都会被暂停，除非该请求被继续执行、完成或中止。

备注

如果响应是重定向，处理程序只会被第一个 URL 调用。

备注

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

备注

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 缓存。

参数

返回

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'，缺失的请求将被发送到网络。

      默认为 abort。

    • update boolean (可选)#

      如果指定，将用实际网络信息更新给定的 HAR 文件，而不是从文件提供。文件会在 browserContext.close() 调用时写入磁盘。

    • updateContent "embed" | "attach" (可选) 添加于: v1.32#

      控制资源内容管理的可选设置。如果指定 attach，资源将作为单独文件或 ZIP 存档中的条目持久化。如果指定 embed，内容将内联存储在 HAR 文件中。

    • updateMode "full" | "minimal" (可选) 添加于: v1.32#

      当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这会省略大小、时间、页面、cookies、安全和其他在从 HAR 回放时不使用的 HAR 信息类型。默认为 minimal。

    • url string | RegExp (可选)#

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

返回值

routeWebSocket​

添加于: v1.48 page.routeWebSocket

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

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

用法

以下是一个响应单条消息的简单模拟示例。更多详细信息和示例请参见 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 (可选)#

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

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

Added before 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​

Added before 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​

Added in: 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​

Added before v1.9 page.url

用法

page.url();

返回值

video​

v1.9 版本前添加 page.video

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

用法

page.video();

返回值

viewportSize​

v1.9 版本前添加 page.viewportSize

用法

page.viewportSize();

返回值

waitForEvent​

v1.9 版本前添加 page.waitForEvent

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

用法

// 在点击前开始等待下载事件。注意不需要 await。
const downloadPromise = page.waitForEvent('download');
await page.getByText('下载文件').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');  // 或 'chromium' 或 '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(); // 点击触发导航
await page.waitForLoadState(); // 在 'load' 事件后解析
const popupPromise = page.waitForEvent('popup');
await page.getByRole('button').click(); // 点击触发弹窗
const popup = await popupPromise;
await popup.waitForLoadState('domcontentloaded'); // 等待 'DOMContentLoaded' 事件
console.log(await popup.title()); // 弹窗已准备就绪

参数

  • state "load" | "domcontentloaded" | "networkidle" (可选)#

    要等待的加载状态，默认为 load。如果在加载当前文档时已经达到该状态，方法会立即解析。可选值包括：

    • 'load' - 等待触发 load 事件
    • 'domcontentloaded' - 等待触发 DOMContentLoaded 事件
    • 'networkidle' - 不推荐 等待至少 500 毫秒内没有网络连接。不要将此方法用于测试，应依赖 Web 断言来评估准备状态

  • options Object (可选)

返回值

waitForRequest​

v1.9 之前版本添加 page.waitForRequest

等待匹配的请求并返回该请求。关于事件的更多详情，请参阅等待事件。

用法

// 在点击前开始等待请求。注意不需要 await。
const requestPromise = page.waitForRequest('https://example.com/resource');
await page.getByText('trigger request').click();
const request = await requestPromise;

// 使用谓词的替代方式。注意不需要 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

返回匹配的响应对象。关于事件的更多详情请参见等待事件。

用法

// 在点击前开始等待响应。注意这里没有使用 await。
const responsePromise = page.waitForResponse('https://example.com/resource');
await page.getByText('trigger response').click();
const response = await responsePromise;

// 使用谓词的替代方式。注意这里没有使用 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'); // 点击链接将间接导致导航
await page.waitForURL('**/target.html');

参数

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

    用于匹配导航的 glob 模式、正则表达式或接收 URL 的谓词函数。注意如果参数是不含通配符的字符串，该方法将等待导航到完全匹配该字符串的 URL。

  • options Object (可选)

    • timeout number (可选)#

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

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

      何时认为操作成功，默认为 load。可选事件包括：

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

返回值

workers​

Added before v1.9 page.workers

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

备注

不包含 ServiceWorkers

用法

page.workers();

返回值

属性​

clock​

Added in: v1.45 page.clock

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

用法

page.clock

类型

coverage​

Added before v1.9 page.coverage
备注

目前仅 Chromium 可用

浏览器特定的覆盖率实现。详见 Coverage。

用法

page.coverage

类型

keyboard​

Added before v1.9 page.keyboard

用法

page.keyboard

类型

mouse​

Added before v1.9 page.mouse

用法

page.mouse

类型

request​

Added in: v1.16 page.request

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

用法

page.request

类型

touchscreen​

Added before v1.9 page.touchscreen

用法

page.touchscreen

类型

事件​

on('close')​

Added before v1.9 page.on('close')

当页面关闭时触发。

用法

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

事件数据

on('console')​

Added before 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')​

Added before v1.9 page.on('crash')

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

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

try {
  // 点击操作期间可能发生崩溃
  await page.click('button');
  // 或者在等待事件时
  await page.waitForEvent('popup');
} catch (e) {
  // 当页面崩溃时，异常消息会包含'crash'
}

使用方法

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

事件数据

on('dialog')​

Added before 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')​

Added in: v1.9 page.on('domcontentloaded')

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

使用方法

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

事件数据

on('download')​

Added before v1.9 page.on('download')

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

使用方法

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

事件数据

on('filechooser')​

Added in: 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')​

Added in: v1.9 page.on('frameattached')

当框架(frame)被附加时触发。

使用方法

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

事件数据

on('framedetached')​

Added in: v1.9 page.on('framedetached')

当框架被分离时触发。

用法

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

事件数据

on('framenavigated')​

Added in: v1.9 page.on('framenavigated')

当框架导航到新 URL 时触发。

用法

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

事件数据

on('load')​

Added before v1.9 page.on('load')

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

用法

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

事件数据

on('pageerror')​

Added in: v1.9 page.on('pageerror')

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

// 将所有未捕获的错误记录到终端
page.on('pageerror', exception => {
  console.log(`未捕获异常: "${exception}"`);
});

// 导航到包含异常的页面
await page.goto('data:text/html,<script>throw new Error("Test")</script>');

用法

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

事件数据

on('popup')​

Added before v1.9 page.on('popup')

当页面打开新标签页或窗口时触发。此事件会额外触发 browserContext.on('page')，但仅针对与该页面相关的弹出窗口。

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

// 在点击前开始等待弹出窗口。注意不要使用 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')​

Added before v1.9 page.on('request')

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

用法

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

事件数据

on('requestfailed')​

Added in: v1.9 page.on('requestfailed')

当请求失败时触发，例如因超时而失败。

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

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

用法

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

事件数据

on('requestfinished')​

Added in: v1.9 page.on('requestfinished')

当请求成功完成并下载响应体后触发。对于成功的响应，事件触发顺序为 request → response → requestfinished。

用法

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

事件数据

on('response')​

Added before v1.9 page.on('response')

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

用法

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

事件数据

on('websocket')​

Added in: v1.9 page.on('websocket')

当发送 WebSocket 请求时触发。

使用方法

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

事件数据

on('worker')​

Added before 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 辅助方法或基于网页优先的断言。

该方法在页面中查找与指定选择器匹配的元素，并将其作为第一个参数传递给 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');
// 在 TypeScript 中，此示例需要在 el 上显式指定类型注解 (HTMLLinkElement):
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);

参数

返回值

accessibility​

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

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

  • options Object (可选)

    • force boolean (可选)#

      是否绕过可操作性检查。默认为 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()。了解更多关于 定位器 的信息。

该方法通过以下步骤点击匹配 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 (可选)#

      是否绕过 可操作性 检查。默认为 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。可用于等待元素准备好执行操作而不实际执行它。注意键盘 modifiers 仍会被按下（无论 trial 如何设置），以便测试仅在按下这些键时才可见的元素。

返回值

dblclick​

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

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

该方法通过以下步骤双击匹配 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 (可选)#

      是否绕过 可操作性 检查。默认为 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。可用于等待元素准备好执行操作而不实际执行它。请注意，键盘 modifiers 无论 trial 如何都会被按下，以便测试仅在按下这些键时才可见的元素。

返回

dispatchEvent​

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

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

以下代码片段会在元素上派发 click 事件。无论元素是否可见，都会派发 click 事件。这等同于调用 element.click()。

用法

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

在底层实现中，它会根据给定的 type 创建一个事件实例，使用 eventInit 属性初始化该事件，然后在元素上派发该事件。默认情况下，事件是 composed（可组合）、cancelable（可取消）且会冒泡的。

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

如果需要将动态对象传递到事件中，也可以指定 JSHandle 作为属性值：

// 注意：只能在 Chromium 和 Firefox 中创建 DataTransfer
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()。了解更多关于 定位器 的信息。

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

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，该方法会抛出错误。但如果元素位于具有关联 控件 的 <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 版本添加#

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

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • strict boolean (可选) v1.14 版本添加#

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

    • timeout number (可选)#

      最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

focus​

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

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

该方法通过选择器查找元素并使其获得焦点。如果没有匹配选择器的元素，该方法会等待直到匹配元素出现在 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()。了解更多关于 定位器 的信息。

返回元素的属性值。

用法

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()。了解更多关于定位器的信息。

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

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

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

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • force boolean (可选)#

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

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

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

    • noWaitAfter 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() 方法。了解更多关于 定位器 的信息。

返回 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()。了解更多关于定位器的信息。

返回 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()。了解更多关于 定位器 的信息。

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

对于非输入元素会抛出异常。但如果该元素位于具有关联 控件 的 <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() 方法。了解更多关于定位器的信息。

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

用法

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()。了解更多关于 定位器 的信息。

返回元素是否处于禁用状态，与 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()。了解更多关于 定位器 的信息。

返回元素是否处于可编辑状态。

用法

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()。了解更多关于定位器的信息。

返回元素是否处于隐藏状态，与 visible 状态相反。未匹配到任何元素的 selector 会被视为隐藏状态。

用法

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()。了解更多关于 定位器 的信息。

返回元素是否处于可见状态。不匹配任何元素的选择器会被视为不可见。

用法

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()。了解更多关于 定位器 的信息。

聚焦元素，然后使用 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()。了解更多关于定位器的信息。

该方法会等待匹配 selector 的元素，执行可操作性检查，等待所有指定选项出现在 <select> 元素中，然后选择这些选项。

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

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

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

用法

// 匹配值或标签的单选
page.selectOption('select#colors', 'blue');

// 匹配标签的单选
page.selectOption('select#colors', { label: 'Blue' });

// 多选
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 添加#

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

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • timeout number (可选)#

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

返回值

setChecked​

添加于: v1.15 page.setChecked
不推荐

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

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

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

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

用法

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

参数

  • selector string#

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

  • checked boolean#

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

  • options Object (可选)

    • force boolean (可选)#

      是否绕过可操作性检查。默认为 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()。了解更多关于定位器的信息。

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

此方法期望 selector 指向一个 input 元素。但如果该元素位于 <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()。了解更多关于 定位器 的信息。

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

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

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

备注

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

用法

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

参数

  • selector string#

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

  • options Object (可选)

    • force boolean (可选)#

      是否绕过 可操作性 检查。默认为 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。可用于等待元素准备好执行操作而不实际执行它。注意键盘 modifiers 无论 trial 如何都会被按下，以便测试仅在按下这些键时才可见的元素。

返回值

textContent​

v1.9 之前版本添加 page.textContent
不推荐使用

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

返回 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() 方法。了解更多关于定位器的信息。

该方法通过以下步骤取消选中匹配 selector 的元素：

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

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

用法

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

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素匹配选择器，将使用第一个。

  • options Object (可选)

    • force boolean (可选)#

      是否绕过可操作性检查。默认为 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 触发导航。参考以下示例：

// 在点击前开始等待导航。注意此处没有 await。
const navigationPromise = page.waitForNavigation();
await page.getByText('Navigate after timeout').click();
await navigationPromise;
备注

使用 History API 改变 URL 的行为会被视为导航。

参数

  • options Object (可选)

    • timeout number (可选)#

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

    • url string | RegExp | function(URL):boolean (可选)#

      用于匹配等待导航的 URL 的 glob 模式、正则表达式或谓词函数。注意：如果参数是不含通配符的字符串，方法将等待导航至完全匹配该字符串的 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 优先断言可以使代码无需等待选择器。

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

用法

此方法在页面导航时仍然有效：

const { chromium } = require('playwright');  // 或 'firefox' 或 '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 断言。

等待指定的毫秒数 timeout。

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

用法

// 等待 1 秒
await page.waitForTimeout(1000);

参数

  • timeout number#

    要等待的超时时间（毫秒）

返回值