跳到主要内容

Page

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

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

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch();
      BrowserContext context = browser.newContext();
      Page page = context.newPage();
      page.navigate("https://example.com");
      page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("screenshot.png")));
      browser.close();
    }
  }
}

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

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

page.onLoad(p -> System.out.println("Page loaded!"));

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

Consumer<Request> logRequest = interceptedRequest -> {
  System.out.println("A request was made: " + interceptedRequest.url());
};
page.onRequest(logRequest);
// 一段时间后...
page.offRequest(logRequest);

方法​

addInitScript​

在 v1.9 之前添加 page.addInitScript

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

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

该脚本会在文档创建后但在其任何脚本运行之前执行。这对于修改 JavaScript 环境很有用，例如设置 Math.random 的初始值。

用法

在页面加载之前重写 Math.random 的示例：

// preload.js
Math.random = () => 42;
// 在你的 Playwright 脚本中，假设 preload.js 文件在同一目录中
page.addInitScript(Paths.get("./preload.js"));
备注

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

参数

  • script String | Path#

    要在浏览器上下文中的所有页面中执行的脚本。

返回值

addLocatorHandler​

新增于：v1.42 page.addLocatorHandler

在测试网页时，有时会出现意外的覆盖层，如 “注册” 对话框，这些覆盖层会阻挡你想要自动化执行的操作，例如点击按钮。这些覆盖层的出现方式和时间并不总是一致，这使得在自动化测试中处理它们变得棘手。

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

请注意以下几点：

  • 如果覆盖层的出现是可预测的，我们建议在测试中明确等待它出现，并在正常测试流程中关闭它，而不是使用 Page.addLocatorHandler()。
  • Playwright 每次在执行或重试需要进行可操作性检查的操作之前，或者在执行自动等待断言检查之前，都会检查是否存在覆盖层。当覆盖层可见时，Playwright 会首先调用处理程序，然后再继续执行操作/断言。请注意，只有在你执行操作/断言时才会调用处理程序 —— 如果覆盖层可见但你没有执行任何操作，则不会触发处理程序。
  • 执行处理程序后，Playwright 将确保触发处理程序的覆盖层不再可见。你可以使用 setNoWaitAfter 选择不进行此操作。
  • 处理程序的执行时间计入执行该处理程序的操作/断言的超时时间。如果你的处理程序耗时过长，可能会导致超时。
  • 你可以注册多个处理程序。但是，一次只会运行一个处理程序。请确保一个处理程序中的操作不依赖于另一个处理程序。
注意

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

例如，假设有一个测试，先调用 Locator.focus()，然后调用 Keyboard.press()。如果你的处理程序在这两个操作之间点击了一个按钮，那么聚焦的元素很可能是错误的，按键操作将发生在意外的元素上。为避免此问题，请改用 Locator.press()。

另一个例子是一系列鼠标操作，先调用 Mouse.move()，然后调用 Mouse.down()。同样，当处理程序在这两个操作之间运行时，鼠标按下时的鼠标位置将是错误的。建议使用像 Locator.click() 这样自包含的操作，这些操作不依赖于处理程序未改变的状态。

用法​

以下是一个在“订阅新闻通讯”对话框出现时将其关闭的示例：

// 设置处理程序。
page.addLocatorHandler(page.getByText("订阅新闻通讯"), () -> {
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("不用了，谢谢")).click();
});

// 像往常一样编写测试。
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("从这里开始")).click();

以下是一个在显示“确认您的安全详细信息”页面时跳过该页面的示例：

// 设置处理程序。
page.addLocatorHandler(page.getByText("确认您的安全详细信息"), () -> {
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("稍后提醒我")).click();
});

// 像往常一样编写测试。
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("从这里开始")).click();

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

// 设置处理程序。
page.addLocatorHandler(page.locator("body"), () -> {
  page.evaluate("window.removeObstructionsForTestIfNeeded()");
}, new Page.AddLocatorHandlerOptions().setNoWaitAfter(true));

// 像往常一样编写测试。
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("从这里开始")).click();

处理程序将原始定位器作为参数。你还可以通过设置 setTimes 在调用一定次数后自动移除处理程序：

page.addLocatorHandler(page.getByLabel("关闭"), locator -> {
  locator.click();
}, new Page.AddLocatorHandlerOptions().setTimes(1));

参数​

  • locator Locator# 触发此处理程序的定位器（Locator）。
  • handler Consumer<Locator># 当 locator 出现时应运行的函数。此函数应移除阻止诸如点击等操作的元素。
  • options Page.AddLocatorHandlerOptions（可选）
    • setNoWaitAfter boolean（可选） 新增于：v1.44# 默认情况下，调用处理程序后，Playwright 将等待覆盖层隐藏，只有在此时，Playwright 才会继续执行触发处理程序的操作或断言。此选项允许不采用此行为，以便在处理程序运行后覆盖层仍可保持可见。
    • setTimes int（可选） 新增于：v1.44# 指定此处理程序应被调用的最大次数。默认无限制。

返回值​

addScriptTag​

在 v1.9 之前添加 page.addScriptTag

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

用法

Page.addScriptTag();
Page.addScriptTag(options);

参数

  • options Page.AddScriptTagOptions（可选）

    • setContent String（可选）#

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

    • setPath Path（可选）#

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

    • setType String（可选）#

      脚本类型。使用 module 来加载 JavaScript ES6 模块。更多详细信息请参见 script。

    • setUrl String（可选）#

      要添加的脚本的 URL。

返回值

addStyleTag​

在 v1.9 之前添加 page.addStyleTag

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

用法

Page.addStyleTag();
Page.addStyleTag(options);

参数

  • options Page.AddStyleTagOptions（可选）

    • setContent String（可选）#

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

    • setPath Path（可选）#

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

    • setUrl String（可选）#

      <link> 标签的 URL。

返回值

bringToFront​

在 v1.9 之前添加 page.bringToFront

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

用法

Page.bringToFront();

返回值

close​

在 v1.9 之前添加 page.close

如果 setRunBeforeUnload 为 false，则不会运行任何卸载处理程序，并等待页面关闭。如果 setRunBeforeUnload 为 true，该方法将运行卸载处理程序，但 不会 等待页面关闭。

默认情况下，page.close() 不会 运行 beforeunload 处理程序。

备注

如果 setRunBeforeUnload 被设为 true，可能会弹出一个 beforeunload 对话框，应通过 Page.onDialog(handler) 事件手动处理。

用法

Page.close();
Page.close(options);

参数

  • options Page.CloseOptions (可选)

    • setReason String (可选) 在 v1.40 中添加#

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

    • setRunBeforeUnload boolean (可选)#

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

返回值

content​

在 v1.9 之前添加 page.content

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

用法

Page.content();

返回值

context​

在 v1.9 之前添加 page.context

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

用法

Page.context();

返回值

dragAndDrop​

添加于：v1.13 page.dragAndDrop

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

用法

page.dragAndDrop("#source", "#target");
// 或者指定相对于元素左上角的精确位置：
page.dragAndDrop("#source", "#target", new Page.DragAndDropOptions()
  .setSourcePosition(34, 7).setTargetPosition(10, 20));

