跳到主要内容

Page

Page 提供了用于与 Browser 中的单个标签页或 Chromium 中的扩展程序后台页面进行交互的方法。一个 Browser 实例可以有多个 Page 实例。

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

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

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

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

此示例为单个页面 load 事件记录一条消息

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

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

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

方法​

addInitScript​

添加于 v1.9 之前 page.addInitScript

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

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

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

用法

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

// preload.js
Math.random = () => 42;
// In your playwright script, assuming the preload.js file is in same directory
await page.addInitScript({ path: './preload.js' });
await page.addInitScript(mock => {
  window.mock = mock;
}, mock);
注意

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

参数

  • script 函数 | 字符串 | 对象#

    • path 字符串 （可选）

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

    • content 字符串 （可选）

      原始脚本内容。可选。

    要在页面中执行的脚本。

  • arg 可序列化 （可选）#

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

返回值

addLocatorHandler​

添加于: v1.42 page.addLocatorHandler

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

此方法允许您设置一个特殊函数，称为处理程序 (handler)，它在检测到覆盖层可见时激活。处理程序的作用是移除覆盖层，让您的测试能够继续，就像覆盖层不存在一样。

注意事项

  • 当覆盖层可预测地显示时，我们建议在您的测试中明确等待它并将其作为正常测试流程的一部分来关闭它，而不是使用 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<对象>#

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

  • options 对象 （可选）

    • noWaitAfter 布尔值 （可选）添加于: v1.44#

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

    • times 数字 （可选）添加于: v1.44#

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

返回值

addScriptTag​

添加于 v1.9 之前 page.addScriptTag

使用所需的 URL 或内容将一个 <script> 标签添加到页面中。当脚本的 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

使用所需的 URL 将 <link rel="stylesheet"> 标签或使用内容将 <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 内容，包括 doctype。

用法

await page.content();

返回值

context​

添加于 v1.9 之前 page.context

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

用法

page.context();

返回值

dragAndDrop​

添加于: v1.13 page.dragAndDrop

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

用法

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

参数

  • source 字符串#

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

  • target 字符串#

    用于搜索要放置元素的元素的选择器。如果存在多个满足选择器的元素，将使用第一个。

  • options 对象 （可选）

    • force 布尔值 （可选）#

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

    • noWaitAfter 布尔值 （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • sourcePosition 对象 （可选）添加于: v1.14#

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

    • strict 布尔值 （可选）添加于: v1.14#

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

    • targetPosition 对象 （可选）添加于: v1.14#

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

    • timeout 数字 （可选）#

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

    • trial 布尔值 （可选）#

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

返回值

emulateMedia​

添加于 v1.9 之前 page.emulateMedia

此方法通过 media 参数更改 CSS media type，并通过 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 对象 （可选）

    • 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() 的函数返回一个非可序列化的值，则 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

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

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

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

注意

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

用法

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

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（布尔值） (optional)（可选）#

      已弃用

      此选项将在未来移除。

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

返回值

exposeFunction​

添加于 v1.9 之前 page.exposeFunction

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

如果 callback 返回一个 Promise，则会等待其完成。

有关上下文范围的 exposed function，请参见 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');
})();

参数

返回值

frame​

添加于 v1.9 之前 page.frame

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

用法

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

参数

返回值

frameLocator​

添加于: v1.17 page.frameLocator

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

用法

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

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

参数

返回值

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

参数

返回值

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

参数

返回值

getByPlaceholder​

添加于: v1.27 page.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

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

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

参数

返回值

getByRole​

添加于: v1.27 page.getByRole

允许按元素的 ARIA role、ARIA attributes 和 可访问名称 定位元素。

用法

考虑以下 DOM 结构。

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

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

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 role。

  • options 对象 （可选）

返回值

详情

Role 选择器 **不会取代** 可访问性审计和一致性测试，而是提供了关于 ARIA 准则的早期反馈。

许多 HTML 元素都有一个 隐式定义的 role，role 选择器可以识别它们。您可以在此处找到所有受支持的 role。ARIA 准则**不推荐**通过将 role 和/或 aria-* 属性设置为默认值来重复隐式 role 和属性。

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()，它允许按其他条件（如可访问 role）进行匹配，然后按文本内容过滤。

用法

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

参数

返回值

详情

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

类型为 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 文本定位后检查 issues 计数

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

参数

返回值

goBack​