参数

  • source String#

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

  • target String#

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

  • options Page.DragAndDropOptions (可选)

    • setForce boolean (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setSourcePosition SourcePosition (可选) 新增于：v1.14#

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

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

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

    • setTargetPosition TargetPosition (可选) 新增于：v1.14#

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setTrial boolean (可选)#

      设置后，此方法仅执行 可操作性 检查并跳过操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作很有用。

返回值

emulateMedia​

在 v1.9 之前添加 page.emulateMedia

此方法通过 media 参数更改 CSS 媒体类型，和 / 或使用 colorScheme 参数更改 'prefers-colors-scheme' 媒体特性。

用法

page.evaluate("() => matchMedia('screen').matches");
// → true
page.evaluate("() => matchMedia('print').matches");
// → false

page.emulateMedia(new Page.EmulateMediaOptions().setMedia(Media.PRINT));
page.evaluate("() => matchMedia('screen').matches");
// → false
page.evaluate("() => matchMedia('print').matches");
// → true

page.emulateMedia(new Page.EmulateMediaOptions());
page.evaluate("() => matchMedia('screen').matches");
// → true
page.evaluate("() => matchMedia('print').matches");
// → false
page.emulateMedia(new Page.EmulateMediaOptions().setColorScheme(ColorScheme.DARK));
page.evaluate("() => matchMedia('(prefers-color-scheme: dark)').matches");
// → true
page.evaluate("() => matchMedia('(prefers-color-scheme: light)').matches");
// → false

参数

  • options Page.EmulateMediaOptions（可选）

    • setColorScheme null | enum ColorScheme { LIGHT, DARK, NO_PREFERENCE }（可选）新增于：v1.9#

      模拟 prefers-colors-scheme 媒体特性，支持的值为 'light' 和 'dark'。传入 null 可禁用颜色模式模拟。'no-preference' 已弃用。

    • setContrast null | enum Contrast { NO_PREFERENCE, MORE }（可选）新增于：v1.51#

      模拟 'prefers-contrast' 媒体特性，支持的值为 'no-preference'、'more'。传入 null 可禁用对比度模拟。

    • setForcedColors null | enum ForcedColors { ACTIVE, NONE }（可选）新增于：v1.15#

      模拟 'forced-colors' 媒体特性，支持的值为 'active' 和 'none'。传入 null 可禁用强制颜色模拟。

    • setMedia null | enum Media { SCREEN, PRINT }（可选）新增于：v1.9#

      更改页面的 CSS 媒体类型。仅允许的值为 'screen'、'print' 和 null。传入 null 可禁用 CSS 媒体模拟。

    • setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE }（可选）新增于：v1.12#

      模拟 'prefers-reduced-motion' 媒体特性，支持的值为 'reduce'、'no-preference'。传入 null 可禁用减少动画模拟。

返回值

evaluate​

在 v1.9 之前添加 page.evaluate

返回 expression 调用的值。

如果传递给 Page.evaluate() 的函数返回一个 Promise，那么 Page.evaluate() 将等待该 Promise 解决并返回其值。

如果传递给 Page.evaluate() 的函数返回一个非 Serializable 值，那么 Page.evaluate() 将解析为 undefined。Playwright 还支持传递一些 JSON 无法序列化的额外值：-0、NaN、Infinity、-Infinity。

用法

向 expression 传递参数：

Object result = page.evaluate("([x, y]) => {\n" +
  "  return Promise.resolve(x * y);\n" +
  "}", Arrays.asList(7, 8));
System.out.println(result); // 输出 "56"

也可以传入一个字符串而不是函数：

System.out.println(page.evaluate("1 + 2")); // 输出 "3"

ElementHandle 实例可以作为参数传递给 Page.evaluate()：

ElementHandle bodyHandle = page.evaluate("document.body");
String html = (String) page.evaluate("([body, suffix]) => body.innerHTML + suffix", Arrays.asList(bodyHandle, "hello"));
bodyHandle.dispose();

参数

  • expression String#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则该函数会自动调用。

  • arg EvaluationArgument（可选）#

    传递给 expression 的可选参数。

返回值

evaluateHandle​

在 v1.9 之前添加 page.evaluateHandle

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

Page.evaluate() 和 Page.evaluateHandle() 之间的唯一区别在于 Page.evaluateHandle() 返回 JSHandle。

如果传递给 Page.evaluateHandle() 的函数返回一个 Promise，那么 Page.evaluateHandle() 将等待该 Promise 解决并返回其值。

使用方法​

// 窗口对象的句柄。
JSHandle aWindowHandle = page.evaluateHandle("() => Promise.resolve(window)");

也可以传入字符串，而非函数：

JSHandle aHandle = page.evaluateHandle("document"); // “document”的句柄。

JSHandle 实例可以作为参数传递给 Page.evaluateHandle()：

JSHandle aHandle = page.evaluateHandle("() => document.body");
JSHandle resultHandle = page.evaluateHandle("([body, suffix]) => body.innerHTML + suffix", Arrays.asList(aHandle, "hello"));
System.out.println(resultHandle.jsonValue());
resultHandle.dispose();

参数​

  • expression String#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument（可选）#

    传递给 expression 的可选参数。

返回值​

exposeBinding​

在 v1.9 之前添加 page.exposeBinding

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

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

有关作用于上下文范围的版本，请参阅 BrowserContext.exposeBinding()。

备注

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

用法​

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

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
      BrowserContext context = browser.newContext();
      Page page = context.newPage();
      page.exposeBinding("pageURL", (source, args) -> source.page().url());
      page.setContent("<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.pageURL();\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>");
      page.click("button");
    }
  }
}

参数​

  • name String# 窗口对象上函数的名称。
  • callback BindingCallback# 将在 Playwright 上下文中调用的回调函数。
  • options Page.ExposeBindingOptions（可选）
    已弃用

    此选项将来会被移除。

    是否以句柄形式传递参数，而不是按值传递。传递句柄时，仅支持一个参数。按值传递时，支持多个参数。

返回值

exposeFunction​

在 v1.9 之前添加 page.exposeFunction

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

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

有关上下文范围内暴露的函数，请参阅 BrowserContext.exposeFunction()。

备注

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

用法​

以下是向页面添加 sha256 函数的示例：

import com.microsoft.playwright.*;

import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
      Page page = browser.newPage();
      page.exposeFunction("sha256", args -> {
        try {
          String text = (String) args[0];
          MessageDigest crypto = MessageDigest.getInstance("SHA-256");
          byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));
          return Base64.getEncoder().encodeToString(token);
        } catch (NoSuchAlgorithmException e) {
          return null;
        }
      });
      page.setContent(
        "<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>"
      );
      page.click("button");
    }
  }
}

参数​

  • name String# 窗口对象上函数的名称。
  • callback FunctionCallback# 将在 Playwright 上下文中调用的回调函数。

返回值

frame​

在 v1.9 之前添加 page.frame

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

用法

Frame frame = page.frame("frame-name");
Frame frame = page.frameByUrl(Pattern.compile(".*domain.*"));

参数

  • name String 添加于：v1.9#

    iframe 的 name 属性中指定的框架名称。

返回值

frameByUrl​

添加于：v1.9 page.frameByUrl

返回与 URL 匹配的框架。

用法

Page.frameByUrl(url);

参数

返回值

frameLocator​

新增于：v1.17 page.frameLocator

在处理 iframe 时，可以创建一个框架定位器，它将进入 iframe 并允许在该 iframe 中选择元素。

用法

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

Locator locator = page.frameLocator("#my-iframe").getByText("Submit");
locator.click();

参数

  • selector String#

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

返回值

frames​

在 v1.9 之前添加 page.frames

附加到页面的所有框架的数组。

用法

Page.frames();

返回值

getByAltText​

新增于：v1.27 page.getByAltText

允许通过元素的替代文本（alt text）定位元素。

用法

例如，此方法将通过替代文本 "Playwright logo" 找到图像：

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

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Page.GetByAltTextOptions（可选）

    • setExact 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">
page.getByLabel("Username").fill("john");
page.getByLabel("Password").fill("secret");

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Page.GetByLabelOptions（可选）

    • setExact boolean（可选）#

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

返回值

getByPlaceholder​

新增于：v1.27 page.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

你可以在通过占位符文本定位输入框后填充内容：

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

参数​

  • text String | Pattern#

    用于定位元素的文本。

  • options Page.GetByPlaceholderOptions（可选）

    • setExact boolean（可选）#

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

返回值​

getByRole​

新增于：v1.27 page.getByRole

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

用法​

考虑以下 DOM 结构。

<h3>注册</h3>
<label>
  <input type="checkbox" /> 订阅
</label>
<br/>
<button>提交</button>

你可以通过每个元素的隐式角色来定位它们：

assertThat(page
    .getByRole(AriaRole.HEADING,
               new Page.GetByRoleOptions().setName("注册")))
    .isVisible();

page.getByRole(AriaRole.CHECKBOX,
               new Page.GetByRoleOptions().setName("订阅"))
    .check();

page.getByRole(AriaRole.BUTTON,
               new Page.GetByRoleOptions().setName(
                   Pattern.compile("提交", Pattern.CASE_INSENSITIVE)))
    .click();

参数

  • role enum AriaRole { 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 Page.GetByRoleOptions（可选）

    • setChecked boolean（可选）#

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

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

    • setDisabled boolean（可选）#

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

      备注

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

    • setExact boolean（可选） 添加于：v1.28#

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

    • setExpanded boolean（可选）#

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

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

    • setIncludeHidden boolean（可选）#

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

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

    • setLevel int（可选）#

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

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

    • setName String | Pattern（可选）#

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

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

    • setPressed boolean（可选）#

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

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

    • setSelected 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 定位该元素：

page.getByTestId("directions").click();

参数

返回值

详细信息

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

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", new Page.GetByTextOptions().setExact(true));

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

// 匹配第二个 <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));

参数

  • text String | Pattern#

    用于定位元素的文本。

  • options Page.GetByTextOptions (可选)

    • setExact boolean (可选)#

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

返回值

详情​

即使是精确匹配，按文本匹配也总会对空白字符进行规范化处理。例如，将多个空格合并为一个，将换行符转换为空格，并忽略前导和尾随的空白字符。

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

getByTitle​

添加于：v1.27 page.getByTitle

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

用法​

考虑以下 DOM 结构。

<span title='问题数量'>25 个问题</span>

你可以在通过标题文本定位到元素后，检查问题数量：

assertThat(page.getByTitle("问题数量")).hasText("25 个问题");

参数​

  • text String | Pattern# 用于定位元素的文本。
  • options Page.GetByTitleOptions（可选）
    • setExact boolean（可选）# 是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时忽略此选项。请注意，精确匹配仍会修剪空白字符。

返回值​

goBack​

在 v1.9 之前添加 page.goBack

返回主资源响应。如果存在多个重定向，导航将使用最后一个重定向的响应来解析。如果无法返回上一页，则返回 null。

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

用法

Page.goBack();
Page.goBack(options);

参数​

  • options Page.GoBackOptions（可选）

    • setTimeout double（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT }（可选）#

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

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

返回值​

goForward​

在 v1.9 之前添加 page.goForward

返回主资源响应。如果存在多个重定向，导航将使用最后一个重定向的响应来解析。如果无法向前跳转，则返回 null。

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

用法

Page.goForward();
Page.goForward(options);

参数​

  • options Page.GoForwardOptions（可选）

    • setTimeout double（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT }（可选）#

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

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

返回值​

isClosed​

在 v1.9 之前添加 page.isClosed

表示页面已关闭。

用法

Page.isClosed();

返回值

locator​

添加于：v1.14 page.locator

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

详细了解定位器。

用法

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

参数

  • selector String#

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

  • options Page.LocatorOptions（可选）

    • setHas Locator（可选）#

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

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

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

    • setHasNot Locator（可选） 新增于：v1.33#

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

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

    • setHasNotText String | Pattern（可选） 新增于：v1.33#

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

    • setHasText String | Pattern（可选）#

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

返回值

mainFrame​

在 v1.9 之前添加 page.mainFrame

页面的主框架。可以确保页面有一个在导航过程中持续存在的主框架。

用法

Page.mainFrame();

返回值

navigate​

在 v1.9 之前添加 page.navigate

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

在以下情况下，该方法将抛出错误：

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

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

备注

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

备注

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

用法

Page.navigate(url);
Page.navigate(url, options);

参数

  • url String#

    要导航到的页面 URL。该 URL 应包含协议，例如 https://。如果通过上下文选项提供了 setBaseURL，并且传入的 URL 是一个路径，则会通过 new URL() 构造函数进行合并。

  • options Page.NavigateOptions（可选）

    • setReferer String（可选）#

      Referer 标头值。如果提供了该值，它将优先于通过 Page.setExtraHTTPHeaders() 设置的 Referer 标头值。

    • setTimeout double（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT }（可选）#

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

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

返回值

onceDialog​

新增于：v1.10 page.onceDialog

添加一次性的 Dialog 处理程序。在下一个 Dialog 创建后，该处理程序将立即被移除。

page.onceDialog(dialog -> {
  dialog.accept("foo");
});

// 打印 'foo'
System.out.println(page.evaluate("prompt('Enter string:')"));

// 打印 'null'，因为对话框将自动关闭，因为没有处理程序。
System.out.println(page.evaluate("prompt('Enter string:')"));

上述代码等同于：

Consumer<Dialog> handler = new Consumer<Dialog>() {
  @Override
  public void accept(Dialog dialog) {
    dialog.accept("foo");
    page.offDialog(this);
  }
};
page.onDialog(handler);

// 打印 'foo'
System.out.println(page.evaluate("prompt('Enter string:')"));

// 打印 'null'，因为对话框将自动关闭，因为没有处理程序。
System.out.println(page.evaluate("prompt('Enter string:')"));

用法

Page.onceDialog(handler);

参数

opener​

在 v1.9 之前添加 page.opener

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

用法

Page.opener();

返回值

pause​

添加于：v1.9 page.pause

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

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

备注

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

用法

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。
page.emulateMedia(new Page.EmulateMediaOptions().setMedia(Media.SCREEN));
page.pdf(new Page.PdfOptions().setPath(Paths.get("page.pdf")));

setWidth、setHeight 和 setMargin 选项接受带单位的值。无单位的值将被视为像素。

几个示例：

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

所有可能的单位有：

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

setFormat 选项有：

  • 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 英寸

:::注意

setHeaderTemplate 和 setFooterTemplate 标记有以下限制：> 1. 模板内的脚本标签不会被求值。> 2. 模板内无法看到页面样式。 :::

参数

  • options Page.PdfOptions（可选）

    • setDisplayHeaderFooter boolean（可选）#

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

    • setFooterTemplate String（可选）#

      打印页脚的 HTML 模板。格式应与 setHeaderTemplate 相同。

    • setFormat String（可选）#

      纸张格式。如果设置了此选项，则优先于 setWidth 或 setHeight 选项。默认为 “Letter”。

    • setHeaderTemplate String（可选）#

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

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

    • setHeight String（可选）#

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

    • setLandscape boolean（可选）#

      纸张方向。默认为 false。

    • setMargin Margin（可选）#

      • setTop String（可选）

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

      • setRight String（可选）

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

      • setBottom String（可选）

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

      • setLeft String（可选）

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

      纸张边距，默认为无。

    • setOutline boolean（可选） 新增于：v1.42#

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

    • setPageRanges String（可选）#

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

    • setPath Path（可选）#

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

    • setPreferCSSPageSize boolean（可选）#

      使页面中声明的任何 CSS @page 尺寸优先于 setWidth 和 setHeight 或 setFormat 选项中声明的尺寸。默认为 false，这将缩放内容以适应纸张大小。

    • setPrintBackground boolean（可选）#

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

    • setScale double（可选）#

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

    • setTagged boolean（可选） 新增于：v1.42#

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

    • setWidth String（可选）#

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