添加于 v1.9 之前 page.goBack

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

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

用法

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

参数

  • options 对象 （可选）

    • timeout number（数字） (optional)（可选）#

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

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

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

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

返回值

goForward​

添加于 v1.9 之前 page.goForward

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

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

用法

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

参数

  • options 对象 （可选）

    • timeout number（数字） (optional)（可选）#

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

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

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

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

返回值

goto​

添加于 v1.9 之前 page.goto

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

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

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

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

注意

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

注意

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

用法

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

参数

  • url string（字符串）#

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

  • options 对象 （可选）

    • referer string（字符串） (optional)（可选）#

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

    • timeout number（数字） (optional)（可选）#

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

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

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

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

返回值

isClosed​

添加于 v1.9 之前 page.isClosed

指示页面是否已关闭。

用法

page.isClosed();

返回值

locator​

添加于: v1.14 page.locator

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

了解更多关于 locator 的信息.

用法

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

参数

  • selector string（字符串）#

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

  • options 对象 （可选）

    • has Locator (optional)（可选）#

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

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

      请注意，外部和内部定位器必须属于同一个 frame。内部定位器不能包含 FrameLocator。

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

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

      请注意，外部和内部定位器必须属于同一个 frame。内部定位器不能包含 FrameLocator。

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

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

    • hasText 字符串 | RegExp (可选)#

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

返回值

mainFrame​

添加于 v1.9 之前 page.mainFrame

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

用法

page.mainFrame();

返回值

opener​

添加于 v1.9 之前 page.opener

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

用法

await page.opener();

返回值

pause​

添加于: v1.9 page.pause

暂停脚本执行。Playwright 将停止执行脚本，并等待用户在页面叠加层中按下“Resume”按钮或在开发者工具控制台中调用 playwright.resume()。

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

注意

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

用法

await page.pause();

返回值

pdf​

添加于 v1.9 之前 page.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 - 毫米

The format 选项包括

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

headerTemplate 和 footerTemplate 标记有以下限制：> 1. 模板内的 Script 标签不会被执行。> 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 字符串 | 数值 (可选)#

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

返回值

reload​

添加于 v1.9 之前 page.reload

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

用法