返回值

  • [byte[]]#

reload​

在 v1.9 之前添加 page.reload

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

用法

Page.reload();
Page.reload(options);

参数​

  • options Page.ReloadOptions（可选）

    • setTimeout double（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT }（可选）#

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

      • 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，视为操作完成。
      • 'load' - 当触发 load 事件时，视为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。不要在测试中使用此方法，应依靠 Web 断言来评估就绪状态。
      • 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值​

removeLocatorHandler​

新增于：v1.44 page.removeLocatorHandler

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

用法

Page.removeLocatorHandler(locator);

参数

返回值

requestGC​

新增于：v1.48 page.requestGC

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

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

// 1. 在页面中，为“suspect”保存一个 WeakRef。
page.evaluate("globalThis.suspectWeakRef = new WeakRef(suspect)");
// 2. 请求垃圾回收。
page.requestGC();
// 3. 检查弱引用是否未解除对原始对象的引用。
assertTrue(page.evaluate("!globalThis.suspectWeakRef.deref()"));

用法

Page.requestGC();

返回值

route​

在 v1.9 之前添加 page.route

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

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

备注

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

备注

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

备注

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

用法​

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

Page page = browser.newPage();
page.route("**/*.{png,jpg,jpeg}", route -> route.abort());
page.navigate("https://example.com");
browser.close();

或者使用正则表达式模式实现相同功能的代码片段：

Page page = browser.newPage();
page.route(Pattern.compile("(\\.png$)|(\\.jpg$)"),route -> route.abort());
page.navigate("https://example.com");
browser.close();

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

page.route("/api/**", route -> {
  if (route.request().postData().contains("my-string"))
    route.fulfill(new Route.FulfillOptions().setBody("mocked-data"));
  else
    route.resume();
});

当请求同时匹配页面路由和浏览器上下文路由（通过 BrowserContext.route() 设置）的处理程序时，页面路由优先。

要移除路由及其处理程序，可以使用 Page.unroute()。

备注

启用路由会禁用 HTTP 缓存。

参数

  • url String | Pattern | Predicate<String>#

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

  • handler Consumer<Route>#

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

  • options Page.RouteOptions（可选）

    • setTimes int（可选） 新增于：v1.15#

      路由应使用的次数。默认情况下，每次都会使用。

返回值

routeFromHAR​

添加于：v1.23 page.routeFromHAR

如果指定了此方法，页面中发起的网络请求将从 HAR 文件提供服务。详细了解 从 HAR 重放。

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

用法

Page.routeFromHAR(har);
Page.routeFromHAR(har, options);

参数

  • har Path#

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

  • options Page.RouteFromHAROptions（可选）

    • setNotFound enum HarNotFound { ABORT, FALLBACK }（可选）#

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

      默认值为 abort。

    • setUpdate boolean（可选）#

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

    • setUpdateContent enum RouteFromHarUpdateContentPolicy { EMBED, ATTACH }（可选） 新增于：v1.32#

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

    • setUpdateMode enum HarMode { FULL, MINIMAL }（可选） 新增于：v1.32#

      设置为 minimal 时，仅记录从 HAR 进行路由所需的信息。这将省略大小、时间、页面、cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时不会使用。默认值为 minimal。

    • setUrl String | Pattern（可选）#

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

返回值

routeWebSocket​

新增于：v1.48 page.routeWebSocket

此方法允许修改页面发起的 WebSocket 连接。

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

用法

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

page.routeWebSocket("/ws", ws -> {
  ws.onMessage(frame -> {
    if ("request".equals(frame.text()))
      ws.send("response");
  });
});

参数

返回值

screenshot​

在 v1.9 之前添加 page.screenshot

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

用法

Page.screenshot();
Page.screenshot(options);

参数

  • options Page.ScreenshotOptions （可选）

    • setAnimations enum ScreenshotAnimations { DISABLED, ALLOW } （可选）#

      设置为 "disabled" 时，将停止 CSS 动画、CSS 过渡和 Web 动画。动画会根据其持续时间得到不同处理：

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

      默认值为 "allow"，即不触动动画。

    • setCaret enum ScreenshotCaret { HIDE, INITIAL } （可选）#

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

    • setClip Clip （可选）#

      • setX double

        裁剪区域左上角的 x 坐标

      • setY double

        裁剪区域左上角的 y 坐标

      • setWidth double

        裁剪区域的宽度

      • setHeight double

        裁剪区域的高度

      一个指定生成图像裁剪的对象。

    • setFullPage boolean （可选）#

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

    • setMask List<Locator> （可选）#

      指定在截取屏幕截图时应进行遮罩的定位器。被遮罩的元素将覆盖一个粉色框 #FF00FF（可通过 setMaskColor 自定义），该框将完全覆盖其边框。遮罩也应用于不可见元素，有关禁用此功能的信息，请参阅 仅匹配可见元素。

    • setMaskColor String （可选） 新增于：v1.35#

      以 CSS 颜色格式指定被遮罩元素覆盖框的颜色。默认颜色为粉色 #FF00FF。

    • setOmitBackground boolean （可选）#

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

    • setPath Path （可选）#

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

    • setQuality int （可选）#

      图像质量，取值范围为 0 到 100。不适用于 png 图像。

    • setScale enum ScreenshotScale { CSS, DEVICE } （可选）#

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

      默认值为 "device"。

    • setStyle String （可选） 新增于：v1.41#

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

    • setTimeout double （可选）#

      最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setType enum ScreenshotType { PNG, JPEG } （可选）#

      指定屏幕截图类型，默认值为 png。

返回值

  • [byte[]]#

setContent​

在 v1.9 之前添加 page.setContent

此方法在内部调用 document.write()，继承其所有特定特征和行为。

用法

Page.setContent(html);
Page.setContent(html, options);

参数

  • html String#

    要分配给页面的 HTML 标记。

  • options Page.SetContentOptions（可选）

    • setTimeout double（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setWaitUntil enum WaitUntilState { 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 double#

    最大导航时间（毫秒）

setDefaultTimeout​

在 v1.9 之前添加 page.setDefaultTimeout

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

备注

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

用法

Page.setDefaultTimeout(timeout);

参数

  • timeout double#

    最长时间（毫秒）。传入 0 以禁用超时。

setExtraHTTPHeaders​

在 v1.9 之前添加 page.setExtraHTTPHeaders

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

备注

Page.setExtraHTTPHeaders() 不能保证传出请求中头信息的顺序。

用法

Page.setExtraHTTPHeaders(headers);

参数

  • headers Map<String, String>#

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

返回

setViewportSize​

在 v1.9 之前添加 page.setViewportSize

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

Page.setViewportSize() 会调整页面大小。许多网站并不期望手机改变尺寸，因此你应该在导航到页面之前设置视口大小。Page.setViewportSize() 还会重置 screen 尺寸，如果你需要更好地控制这些属性，可以使用带有 screen 和 viewport 参数的 Browser.newContext()。

用法

Page page = browser.newPage();
page.setViewportSize(640, 480);
page.navigate("https://example.com");

参数

  • width int 在 v1.10 中添加#

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

  • height int 在 v1.10 中添加#

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

返回值

title​

在 v1.9 之前添加 page.title

返回页面的标题。

用法

Page.title();

返回值

unroute​

在 v1.9 之前添加 page.unroute

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

用法

Page.unroute(url);
Page.unroute(url, handler);

参数

  • url String | Pattern | Predicate<String>#

    一个全局模式、正则表达式模式或接收 [URL] 的谓词，用于在路由时进行匹配。

  • handler Consumer<Route> (可选)#

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

返回值

unrouteAll​

添加于：v1.41 page.unrouteAll

移除使用 Page.route() 和 Page.routeFromHAR() 创建的所有路由。

用法

Page.unrouteAll();

返回值

url​

在 v1.9 之前添加 page.url

用法

Page.url();

返回值

video​

在 v1.9 之前添加 page.video

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

用法

Page.video();

返回值

viewportSize​

在 v1.9 之前添加 page.viewportSize

用法

Page.viewportSize();

返回值

  • null | ViewportSize#

    • width int

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

    • height int

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

waitForClose​

添加于：v1.11 page.waitForClose

执行操作并等待页面关闭。

用法

Page.waitForClose(callback);
Page.waitForClose(callback, options);

参数

  • options Page.WaitForCloseOptions（可选）

  • callback Runnable 新增于：v1.9#

    执行触发事件操作的回调函数。

返回值

waitForCondition​

新增于：v1.32 page.waitForCondition

该方法将阻塞，直到条件返回 true。在方法等待条件时，所有 Playwright 事件都将被派发。

用法

使用该方法等待依赖于页面事件的条件：

List<String> messages = new ArrayList<>();
page.onConsoleMessage(m -> messages.add(m.text()));
page.getByText("Submit button").click();
page.waitForCondition(() -> messages.size() > 3);

参数

返回值

waitForConsoleMessage​

新增于：v1.9 page.waitForConsoleMessage

执行操作并等待页面记录 ConsoleMessage。如果提供了断言函数，则会将 ConsoleMessage 值传入 predicate 函数，并等待 predicate(message) 返回真值。如果在触发 Page.onConsoleMessage(handler) 事件之前页面关闭，则会抛出错误。

用法

Page.waitForConsoleMessage(callback);
Page.waitForConsoleMessage(callback, options);

参数

返回值

waitForDownload​

新增于：v1.9 page.waitForDownload

执行操作并等待新的 Download。如果提供了断言函数，它会将 Download 值传入 predicate 函数，并等待 predicate(download) 返回真值。如果在下载事件触发前页面关闭，将抛出错误。

用法

Page.waitForDownload(callback);
Page.waitForDownload(callback, options);

参数

  • options Page.WaitForDownloadOptions（可选）

  • callback Runnable#

    执行触发该事件操作的回调函数。

返回值

waitForFileChooser​

新增于：v1.9 page.waitForFileChooser

执行操作并等待创建新的 FileChooser。如果提供了谓词，它会将 FileChooser 值传递给 predicate 函数，并等待 predicate(fileChooser) 返回真值。如果在文件选择器打开之前页面关闭，将抛出错误。

用法

Page.waitForFileChooser(callback);
Page.waitForFileChooser(callback, options);

参数

  • options Page.WaitForFileChooserOptions（可选）

  • callback Runnable#

    执行触发该事件操作的回调函数。

返回值

waitForFunction​

在 v1.9 之前添加 page.waitForFunction

当 expression 返回真值时返回。它解析为真值的 JSHandle。

用法

Page.waitForFunction() 可用于观察视口大小变化：

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch();
      Page page = browser.newPage();
      page.setViewportSize(50,  50);
      page.waitForFunction("() => window.innerWidth < 100");
      browser.close();
    }
  }
}

要将参数传递给 Page.waitForFunction() 函数的断言：

String selector = ".foo";
page.waitForFunction("selector => !!document.querySelector(selector)", selector);

参数

  • expression String#

    要在浏览器上下文中求值的 JavaScript 表达式。如果表达式求值为一个函数，则会自动调用该函数。

  • arg EvaluationArgument（可选）#

    传递给 expression 的可选参数。

  • options Page.WaitForFunctionOptions（可选）

    • setPollingInterval double（可选）#

      如果指定，则将其视为函数执行的时间间隔（以毫秒为单位）。默认情况下，如果未指定该选项，expression 将在 requestAnimationFrame 回调中执行。

    • setTimeout double（可选）#

      最大等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

返回值

waitForLoadState​

在 v1.9 之前添加 page.waitForLoadState

当达到所需的加载状态时返回。

当页面达到所需的加载状态（默认为 load）时，此操作将得到解决。调用此方法时，导航必须已经提交。如果当前文档已经达到所需状态，则立即解决。

备注

大多数情况下，不需要此方法，因为 Playwright 在每次操作前自动等待。

用法

page.getByRole(AriaRole.BUTTON).click(); // 点击触发导航。
page.waitForLoadState(); // 此 Promise 在 "load" 事件后得到解决。
Page popup = page.waitForPopup(() -> {
  page.getByRole(AriaRole.BUTTON).click(); // 点击触发弹出窗口。
});
// 等待 "DOMContentLoaded" 事件
popup.waitForLoadState(LoadState.DOMCONTENTLOADED);
System.out.println(popup.title()); // 弹出窗口已准备好使用。

参数​

  • state enum LoadState { LOAD, DOMCONTENTLOADED, NETWORKIDLE }（可选）#

    等待的可选加载状态，默认为 load。如果在加载当前文档时已经达到该状态，此方法将立即解析。可以是以下值之一：

    • 'load' - 等待触发 load 事件。
    • 'domcontentloaded' - 等待触发 DOMContentLoaded 事件。
    • 'networkidle' - 不推荐 等待至少 500 毫秒内没有网络连接。不要在测试中使用此方法，应依靠 Web 断言来评估是否准备就绪。

  • options Page.WaitForLoadStateOptions（可选）

返回值​

waitForPopup​

新增于：v1.9 page.waitForPopup

执行操作并等待弹出的 Page。如果提供了断言函数 predicate，它会将 [Popup] 值传入 predicate 函数，并等待 predicate(page) 返回真值。如果在弹出事件触发之前页面关闭，则会抛出错误。

用法

Page.waitForPopup(callback);
Page.waitForPopup(callback, options);

参数

  • options Page.WaitForPopupOptions（可选）

    • setPredicate Predicate<Page>（可选）#

      接收 Page 对象，当等待条件满足时解析为真值。

    • setTimeout double（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 更改。

  • callback Runnable#

    执行触发事件操作的回调函数。

返回值

waitForRequest​

在 v1.9 之前添加 page.waitForRequest

等待匹配的请求并返回它。有关事件的更多详细信息，请参阅等待事件。

用法

// 等待具有指定 URL 的下一个请求
Request request = page.waitForRequest("https://example.com/resource", () -> {
  // 触发请求
  page.getByText("trigger request").click();
});

// 等待下一个符合某些条件的请求
Request request = page.waitForRequest(request -> "https://example.com".equals(request.url()) && "GET".equals(request.method()), () -> {
  // 触发请求
  page.getByText("trigger request").click();
});

参数

  • urlOrPredicate String | Pattern | Predicate<Request>#

    请求 URL 字符串、正则表达式或接收 Request 对象的断言。如果通过上下文选项提供了 setBaseURL，并且传入的 URL 是一个路径，则会通过 new URL() 构造函数进行合并。

  • options Page.WaitForRequestOptions（可选）

    • setTimeout double（可选）#

      最大等待时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 Page.setDefaultTimeout() 方法更改。

  • callback Runnable 新增于：v1.9#

    执行触发事件操作的回调。

返回值

waitForRequestFinished​

新增于：v1.12 page.waitForRequestFinished

执行操作并等待 Request 完成加载。如果提供了断言函数 predicate，它会将 Request 值传入 predicate 函数，并等待 predicate(request) 返回真值。如果在触发 Page.onRequestFinished(handler) 事件之前页面关闭，将会抛出错误。

用法

Page.waitForRequestFinished(callback);
Page.waitForRequestFinished(callback, options);