await page.reload();
await page.reload(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 毫秒内没有网络连接时，认为操作完成。不要将此方法用于测试，而是依赖 web assertion 来评估就绪状态。
      • 'commit' - 当接收到网络响应并且文档开始加载时，认为操作完成。

返回值

removeAllListeners​

新增于：v1.47 page.removeAllListeners

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

用法

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

参数

  • type 字符串 (可选)#
  • options 对象 （可选）

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

      指定是否等待已运行的监听器完成，以及如果它们抛出错误该如何处理

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

返回值

removeLocatorHandler​

添加于: v1.44 page.removeLocatorHandler

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

用法

await page.removeLocatorHandler(locator);

参数

返回值

requestGC​

新增于：v1.48 page.requestGC

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

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

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

用法

await page.requestGC();

返回值

route​

添加于 v1.9 之前 page.route

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

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

注意

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

注意

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

注意

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

用法

一个简单的处理程序示例，它中止所有图像请求

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

或者使用 regex 模式的相同代码片段

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

可以检查请求来决定路由动作。例如，模拟包含某些 post 数据的所有请求，而其他请求保持不变。

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

当请求匹配两个处理程序时，页面路由优先于浏览器上下文路由（使用 browserContext.route() 设置的路由）。

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

注意

启用路由会禁用 http 缓存。

参数

  • url 字符串 | RegExp | 函数(URL):布尔值#

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

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

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

  • options 对象 （可选）

    • times 数字 （可选）添加于: v1.15#

      路由应该被使用的频率。默认情况下每次都会使用。

返回值

routeFromHAR​

新增于：v1.23 page.routeFromHAR

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

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

用法

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

参数

  • har 字符串#

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

  • options 对象 （可选）

    • notFound "abort" | "fallback" (可选)#

      • 如果设置为 'abort'，HAR 文件中未找到的任何请求都将被中止。
      • 如果设置为 'fallback'，缺失的请求将发送到网络。

      默认为 abort。

    • update 布尔值 (可选)#

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

    • updateContent "embed" | "attach" (可选)新增于：v1.32#

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

    • updateMode "full" | "minimal" (可选)新增于：v1.32#

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

    • url 字符串 | 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 对象 （可选）

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

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

      • 有限动画会快进到完成，因此它们会触发 transitionend 事件。
      • 无限动画会被取消并回到初始状态，然后在截屏后重新播放。

      默认为 "allow"，它不干预动画。

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

      当设置为 "hide" 时，屏幕截图将隐藏文本插入符。当设置为 "initial" 时，文本插入符行为不会改变。默认为 "hide"。

    • clip 对象 (可选)#

      • x 数字

        裁剪区域左上角的 x 坐标

      • y 数字

        裁剪区域左上角的 y 坐标

      • width 数值

        裁剪区域宽度

      • height 数值

        裁剪区域高度

      指定结果图像裁剪的对象。

    • fullPage 布尔值 (可选)#

      当为 true 时，捕获整个可滚动页面的屏幕截图，而不是当前可见的视口。默认为 false。

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

      指定在截取屏幕截图时应被遮盖（mask）的定位符。被遮盖的元素将被一个粉色方框 #FF00FF（可通过 maskColor 定制）覆盖，该方框将完全覆盖其边界框。该遮盖也适用于不可见元素，请参阅 仅匹配可见元素 来禁用此行为。

    • maskColor string （可选）添加于: v1.35#

      指定被遮盖元素的叠加框颜色，使用 CSS 颜色格式。默认颜色为粉色 #FF00FF。

    • omitBackground boolean （可选）#

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

    • path string （可选）#

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

    • quality number （可选）#

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

    • scale "css" | "device" （可选）#

      当设置为 "css" 时，屏幕截图的每个 CSS 像素将对应一个设备像素。对于高 DPI 设备，这会保持屏幕截图文件较小。使用 "device" 选项会为每个设备像素生成一个像素，因此高 DPI 设备的屏幕截图会大两倍或更多。

      默认为 "device"。

    • style string （可选）添加于: v1.41#

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

    • timeout number （可选）#

      最长等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过 config 中的 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 对象 （可选）

    • 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 assertion 来评估就绪状态。
      • 'commit' - 当接收到网络响应并且文档开始加载时，认为操作完成。

返回值

setDefaultNavigationTimeout​

添加于 v1.9 之前 page.setDefaultNavigationTimeout

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

注意

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

用法

page.setDefaultNavigationTimeout(timeout);

参数

  • timeout number#

    最大导航时间，单位为毫秒

setDefaultTimeout​

添加于 v1.9 之前 page.setDefaultTimeout

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

注意

page.setDefaultNavigationTimeout() 的优先级高于 page.setDefaultTimeout()。

用法

page.setDefaultTimeout(timeout);

参数

  • timeout number#

    最大时间，单位为毫秒。传递 0 可禁用超时。

setExtraHTTPHeaders​

添加于 v1.9 之前 page.setExtraHTTPHeaders

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

注意

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

用法

await page.setExtraHTTPHeaders(headers);

参数

  • headers Object<string, string>#

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

返回值

setViewportSize​

添加于 v1.9 之前 page.setViewportSize

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

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

用法

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

与此页面关联的 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 assertions 来评估准备情况。

  • 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 毫秒内没有网络连接时，认为操作完成。不要将此方法用于测试，而是依赖 web assertion 来评估就绪状态。
      • 'commit' - 当接收到网络响应并且文档开始加载时，认为操作完成。

返回值

workers​

添加于 v1.9 之前 page.workers

此方法返回与该页面关联的所有 dedicated WebWorkers。

注意

这不包含 ServiceWorkers

用法

page.workers();

返回值

属性​

clock​

添加于: v1.45 page.clock

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

用法

page.clock

类型

coverage​

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

目前仅适用于 Chromium。

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

用法

page.coverage

类型

keyboard​

添加于 v1.9 之前 page.keyboard

用法

page.keyboard

类型

mouse​

添加于 v1.9 之前 page.mouse

用法

page.mouse

类型

request​

添加于: v1.16 page.request

与此页面关联的 API 测试辅助工具。此方法返回与 page 的上下文上的 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 调用了其中一个 console API 方法（例如 console.log 或 console.dir）时触发。

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

用法

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

事件数据

on('crash')​

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

页面崩溃时触发。浏览器页面可能会因为尝试分配过多内存而崩溃。页面崩溃后，正在进行和后续的操作将抛出错误。

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

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

用法

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

事件数据

on('dialog')​

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

当 JavaScript 对话框出现时触发，例如 alert, prompt, confirm 或 beforeunload。监听器必须通过 dialog.accept() 或 dialog.dismiss() 处理该对话框，否则页面将冻结，等待对话框处理，并且点击等操作将永远不会完成。

用法

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

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

事件数据

on('domcontentloaded')​

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

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

用法

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

事件数据

on('download')​

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

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

用法

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

事件数据

on('filechooser')​

添加于: v1.9 page.on('filechooser')

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

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

用法

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

事件数据

on('frameattached')​

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

当一个 frame 被附加时触发。

用法

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

事件数据

on('framedetached')​

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

当一个 frame 被分离时触发。

用法

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

事件数据

on('framenavigated')​

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

当一个 frame 导航到新的 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.$
不推荐使用

请改用基于 locator 的 page.locator() 方法。阅读更多关于 locators 的内容。

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

用法

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

参数

  • selector string#

    用于查询的选择器。

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

返回值

$$​

添加于: v1.9 page.$$
不推荐使用

请改用基于 locator 的 page.locator() 方法。阅读更多关于 locators 的内容。

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

用法

await page.$$(selector);

参数

  • selector string#

    用于查询的选择器。

返回值

$eval​

添加于: v1.9 page.$eval
不推荐使用

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

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

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

用法

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

参数

  • selector string#

    用于查询的选择器。

  • pageFunction function(Element) | string#

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

  • arg EvaluationArgument (可选)#

    可选参数，用于传递给 pageFunction。

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

返回值

$$eval​

添加于: v1.9 page.$$eval
不推荐使用

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

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

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

用法

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

参数

返回值

accessibility​

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

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

用法

page.accessibility

类型

check​

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

请改用基于 locator 的 locator.check() 方法。阅读更多关于 locators 的内容。

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

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

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • force boolean (可选)#

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

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

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

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

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

返回值

click​

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

请改用基于 locator 的 locator.click() 方法。阅读更多关于 locators 的内容。

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

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

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

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

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

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

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

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

      设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。用于在不执行操作的情况下等待元素准备就绪。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以便测试只有在这些键按下时才可见的元素。

返回值

dblclick​

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

请改用基于 locator 的 locator.dblclick() 方法。阅读更多关于 locators 的内容。

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

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

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

注意

page.dblclick() 会触发两个 click 事件和一个 dblclick 事件。

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

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

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

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

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

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

      设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。用于在不执行操作的情况下等待元素准备就绪。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以便测试只有在这些键按下时才可见的元素。

返回值

dispatchEvent​

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

请改用基于 locator 的 locator.dispatchEvent() 方法。阅读更多关于 locators 的内容。

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

用法

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

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

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

如果您希望将 live 对象传递给事件，您还可以将 JSHandle 指定为属性值。

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

参数

  • selector string#

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

  • type string#

    DOM 事件类型: "click", "dragstart" 等。

  • eventInit EvaluationArgument (可选)#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

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

返回值

fill​

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

使用基于定位符的 locator.fill() 来代替。详细了解 locators。

此方法等待匹配 selector 的元素出现，等待 可操作性 (actionability) 检查通过，聚焦元素，填充元素并在填充后触发 input 事件。注意，你可以传递一个空字符串来清除输入字段。

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

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

用法

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

参数

  • selector string#

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

  • value string#

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

  • options 对象 （可选）

    • force boolean （可选）添加于: v1.13#

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

    • noWaitAfter boolean （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

focus​

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

使用基于定位符的 locator.focus() 来代替。详细了解 locators。

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

getAttribute​

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

使用基于定位符的 locator.getAttribute() 来代替。详细了解 locators。

返回元素的属性值。

用法

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

参数

  • selector string#

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

  • name string#

    要获取值的属性名称。

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

hover​

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

使用基于定位符的 locator.hover() 来代替。详细了解 locators。

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

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

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • force boolean （可选）#

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

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

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

    • noWaitAfter 布尔值 （可选）添加于: v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • position Object （可选）#

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

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

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

      设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。用于在不执行操作的情况下等待元素准备就绪。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以便测试只有在这些键按下时才可见的元素。

返回值

innerHTML​

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

使用基于定位符的 locator.innerHTML() 来代替。详细了解 locators。

返回 element.innerHTML。

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

innerText​

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

使用基于定位符的 locator.innerText() 来代替。详细了解 locators。

返回 element.innerText。

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

inputValue​

添加于: v1.13 page.inputValue
不推荐使用

使用基于定位符的 locator.inputValue() 来代替。详细了解 locators。

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

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

isChecked​

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

使用基于定位符的 locator.isChecked() 来代替。详细了解 locators。

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

isDisabled​

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

使用基于定位符的 locator.isDisabled() 来代替。详细了解 locators。

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

isEditable​

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

使用基于定位符的 locator.isEditable() 来代替。详细了解 locators。

返回元素是否 可编辑 (editable)。

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

isEnabled​

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

使用基于定位符的 locator.isEnabled() 来代替。详细了解 locators。

返回元素是否 已启用 (enabled)。

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

isHidden​

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

使用基于定位符的 locator.isHidden() 来代替。详细了解 locators。

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

      已弃用

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

返回值

isVisible​

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

使用基于定位符的 locator.isVisible() 来代替。详细了解 locators。

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

      已弃用

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

返回值

press​

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

使用基于定位符的 locator.press() 来代替。详细了解 locators。

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

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

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

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

按住 Shift 将输入对应于大写 key 的文本。

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

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

用法

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

参数

  • selector string#

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

  • key string#

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

  • options 对象 （可选）

    • delay number （可选）#

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

    • noWaitAfter boolean （可选）#

      已弃用

      此选项在将来将默认为 true。

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

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

selectOption​

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

使用基于定位符的 locator.selectOption() 来代替。详细了解 locators。

此方法等待匹配 selector 的元素出现，等待 可操作性 (actionability) 检查通过，等待 <select> 元素中出现所有指定的选项并选中这些选项。

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

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

所有提供的选项被选中后，触发 change 和 input 事件。

用法

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

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

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

参数

  • selector string#

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

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

    • value string （可选）

      匹配 option.value。可选。

    • label string （可选）

      匹配 option.label。可选。

    • index number （可选）

      按索引匹配。可选。

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

  • options 对象 （可选）

    • force boolean （可选）添加于: v1.13#

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

    • noWaitAfter boolean （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number （可选）#

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

返回值

setChecked​

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

使用基于定位符的 locator.setChecked() 来代替。详细了解 locators。

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

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

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

用法

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

参数

  • selector string#

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

  • checked boolean#

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

  • options 对象 （可选）

    • force boolean （可选）#

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

    • noWaitAfter boolean （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • position Object （可选）#

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

    • strict boolean （可选）#

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

    • timeout number （可选）#

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

    • trial boolean （可选）#

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

返回值

setInputFiles​

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

使用基于定位符的 locator.setInputFiles() 来代替。详细了解 locators。

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

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

用法

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

参数

  • selector string#

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

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

  • options 对象 （可选）

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

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

返回值

tap​

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

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

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

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

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

注意

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • force boolean (可选)#

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

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

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

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position Object (可选)#

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

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

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

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

      设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。用于在不执行操作的情况下等待元素准备就绪。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以便测试只有在这些键按下时才可见的元素。

返回值

textContent​

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

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

返回 element.textContent。

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

      最长等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过 config 中的 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 对象 （可选）

    • delay number (可选)#

      两次按键之间的等待时间，单位为毫秒。默认为 0。

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

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

返回值

uncheck​

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

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

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

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

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

用法

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

参数

  • selector string#

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

  • options 对象 （可选）

    • force boolean (可选)#

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

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • strict 布尔值 （可选）添加于: v1.14#

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

    • timeout number (可选)#

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

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

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

返回值

waitForNavigation​

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

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

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

用法

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

// Start waiting for navigation before clicking. Note no await.
const navigationPromise = page.waitForNavigation();
await page.getByText('Navigate after timeout').click();
await navigationPromise;
注意

使用 History API 更改 URL 被视为导航。

参数

  • options 对象 （可选）

    • timeout number (可选)#

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

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

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

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

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

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

返回值

waitForSelector​

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

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

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

注意

Playwright 在执行操作之前会自动等待元素准备就绪。使用 Locator 对象和 web-first 断言可以使代码无需使用 wait-for-selector。

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

用法

此方法在导航过程中仍然有效

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

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

参数

  • selector string#

    用于查询的选择器。

  • options 对象 （可选）

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

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

返回值

waitForTimeout​

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

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

等待给定的 timeout 毫秒。

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

用法

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

参数

  • timeout number#

    要等待的超时时间

返回值