参数

  • options Page.WaitForRequestFinishedOptions (可选)

  • callback Runnable#

    执行触发事件操作的回调函数。

返回值

waitForResponse​

在 v1.9 之前添加 page.waitForResponse

返回匹配的响应。有关事件的更多详细信息，请参阅等待事件。

用法

// 等待具有指定 URL 的下一个响应
Response response = page.waitForResponse("https://example.com/resource", () -> {
  // 触发响应
  page.getByText("trigger response").click();
});

// 等待匹配某些条件的下一个响应
Response response = page.waitForResponse(response -> "https://example.com".equals(response.url()) && response.status() == 200 && "GET".equals(response.request().method()), () -> {
  // 触发响应
  page.getByText("trigger response").click();
});

参数

返回值

waitForURL​

新增于：v1.11 page.waitForURL

等待主框架导航到给定的 URL。

用法

page.click("a.delayed-navigation"); // 点击链接将间接导致导航
page.waitForURL("**/target.html");

参数​

  • url String | Pattern | Predicate<String>#

    一个通配符模式、正则表达式模式或接收 [URL] 的断言，用于在等待导航时进行匹配。请注意，如果参数是一个没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 URL。

  • options Page.WaitForURLOptions（可选）

    • setTimeout double（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT }（可选）#

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

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

返回值

waitForWebSocket​

新增于：v1.9 page.waitForWebSocket

执行操作并等待新的 WebSocket。如果提供了断言函数 predicate，它会将 WebSocket 值传入 predicate 函数，并等待 predicate(webSocket) 返回真值。如果在 WebSocket 事件触发之前页面关闭，将会抛出错误。

用法

Page.waitForWebSocket(callback);
Page.waitForWebSocket(callback, options);

参数

  • options Page.WaitForWebSocketOptions （可选）

  • callback Runnable#

    执行触发事件操作的回调函数。

返回值

waitForWorker​

新增于：v1.9 page.waitForWorker

执行操作并等待新的 Worker。如果提供了断言函数 predicate，它会将 Worker 值传入 predicate 函数，并等待 predicate(worker) 返回真值。如果在触发 worker 事件之前页面关闭，将会抛出错误。

用法

Page.waitForWorker(callback);
Page.waitForWorker(callback, options);

参数

  • options Page.WaitForWorkerOptions （可选）

  • callback Runnable#

    执行触发事件操作的回调函数。

返回值

workers​

在 v1.9 之前添加 page.workers

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

备注

这不包含 ServiceWorkers。

用法

Page.workers();

返回值

属性​

clock()​

添加于：v1.45 page.clock()

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

用法

Page.clock()

返回值

keyboard()​

在 v1.9 之前添加 page.keyboard()

用法

Page.keyboard()

返回值

mouse()​

在 v1.9 之前添加 page.mouse()

用法

Page.mouse()

返回值

request()​

添加于：v1.16 page.request()

与此页面关联的 API 测试辅助工具。此方法返回与页面上下文上的 BrowserContext.request() 相同的实例。更多详细信息，请参阅 BrowserContext.request()。

用法

Page.request()

返回值

touchscreen()​

在 v1.9 之前添加 page.touchscreen()

用法

Page.touchscreen()

返回值

事件​

onClose(handler)​

在 v1.9 之前添加 page.onClose(handler)

在页面关闭时触发。

用法

Page.onClose(handler)

事件数据

onConsoleMessage(handler)​

在 v1.9 之前添加 page.onConsoleMessage(handler)

当页面内的 JavaScript 调用 console API 方法（例如 console.log 或 console.dir）时触发。

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

用法

page.onConsoleMessage(msg -> {
  for (int i = 0; i < msg.args().size(); ++i)
    System.out.println(i + ": " + msg.args().get(i).jsonValue());
});
page.evaluate("() => console.log('hello', 5, { foo: 'bar' })");

事件数据

onCrash(handler)​

在 v1.9 之前添加 page.onCrash(handler)

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

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

try {
  // 点击过程中可能会崩溃。
  page.click("button");
  // 或者在等待事件时。
  page.waitForPopup(() -> {});
} catch (PlaywrightException e) {
  // 页面崩溃时，异常消息中会包含 "crash"。
}

用法

Page.onCrash(handler)

事件数据

onDialog(handler)​

在 v1.9 之前添加 page.onDialog(handler)

当出现 JavaScript 对话框（如 alert、prompt、confirm 或 beforeunload）时触发此事件。监听器 必须 调用 Dialog.accept() 或 Dialog.dismiss() 来处理对话框，否则页面将 冻结 等待对话框处理，诸如点击等操作将永远不会完成。

用法

page.onDialog(dialog -> {
  dialog.accept();
});
备注

当不存在 Page.onDialog(handler) 或 BrowserContext.onDialog(handler) 监听器时，所有对话框将自动被取消。

事件数据

onDOMContentLoaded(handler)​

添加于：v1.9 page.onDOMContentLoaded(handler)

当 JavaScript 的 DOMContentLoaded 事件被派发时触发此事件。

用法

Page.onDOMContentLoaded(handler)

事件数据

onDownload(handler)​

在 v1.9 之前添加 page.onDownload(handler)

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

用法

Page.onDownload(handler)

事件数据

onFileChooser(handler)​

新增于：v1.9 page.onFileChooser(handler)

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

page.onFileChooser(fileChooser -> {
  fileChooser.setFiles(Paths.get("/tmp/myfile.pdf"));
});

用法

Page.onFileChooser(handler)

事件数据

onFrameAttached(handler)​

新增于：v1.9 page.onFrameAttached(handler)

当一个框架附加时触发。

用法

Page.onFrameAttached(handler)

事件数据

onFrameDetached(handler)​

新增于：v1.9 page.onFrameDetached(handler)

当一个框架分离时触发。

用法

Page.onFrameDetached(handler)

事件数据

onFrameNavigated(handler)​

新增于：v1.9 page.onFrameNavigated(handler)

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

用法

Page.onFrameNavigated(handler)

事件数据

onLoad(handler)​

在 v1.9 之前新增 page.onLoad(handler)

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

用法

Page.onLoad(handler)

事件数据

onPageError(handler)​

新增于：v1.9 page.onPageError(handler)

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

// 将所有未捕获的错误记录到终端
page.onPageError(exception -> {
  System.out.println("未捕获的异常: " + exception);
});

// 导航到一个会抛出异常的页面。
page.navigate("data:text/html,<script>throw new Error('Test')</script>");

用法

Page.onPageError(handler)

事件数据

  • [字符串]

onPopup(handler)​

在 v1.9 之前添加 page.onPopup(handler)

当页面打开新标签页或窗口时触发此事件。除了 BrowserContext.onPage(handler) 之外，也会触发此事件，但仅针对与该页面相关的弹出窗口。

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

Page popup = page.waitForPopup(() -> {
  page.getByText("open the popup").click();
});
System.out.println(popup.evaluate("location.href"));
备注

使用 Page.waitForLoadState() 等待页面进入特定状态（大多数情况下你可能不需要它）。

用法

Page.onPopup(handler)

事件数据

onRequest(handler)​

在 v1.9 之前添加 page.onRequest(handler)

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

用法

Page.onRequest(handler)

事件数据

onRequestFailed(handler)​

添加于：v1.9 page.onRequestFailed(handler)

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

page.onRequestFailed(request -> {
  System.out.println(request.url() + " " + request.failure());
});
备注

从 HTTP 的角度来看，HTTP 错误响应（例如 404 或 503）仍然是成功的响应，因此请求将通过 Page.onRequestFinished(handler) 事件完成，而不是通过 Page.onRequestFailed(handler) 事件。只有当客户端无法从服务器获取 HTTP 响应时（例如由于网络错误 net::ERR_FAILED），请求才会被视为失败。

用法

Page.onRequestFailed(handler)

事件数据

onRequestFinished(handler)​

添加于：v1.9 page.onRequestFinished(handler)

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

用法

Page.onRequestFinished(handler)

事件数据

onResponse(handler)​

在 v1.9 之前添加 page.onResponse(handler)

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

用法

Page.onResponse(handler)

事件数据

onWebSocket(handler)​

添加于：v1.9 page.onWebSocket(handler)

当发送WebSocket请求时触发。

用法

Page.onWebSocket(handler)

事件数据

onWorker(handler)​

在 v1.9 之前添加 page.onWorker(handler)

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

用法

Page.onWorker(handler)

事件数据

已弃用​

check​

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

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

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

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

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

用法

Page.check(selector);
Page.check(selector, options);

参数

  • selector String#

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

  • options Page.CheckOptions (可选)

    • setForce boolean (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选) 新增于：v1.11#

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

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

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setTrial boolean (可选) 新增于：v1.11#

      设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作但不实际执行操作很有用。

返回值

click​

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

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

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

  1. 查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
  2. 除非设置了 setForce 选项，否则等待对匹配元素进行 可操作性 检查。如果在检查过程中元素被分离，则整个操作将重试。
  3. 如有需要，将元素滚动到可见区域。
  4. 使用 Page.mouse() 在元素中心或指定的 setPosition 处点击。
  5. 除非设置了 setNoWaitAfter 选项，否则等待发起的导航成功或失败。

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

用法

Page.click(selector);
Page.click(selector, options);

参数

  • selector String#

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

  • options Page.ClickOptions (可选)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (可选)#

      默认值为 left。

    • setClickCount int (可选)#

      默认值为 1。参见 UIEvent.detail。

    • setDelay double (可选)#

      mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。

    • setForce boolean (可选)#

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

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

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

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

    • setPosition Position (可选)#

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

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

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setTrial boolean (可选) 新增于：v1.11#

      设置后，此方法仅执行 可操作性 检查并跳过操作。默认值为 false。这对于等待元素准备好进行操作但不执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

dblclick​

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

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

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

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

如果在指定的 setTimeout 时间内，所有步骤未能全部完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

备注

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

用法

Page.dblclick(selector);
Page.dblclick(selector, options);

参数

  • selector String#

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

  • options Page.DblclickOptions (可选)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (可选)#

      默认值为 left。

    • setDelay double (可选)#

      mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。

    • setForce boolean (可选)#

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

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

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

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

    • setTrial boolean (可选) 新增于：v1.11#

      设置此参数时，此方法仅执行可操作性检查并跳过操作。默认值为 false。这对于等待元素准备好执行操作但不实际执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

dispatchEvent​

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

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

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

用法

page.dispatchEvent("button#submit", "click");

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

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

如果你希望将实时对象传入事件，也可以将 JSHandle 指定为属性值：

// 注意，你只能在 Chromium 和 Firefox 中创建 DataTransfer
JSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
page.dispatchEvent("#source", "dragstart", arg);

参数

  • selector String#

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

  • type String#

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

  • eventInit EvaluationArgument（可选）#

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

  • options Page.DispatchEventOptions（可选）

    • setStrict boolean（可选） 新增于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

evalOnSelector​

新增于：v1.9 page.evalOnSelector
不推荐使用

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

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

如果 expression 返回一个 Promise，那么 Page.evalOnSelector() 将等待该 Promise 解决并返回其值。

用法

String searchValue = (String) page.evalOnSelector("#search", "el => el.value");
String preloadHref = (String) page.evalOnSelector("link[rel=preload]", "el => el.href");
String html = (String) page.evalOnSelector(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");

参数

  • selector String#

    要查询的选择器。

  • expression String#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则该函数将自动调用。

  • arg EvaluationArgument（可选）#

    传递给 expression 的可选参数。

  • options Page.EvalOnSelectorOptions（可选）

    • setStrict boolean（可选） 新增于：v1.14#

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

返回值

evalOnSelectorAll​

添加于：v1.9 page.evalOnSelectorAll
不推荐使用

在大多数情况下，Locator.evaluateAll()、其他 Locator 辅助方法以及以网页为优先的断言能更好地完成任务。

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

如果 expression 返回一个 Promise，那么 Page.evalOnSelectorAll() 将等待该 Promise 解决，并返回其值。

用法

boolean divCounts = (boolean) page.evalOnSelectorAll("div", "(divs, min) => divs.length >= min", 10);

参数

  • selector String#

    要查询的选择器。

  • expression String#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则该函数会自动调用。

  • arg EvaluationArgument（可选）#

    传递给 expression 的可选参数。

返回值

fill​

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

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

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

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

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

用法

Page.fill(selector, value);
Page.fill(selector, value, options);

参数

  • selector String#

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

  • value String#

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

  • options Page.FillOptions（可选）

    • setForce boolean（可选） 新增于：v1.13#

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

    • setNoWaitAfter boolean（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setStrict boolean（可选） 新增于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

focus​

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

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

此方法使用 selector 获取一个元素并将焦点置于其上。如果没有与 selector 匹配的元素，该方法将等待，直到 DOM 中出现匹配的元素。

用法

Page.focus(selector);
Page.focus(selector, options);

参数

  • selector String#

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

  • options Page.FocusOptions（可选）

    • setStrict boolean（可选） 新增于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

getAttribute​

在 v1.9 之前新增 page.getAttribute
不推荐使用

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

返回元素属性值。

用法

Page.getAttribute(selector, name);
Page.getAttribute(selector, name, options);

参数​

  • selector String# 用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。
  • name String# 要获取其值的属性名称。
  • options Page.GetAttributeOptions（可选）
    • setStrict boolean（可选） 新增于：v1.14# 为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
    • setTimeout double（可选）# 最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值​

hover​

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

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

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

  1. 查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
  2. 除非设置了 setForce 选项，否则等待对匹配元素进行 可操作性 检查。如果在检查过程中元素被分离，则会重试整个操作。
  3. 如有需要，将元素滚动到可见区域。
  4. 使用 Page.mouse() 将鼠标悬停在元素中心，或指定的 setPosition 位置。

如果在指定的 setTimeout 时间内，所有步骤未能全部完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

用法

Page.hover(selector);
Page.hover(selector, options);

参数

  • selector String#

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

  • options Page.HoverOptions（可选）

    • setForce boolean（可选）#

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

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }>（可选）#

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

    • setNoWaitAfter boolean（可选） 新增于：v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position（可选）#

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

    • setStrict boolean（可选） 新增于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setTrial boolean（可选） 新增于：v1.11#

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

返回值

innerHTML​

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

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

返回 element.innerHTML。

用法

Page.innerHTML(selector);
Page.innerHTML(selector, options);

参数

  • selector String#

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

  • options Page.InnerHTMLOptions（可选）

    • setStrict boolean（可选）在 v1.14 中添加#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

innerText​

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

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

返回 element.innerText。

用法

Page.innerText(selector);
Page.innerText(selector, options);

参数

  • selector String#

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

  • options Page.InnerTextOptions（可选）

    • setStrict boolean（可选）在 v1.14 中添加#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

inputValue​

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

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

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

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

用法

Page.inputValue(selector);
Page.inputValue(selector, options);

参数

  • selector String#

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

  • options Page.InputValueOptions（可选）

    • setStrict boolean（可选） 新增于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

isChecked​

在 v1.9 之前新增 page.isChecked
不推荐使用

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

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

使用方法​

Page.isChecked(selector);
Page.isChecked(selector, options);

参数​

  • selector String#

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

  • options Page.IsCheckedOptions（可选）

    • setStrict boolean（可选） 新增于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值​

isDisabled​

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

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

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

用法

Page.isDisabled(selector);
Page.isDisabled(selector, options);

参数

  • selector String#

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

  • options Page.IsDisabledOptions (可选)

    • setStrict boolean (可选) 在 v1.14 中添加#

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

isEditable​

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

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

返回元素是否可编辑（editable）。

用法

Page.isEditable(selector);
Page.isEditable(selector, options);

参数

  • selector String#

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

  • options Page.IsEditableOptions（可选）

    • setStrict boolean（可选）在 v1.14 中添加#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

isEnabled​

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

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

返回元素是否启用。

用法

Page.isEnabled(selector);
Page.isEnabled(selector, options);

参数

  • selector String#

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

  • options Page.IsEnabledOptions (可选)

    • setStrict boolean (可选) 在 v1.14 中添加#

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

isHidden​

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

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

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

用法

Page.isHidden(selector);
Page.isHidden(selector, options);

参数

  • selector String#

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

  • options Page.IsHiddenOptions (可选)

    • setStrict boolean (可选) 在 v1.14 中添加#

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

    • setTimeout double (可选)#

      已弃用

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

返回值

isVisible​

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

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

返回元素是否 可见。selector 若未匹配到任何元素，则视为不可见。

用法

Page.isVisible(selector);
Page.isVisible(selector, options);

参数

  • selector String

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

  • options Page.IsVisibleOptions（可选）

    • setStrict boolean（可选）添加于：v1.14

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

    • setTimeout double（可选）

      已弃用

      此选项将被忽略。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" 之类的快捷键。当与修饰键一起指定时，按下后续键时，修饰键将被按下并保持按下状态。

用法

Page page = browser.newPage();
page.navigate("https://keycode.info");
page.press("body", "A");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("A.png")));
page.press("body", "ArrowLeft");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("ArrowLeft.png" )));
page.press("body", "Shift+O");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("O.png" )));

参数

  • selector String#

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

  • key String#

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

  • options Page.PressOptions (可选)

    • setDelay double (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

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

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

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

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

querySelector​

新增于：v1.9 page.querySelector
不推荐使用

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

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

用法

Page.querySelector(selector);
Page.querySelector(selector, options);

参数

  • selector String#

    要查询的选择器。

  • options Page.QuerySelectorOptions（可选）

    • setStrict boolean（可选）新增于：v1.14#

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

返回值

querySelectorAll​

添加于：v1.9 page.querySelectorAll
不推荐使用

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

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

用法

Page.querySelectorAll(selector);

参数

  • selector String#

    要查询的选择器。

返回值

selectOption​

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

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

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

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

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

一旦所有提供的选项都被选中，就会触发 change 和 input 事件。

用法

// 匹配值或标签的单选
page.selectOption("select#colors", "blue");
// 匹配值和标签两者的单选
page.selectOption("select#colors", new SelectOption().setLabel("Blue"));
// 多选
page.selectOption("select#colors", new String[] {"red", "green", "blue"});

参数

  • selector String#

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

  • values null | String | ElementHandle | String[] | SelectOption | ElementHandle[] | SelectOption[]#

    • setValue String (可选)

      通过 option.value 进行匹配。可选。

    • setLabel String (可选)

      通过 option.label 进行匹配。可选。

    • setIndex int (可选)

      通过索引进行匹配。可选。

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

  • options Page.SelectOptionOptions (可选)

    • setForce boolean (可选) 新增于：v1.13#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

setChecked​

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

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

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

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

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

用法

Page.setChecked(selector, checked);
Page.setChecked(selector, checked, options);

参数

  • selector [字符串]#

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

  • checked [布尔值]#

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

  • options Page.SetCheckedOptions（可选）

    • setForce [布尔值]（可选）#

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

    • setNoWaitAfter [布尔值]（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position（可选）#

      • setX [双精度浮点数]

      • setY [双精度浮点数]

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

    • setStrict [布尔值]（可选）#

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

    • setTimeout [双精度浮点数]（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setTrial [布尔值]（可选）#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作很有用。

返回值

setInputFiles​

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

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

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

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

用法

Page.setInputFiles(selector, files);
Page.setInputFiles(selector, files, options);

参数

  • selector String#

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

  • files Path | Path | FilePayload | FilePayload[]#

    • setName String

      文件名

    • setMimeType String

      文件类型

    • setBuffer [byte[]]

      文件内容

  • options Page.SetInputFilesOptions (可选)

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

tap​

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

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

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

  1. 查找与 selector 匹配的元素。如果没有，则等待直到有匹配的元素附加到 DOM 中。
  2. 等待对匹配元素的 可操作性 检查，除非设置了 setForce 选项。如果在检查过程中元素被分离，则整个操作将重试。
  3. 如有需要，将元素滚动到可见区域。
  4. 使用 Page.touchscreen() 点击元素的中心，或指定的 setPosition。

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

备注

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

用法

Page.tap(selector);
Page.tap(selector, options);

参数

  • selector String#

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

  • options Page.TapOptions (可选)

    • setForce boolean (可选)#

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

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)#

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

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

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

    • setTimeout double (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setTrial boolean (可选) 新增于：v1.11#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作但不执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

textContent​

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

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

返回 element.textContent。

用法

Page.textContent(selector);
Page.textContent(selector, options);

参数

  • selector String#

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

  • options Page.TextContentOptions（可选）

    • setStrict boolean（可选）添加于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 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 Page.TypeOptions（可选）

    • setDelay double（可选）#

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

    • setNoWaitAfter boolean（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setStrict boolean（可选） 新增于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

uncheck​

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

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

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

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

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

用法

Page.uncheck(selector);
Page.uncheck(selector, options);

参数

  • selector String#

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

  • options Page.UncheckOptions（可选）

    • setForce boolean（可选）#

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

    • setNoWaitAfter boolean（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position（可选） 添加于：v1.11#

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

    • setStrict boolean（可选） 添加于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setTrial boolean（可选） 添加于：v1.11#

      设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作很有用。

返回值

waitForNavigation​

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

此方法本质上存在竞争问题，请改用 Page.waitForURL()。

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

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

// 该方法在导航完成后返回
Response response = page.waitForNavigation(() -> {
  // 此操作在超时后触发导航。
  page.getByText("Navigate after timeout").click();
});
备注

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

参数

  • options Page.WaitForNavigationOptions （可选）

    • setTimeout double（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。

    • setUrl String | Pattern | Predicate<String>（可选）#

      等待导航时要匹配的通配符模式、正则表达式模式或接收 [URL] 的断言。请注意，如果参数是一个没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 URL。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT }（可选）#

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

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

  • callback Runnable 新增于：v1.9#

    执行触发事件操作的回调。

返回值

waitForSelector​

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

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

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

备注

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

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

用法

此方法在导航过程中均有效：

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType chromium = playwright.chromium();
      Browser browser = chromium.launch();
      Page page = browser.newPage();
      for (String currentURL : Arrays.asList("https://google.com", "https://bbc.com")) {
        page.navigate(currentURL);
        ElementHandle element = page.waitForSelector("img");
        System.out.println("Loaded image: " + element.getAttribute("src"));
      }
      browser.close();
    }
  }
}

参数

  • selector String#

    要查询的选择器。

  • options Page.WaitForSelectorOptions（可选）

    • setState enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN }（可选）#

      默认为 'visible'。可以是以下值：

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

    • setStrict boolean（可选） 新增于：v1.14#

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

    • setTimeout double（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

waitForTimeout​

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

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

等待指定的 timeout 毫秒数。

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

用法

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

参数

  • timeout double#

    等待的超时时间

返回值