Page

页面提供与浏览器中的单个标签页或 Chromium 中的扩展后台页面交互的方法。一个浏览器实例可能有多个页面实例。

此示例创建一个页面，导航到 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);
// Sometime later...
page.offRequest(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
page.addInitScript(Paths.get("./preload.js"));

注意

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

参数

script 字符串 | 路径 #

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

无返回值 #

addLocatorHandler

新增于: v1.42

page.addLocatorHandler

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

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

要记住的事情

当叠加层可预测地显示时，我们建议在您的测试中明确等待它并将其作为正常测试流程的一部分来关闭它，而不是使用 Page.addLocatorHandler()。
Playwright 在每次执行或重试需要可操作性检查的操作之前，或者在执行自动等待断言检查之前，都会检查叠加层。当叠加层可见时，Playwright 会先调用处理程序，然后继续执行操作/断言。请注意，处理程序仅在您执行操作/断言时调用 — 如果叠加层变为可见但您未执行任何操作，则不会触发处理程序。
执行处理程序后，Playwright 将确保触发处理程序的叠加层不再可见。您可以使用 setNoWaitAfter 禁用此行为。
处理程序的执行时间计入执行处理程序的操作/断言的超时。如果您的处理程序花费时间过长，可能会导致超时。
您可以注册多个处理程序。但是，一次只能运行一个处理程序。请确保处理程序内的操作不依赖于另一个处理程序。

警告

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

例如，考虑一个调用 Locator.focus() 后跟 Keyboard.press() 的测试。如果您的处理程序在这两个操作之间单击了一个按钮，则聚焦的元素很可能是不正确的，并且按键将在意外的元素上发生。请改用 Locator.press() 以避免此问题。

另一个示例是一系列鼠标操作，其中 Mouse.move() 后跟 Mouse.down()。同样，当处理程序在这两个操作之间运行时，鼠标位置在鼠标按下期间将是错误的。首选自包含的操作，例如 Locator.click()，它们不依赖于处理程序未更改的状态。

用法

一个在“注册新闻通讯”对话框出现时关闭它的示例

// Setup the handler.
page.addLocatorHandler(page.getByText("Sign up to the newsletter"), () -> {
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("No thanks")).click();
});

// Write the test as usual.
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("Start here")).click();

一个在显示“确认您的安全详细信息”页面时跳过它的示例

// Setup the handler.
page.addLocatorHandler(page.getByText("Confirm your security details"), () -> {
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Remind me later")).click();
});

// Write the test as usual.
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("Start here")).click();

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

// Setup the handler.
page.addLocatorHandler(page.locator("body"), () -> {
  page.evaluate("window.removeObstructionsForTestIfNeeded()");
}, new Page.AddLocatorHandlerOptions().setNoWaitAfter(true));

// Write the test as usual.
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("Start here")).click();

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

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

参数

locator 定位器 #

触发处理程序的定位器。
handler 消费者<定位器>#

当定位器出现时应运行的函数。此函数应移除阻止单击等操作的元素。
options Page.AddLocatorHandlerOptions (可选)
- setNoWaitAfter boolean (可选)新增于：v1.44#
  
  默认情况下，在调用处理程序后，Playwright 将等待叠加层变为隐藏，然后 Playwright 才会继续执行触发处理程序的操作/断言。此选项允许选择退出此行为，以便在处理程序运行后叠加层可以保持可见。
- setTimes 整数 (可选)新增于：v1.44#
  
  指定此处理程序应被调用的最大次数。默认无限制。

无返回值 #

addScriptTag

v1.9 之前添加

page.addScriptTag

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

用法

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

参数

options Page.AddScriptTagOptions (可选)
- setContent 字符串 (可选)#
  
  要注入到框架中的原始 JavaScript 内容。
- setPath 路径 (可选)#
  
  要注入到框架中的 JavaScript 文件路径。如果 path 是相对路径，则它相对于当前工作目录解析。
- setType 字符串 (可选)#
  
  脚本类型。使用 'module' 以加载 JavaScript ES6 模块。有关详细信息，请参阅 script。
- setUrl 字符串 (可选)#
  
  要添加的脚本的 URL。

元素句柄 #

addStyleTag

v1.9 之前添加

page.addStyleTag

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

用法

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

参数

options Page.AddStyleTagOptions (可选)
- setContent 字符串 (可选)#
  
  要注入到框架中的原始 CSS 内容。
- setPath 路径 (可选)#
  
  要注入到框架中的 CSS 文件路径。如果 path 是相对路径，则它相对于当前工作目录解析。
- setUrl 字符串 (可选)#
  
  <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 布尔值 (可选)#
  
  默认为 false。是否运行 before unload 页面处理程序。

无返回值 #

content

v1.9 之前添加

page.content

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

用法

Page.content();

字符串 #

context

v1.9 之前添加

page.context

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

用法

Page.context();

浏览器上下文 #

dragAndDrop

添加于：v1.13

page.dragAndDrop

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

用法

page.dragAndDrop("#source", "#target");
// or specify exact positions relative to the top-left corners of the elements:
page.dragAndDrop("#source", "#target", new Page.DragAndDropOptions()
  .setSourcePosition(34, 7).setTargetPosition(10, 20));

参数

source 字符串 #

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

用于搜索要拖放到的元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Page.DragAndDropOptions (可选)
- setForce 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setSourcePosition SourcePosition (可选)新增于：v1.14#
  - setX double
  - setY double
  在此点（相对于元素内边距框的左上角）点击源元素。如果未指定，则使用元素的某个可见点。
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTargetPosition TargetPosition (可选)新增于：v1.14#
  - setX double
  - setY double
  在此点（相对于元素内边距框的左上角）拖放到目标元素。如果未指定，则使用元素的某个可见点。
- setTimeout 双精度浮点数 (可选)#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial 布尔值 (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 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 空 | 枚举 ColorScheme { LIGHT, DARK, NO_PREFERENCE } (可选)添加于：v1.9#
  
  模拟 prefers-colors-scheme 媒体特性，支持的值为 'light' 和 'dark'。传递 null 禁用颜色方案模拟。'no-preference' 已弃用。
- setContrast 空 | 枚举 Contrast { NO_PREFERENCE, MORE } (可选)添加于: v1.51#
  
  模拟 'prefers-contrast' 媒体特性，支持的值为 'no-preference'、'more'。传递 null 禁用对比度模拟。
- setForcedColors 空 | 枚举 ForcedColors { ACTIVE, NONE } (可选)新增于: v1.15#
  
  模拟 'forced-colors' 媒体特性，支持的值为 'active' 和 'none'。传递 null 禁用强制颜色模拟。
- setMedia 空 | 枚举 Media { SCREEN, PRINT } (可选)添加于：v1.9#
  
  更改页面的 CSS 媒体类型。唯一允许的值是 'screen'、'print' 和 null。传递 null 禁用 CSS 媒体模拟。
- setReducedMotion 空 | 枚举 ReducedMotion { REDUCE, NO_PREFERENCE } (可选)添加于：v1.12#
  
  模拟 'prefers-reduced-motion' 媒体功能，支持的值为 'reduce'、'no-preference'。传递 null 会禁用减速运动模拟。

无返回值 #

evaluate

v1.9 之前添加

page.evaluate

返回表达式调用的值。

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

如果传递给 Page.evaluate() 的函数返回非可序列化值，则 Page.evaluate() 解析为 undefined。Playwright 还支持传输一些 JSON 无法序列化的附加值：-0、NaN、Infinity、-Infinity。

用法

将参数传递给表达式

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

也可以传递字符串而不是函数

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

元素句柄实例可以作为参数传递给 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 字符串 #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg 评估参数 (可选)#

要传递给表达式的可选参数。

对象 #

evaluateHandle

v1.9 之前添加

page.evaluateHandle

将表达式调用的值作为 JSHandle 返回。

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

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

用法

// Handle for the window object.
JSHandle aWindowHandle = page.evaluateHandle("() => Promise.resolve(window)");

也可以传递字符串而不是函数

JSHandle aHandle = page.evaluateHandle("document"); // Handle for the "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 字符串 #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg 评估参数 (可选)#

要传递给表达式的可选参数。

JSHandle #

exposeBinding

v1.9 之前添加

page.exposeBinding

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

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

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

注意

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

用法

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

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

窗口对象上函数的名称。
callback BindingCallback#

将在 Playwright 上下文中调用的回调函数。
options Page.ExposeBindingOptions (可选)
- setHandle 布尔值 (可选)#
  
  已弃用
  此选项将在未来版本中移除。
  
  是否将参数作为句柄传递，而不是按值传递。当传递句柄时，只支持一个参数。当按值传递时，支持多个参数。

无返回值 #

exposeFunction

v1.9 之前添加

page.exposeFunction

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

如果 callback 返回一个 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 字符串 #

窗口对象上函数的名称
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);

参数

url 字符串 | 模式 | 谓词<字符串>#

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

空 | 框架 #

frameLocator

新增于: v1.17

page.frameLocator

使用 iframe 时，您可以创建一个框架定位器，它将进入 iframe 并允许选择 iframe 中的元素。

用法

以下代码片段在 id 为 my-frame 的 iframe 中查找文本为“提交”的元素，例如 <iframe id="my-frame">

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

参数

selector 字符串 #

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

框架定位器 #

frames

v1.9 之前添加

page.frames

附加到页面的所有帧的数组。

用法

Page.frames();

列表<框架>#

getByAltText

新增于：v1.27

page.getByAltText

允许根据元素的 alt 文本定位元素。

用法

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

<img alt='Playwright logo'>

page.getByAltText("Playwright logo").click();

参数

text 字符串 | 模式 #

用于定位元素的文本。
options Page.GetByAltTextOptions (可选)
- setExact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

getByLabel

新增于：v1.27

page.getByLabel

允许通过关联的 <label> 或 aria-labelledby 元素的文本或 aria-label 属性来定位输入元素。

用法

例如，此方法将在以下 DOM 中通过标签“用户名”和“密码”找到输入

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">

page.getByLabel("Username").fill("john");
page.getByLabel("Password").fill("secret");

参数

text 字符串 | 模式 #

用于定位元素的文本。
options Page.GetByLabelOptions (可选)
- setExact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

getByPlaceholder

新增于：v1.27

page.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

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

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

参数

text 字符串 | 模式 #

用于定位元素的文本。
options Page.GetByPlaceholderOptions (可选)
- setExact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

getByRole

新增于：v1.27

page.getByRole

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

用法

考虑以下 DOM 结构。

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

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

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

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

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

参数

role 枚举 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 布尔值 (可选)#
  
  通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。
  
  了解更多关于 aria-checked 的信息。
- setDisabled 布尔值 (可选)#
  
  通常由 aria-disabled 或 disabled 设置的属性。
  
  注意
  与大多数其他属性不同，disabled 在 DOM 层次结构中是继承的。了解更多关于 aria-disabled 的信息。
- setExact boolean (可选)新增于: v1.28#
  
  是否精确匹配 setName：区分大小写和全字符串。默认为 false。当 setName 是正则表达式时忽略。请注意，精确匹配仍会去除空白字符。
- setExpanded 布尔值 (可选)#
  
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded 的信息。
- setIncludeHidden 布尔值 (可选)#
  
  控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（由 ARIA 定义）由角色选择器匹配。
  
  了解更多关于 aria-hidden 的信息。
- setLevel 整数 (可选)#
  
  通常用于角色 heading、listitem、row、treeitem 的数字属性，<h1>-<h6> 元素具有默认值。
  
  了解更多关于 aria-level 的信息。
- setName 字符串 | 模式 (可选)#
  
  匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 setExact 来控制此行为。
  
  了解更多关于可访问名称的信息。
- setPressed 布尔值 (可选)#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- setSelected 布尔值 (可选)#
  
  通常由 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();

参数

testId 字符串 | 模式 #

用于定位元素的 ID。

定位器 #

详情

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

getByText

新增于：v1.27

page.getByText

允许定位包含给定文本的元素。

另请参阅 Locator.filter()，它允许通过另一个条件（如可访问角色）进行匹配，然后通过文本内容进行筛选。

用法

考虑以下 DOM 结构

<div>Hello <span>world</span></div>
<div>Hello</div>

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

// Matches <span>
page.getByText("world");

// Matches first <div>
page.getByText("Hello world");

// Matches second <div>
page.getByText("Hello", new Page.GetByTextOptions().setExact(true));

// Matches both <div>s
page.getByText(Pattern.compile("Hello"));

// Matches second <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));

参数

text 字符串 | 模式 #

用于定位元素的文本。
options Page.GetByTextOptions (可选)
- setExact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

详情

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

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

getByTitle

新增于：v1.27

page.getByTitle

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

用法

考虑以下 DOM 结构。

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

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

assertThat(page.getByTitle("Issues count")).hasText("25 issues");

参数

text 字符串 | 模式 #

用于定位元素的文本。
options Page.GetByTitleOptions (可选)
- setExact 布尔值 (可选)#
  
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

定位器 #

goBack

v1.9 之前添加

page.goBack

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

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

用法

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

参数

options Page.GoBackOptions (可选)
- setTimeout 双精度浮点数 (可选)#
  
  最大操作时间（毫秒），默认为 30 秒，传递 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setWaitUntil 枚举 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 双精度浮点数 (可选)#
  
  最大操作时间（毫秒），默认为 30 秒，传递 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setWaitUntil 枚举 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 字符串 #

用于解析 DOM 元素的选取器。
options Page.LocatorOptions (可选)
- setHas 定位器 (可选)#
  
  将方法的结果缩小到包含与此相对定位器匹配的元素的那些。例如，具有 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 字符串 | 模式 (可选)新增于：v1.33#
  
  匹配不包含指定文本的元素，可能在子元素或后代元素中。当传递字符串时，匹配不区分大小写并搜索子字符串。
- setHasText 字符串 | 模式 (可选)#
  
  匹配包含指定文本的元素，可能在子元素或后代元素中。当传递字符串时，匹配不区分大小写并搜索子字符串。例如，"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 字符串 #

要导航到的页面 URL。URL 应包含方案，例如 https://。当通过上下文选项提供 setBaseURL 并且传入的 URL 是不以 * 开头的字符串时，它将通过 new URL() 构造函数进行解析。
options Page.NavigateOptions (可选)
- setReferer 字符串 (可选)#
  
  Referer 标头值。如果提供，它将优先于 Page.setExtraHTTPHeaders() 设置的 Referer 标头值。
- setTimeout 双精度浮点数 (可选)#
  
  最大操作时间（毫秒），默认为 30 秒，传递 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setWaitUntil 枚举 WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (可选)#
  
  何时认为操作成功，默认为 load。事件可以是以下之一
  - 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
  - 'load' - 当 load 事件触发时，认为操作完成。
  - 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
  - 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

空 | 响应 #

onceDialog

新增于: v1.10

page.onceDialog

添加一次性对话框处理程序。该处理程序将在下一个对话框创建后立即移除。

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

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

// prints 'null' as the dialog will be auto-dismissed because there are no handlers.
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);

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

// prints 'null' as the dialog will be auto-dismissed because there are no handlers.
System.out.println(page.evaluate("prompt('Enter string:')"));

用法

Page.onceDialog(handler);

参数

handler 消费者<对话框>#

接收 Dialog 对象，它**必须** Dialog.accept() 或 Dialog.dismiss() 该对话框 — 否则页面将冻结等待对话框，并且像点击这样的操作将永远不会完成。

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

用法

// Generates a PDF with "screen" media type.
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 选项是

信纸: 8.5 英寸 x 11 英寸
法律: 8.5 英寸 x 14 英寸
Tabloid: 11 英寸 x 17 英寸
账本: 17 英寸 x 11 英寸
A0: 33.1 英寸 x 46.8 英寸
A1: 23.4 英寸 x 33.1 英寸
A2: 16.54 英寸 x 23.4 英寸
A3: 11.7 英寸 x 16.54 英寸
A4: 8.27 英寸 x 11.7 英寸
A5: 5.83 英寸 x 8.27 英寸
A6: 4.13 英寸 x 5.83 英寸

注意

setHeaderTemplate 和 setFooterTemplate 标记有以下限制：> 1. 模板内的脚本标签不被评估。> 2. 页面样式在模板内不可见。

参数

options Page.PdfOptions (可选)
- setDisplayHeaderFooter 布尔值 (可选)#
  
  显示页眉和页脚。默认为 false。
- setFooterTemplate 字符串 (可选)#
  
  打印页脚的 HTML 模板。应使用与 setHeaderTemplate 相同的格式。
- setFormat 字符串 (可选)#
  
  纸张格式。如果设置，优先于 setWidth 或 setHeight 选项。默认为“Letter”。
- setHeaderTemplate 字符串 (可选)#
  
  打印页眉的 HTML 模板。应为有效 HTML 标记，其中以下类用于注入打印值
  - 'date' 格式化的打印日期
  - 'title' 文档标题
  - 'url' 文档位置
  - 'pageNumber' 当前页码
  - 'totalPages' 文档总页数
- setHeight 字符串 (可选)#
  
  纸张高度，接受带单位的值。
- setLandscape 布尔值 (可选)#
  
  纸张方向。默认为 false。
- setMargin Margin (可选)#
  - setTop 字符串 (可选)
    
    上边距，接受带单位的值。默认为 0。
  - setRight 字符串 (可选)
    
    右边距，接受带单位的值。默认为 0。
  - setBottom 字符串 (可选)
    
    下边距，接受带单位的值。默认为 0。
  - setLeft 字符串 (可选)
    
    左边距，接受带单位的值。默认为 0。
  纸张边距，默认为无。
- setOutline 布尔值 (可选)新增于: v1.42#
  
  是否将文档大纲嵌入 PDF。默认为 false。
- setPageRanges 字符串 (可选)#
  
  要打印的页面范围，例如 '1-5, 8, 11-13'。默认为空字符串，表示打印所有页面。
- setPath 路径 (可选)#
  
  保存 PDF 的文件路径。如果 setPath 是相对路径，则它相对于当前工作目录解析。如果未提供路径，则 PDF 将不会保存到磁盘。
- setPreferCSSPageSize 布尔值 (可选)#
  
  页面中声明的任何 CSS @page 大小优先于 setWidth 和 setHeight 或 setFormat 选项中声明的尺寸。默认为 false，这将缩放内容以适应纸张大小。
- setPrintBackground 布尔值 (可选)#
  
  打印背景图形。默认为 false。
- setScale 双精度浮点数 (可选)#
  
  网页渲染的比例。默认为 1。比例值必须在 0.1 到 2 之间。
- setTagged 布尔值 (可选)新增于: v1.42#
  
  是否生成带标签（可访问）的 PDF。默认为 false。
- setWidth 字符串 (可选)#
  
  纸张宽度，接受带单位的值。

字节数组 #

reload

v1.9 之前添加

page.reload

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

用法

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

参数

options Page.ReloadOptions (可选)
- setTimeout 双精度浮点数 (可选)#
  
  最大操作时间（毫秒），默认为 30 秒，传递 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setWaitUntil 枚举 WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (可选)#
  
  何时认为操作成功，默认为 load。事件可以是以下之一
  - 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
  - 'load' - 当 load 事件触发时，认为操作完成。
  - 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
  - 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

空 | 响应 #

removeLocatorHandler

新增于：v1.44

page.removeLocatorHandler

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

用法

Page.removeLocatorHandler(locator);

参数

locator 定位器 #

传递给 Page.addLocatorHandler() 的定位器。

无返回值 #

requestGC

新增于: v1.48

page.requestGC

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

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

// 1. In your page, save a WeakRef for the "suspect".
page.evaluate("globalThis.suspectWeakRef = new WeakRef(suspect)");
// 2. Request garbage collection.
page.requestGC();
// 3. Check that weak ref does not deref to the original object.
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 字符串 | 模式 | 谓词<字符串>#

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

用于路由请求的处理函数。
options Page.RouteOptions (可选)
- setTimes 整数 (可选)新增于: 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 路径 #

带有预录网络数据的 HAR 文件路径。如果 path 是相对路径，则它相对于当前工作目录解析。
options Page.RouteFromHAROptions (可选)
- setNotFound 枚举 HarNotFound { ABORT, FALLBACK } (可选)#
  - 如果设置为 'abort'，则 HAR 文件中未找到的任何请求都将被中止。
  - 如果设置为 'fallback'，则缺失的请求将被发送到网络。
  默认为中止。
- setUpdate 布尔值 (可选)#
  
  如果指定，则使用实际网络信息更新给定的 HAR，而不是从文件提供。当调用 BrowserContext.close() 时，文件将写入磁盘。
- setUpdateContent 枚举 RouteFromHarUpdateContentPolicy { EMBED, ATTACH } (可选)新增于: v1.32#
  
  可选设置以控制资源内容管理。如果指定 attach，资源将作为单独的文件或 ZIP 档案中的条目持久化。如果指定 embed，内容将内联存储在 HAR 文件中。
- setUpdateMode 枚举 HarMode { FULL, MINIMAL } (可选)新增于: v1.32#
  
  当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这会省略 HAR 信息中不用于从 HAR 重放的大小、时间、页面、cookie、安全性和其他类型的信息。默认为 minimal。
- setUrl 字符串 | 模式 (可选)#
  
  一个 glob 模式、正则表达式或谓词，用于匹配请求 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");
  });
});

参数

url 字符串 | 模式 | 谓词<字符串>#

只有与此模式匹配的 WebSocket URL 才会被路由。字符串模式可以相对于 setBaseURL 上下文选项。
handler Consumer<WebSocketRoute>#

用于路由 WebSocket 的处理函数。

void #

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

void #

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() 不保证传出请求中 HTTP 头部的顺序。

用法

Page.setExtraHTTPHeaders(headers);

参数

headers Map<String, String>#

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

void #

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#

页面高度（像素）。

void #

title

v1.9 之前添加

page.title

返回页面的标题。

用法

Page.title();

String #

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> （可选）#

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

void #

unrouteAll

新增于: v1.41

page.unrouteAll

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

用法

Page.unrouteAll();

void #

url

v1.9 之前添加

page.url

用法

Page.url();

String #

video

v1.9 之前添加

page.video

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

用法

Page.video();

null | 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 （可选）
- setTimeout 双精度浮点数 (可选)添加于：v1.9#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 更改。
callback Runnable添加于：v1.9#

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

Page #

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

参数

condition [BooleanSupplier]#

要等待的条件。
options Page.WaitForConditionOptions （可选）
- setTimeout double （可选）#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

void #

waitForConsoleMessage

添加于：v1.9

page.waitForConsoleMessage

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

用法

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

参数

options Page.WaitForConsoleMessageOptions （可选）
- setPredicate Predicate<ConsoleMessage> （可选）#
  
  接收 ConsoleMessage 对象，并在等待应解决时解析为真值。
- setTimeout double （可选）#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 更改。
callback Runnable #

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

ConsoleMessage #

waitForDownload

添加于：v1.9

page.waitForDownload

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

用法

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

参数

options Page.WaitForDownloadOptions （可选）
- setPredicate Predicate<Download> （可选）#
  
  接收 Download 对象，并在等待应解决时解析为真值。
- setTimeout double （可选）#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 更改。
callback Runnable #

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

Download #

waitForFileChooser

添加于：v1.9

page.waitForFileChooser

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

用法

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

参数

options Page.WaitForFileChooserOptions （可选）
- setPredicate Predicate<FileChooser> （可选）#
  
  接收 FileChooser 对象，并在等待应解决时解析为真值。
- setTimeout double （可选）#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 更改。
callback Runnable #

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

FileChooser #

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() 方法更改。

JSHandle #

waitForLoadState

v1.9 之前添加

page.waitForLoadState

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

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

注意

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

用法

page.getByRole(AriaRole.BUTTON).click(); // Click triggers navigation.
page.waitForLoadState(); // The promise resolves after "load" event.

Page popup = page.waitForPopup(() -> {
  page.getByRole(AriaRole.BUTTON).click(); // Click triggers a popup.
});
// Wait for the "DOMContentLoaded" event
popup.waitForLoadState(LoadState.DOMCONTENTLOADED);
System.out.println(popup.title()); // Popup is ready to use.

参数

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

要等待的可选加载状态，默认为 load。如果当前文档加载期间已达到该状态，则该方法会立即解析。可以是以下之一
- 'load' - 等待 load 事件触发。
- 'domcontentloaded' - 等待 DOMContentLoaded 事件触发。
- 'networkidle' - **不推荐** 等待至少 500 毫秒内没有网络连接。不要将此方法用于测试，而是依赖 Web 断言来评估准备情况。
options Page.WaitForLoadStateOptions （可选）
- setTimeout double （可选）#
  
  最大操作时间（毫秒），默认为 30 秒，传递 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout() 或 Page.setDefaultTimeout() 方法更改。

void #

添加于：v1.9

page.waitForPopup

执行操作并等待弹出 Page。如果提供了谓词，它将 [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 #

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

Page #

waitForRequest

v1.9 之前添加

page.waitForRequest

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

用法

// Waits for the next request with the specified url
Request request = page.waitForRequest("https://example.com/resource", () -> {
  // Triggers the request
  page.getByText("trigger request").click();
});

// Waits for the next request matching some conditions
Request request = page.waitForRequest(request -> "https://example.com".equals(request.url()) && "GET".equals(request.method()), () -> {
  // Triggers the request
  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#

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

Request #

waitForRequestFinished

添加于：v1.12

page.waitForRequestFinished

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

用法

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

参数

options Page.WaitForRequestFinishedOptions （可选）
- setPredicate Predicate<Request> （可选）#
  
  接收 Request 对象，并在等待应解决时解析为真值。
- setTimeout double （可选）#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 更改。
callback Runnable #

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

Request #

waitForResponse

v1.9 之前添加

page.waitForResponse

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

用法

// Waits for the next response with the specified url
Response response = page.waitForResponse("https://example.com/resource", () -> {
  // Triggers the response
  page.getByText("trigger response").click();
});

// Waits for the next response matching some conditions
Response response = page.waitForResponse(response -> "https://example.com".equals(response.url()) && response.status() == 200 && "GET".equals(response.request().method()), () -> {
  // Triggers the response
  page.getByText("trigger response").click();
});

参数

urlOrPredicate String | Pattern | Predicate<Response>#

请求 URL 字符串、正则表达式或接收 Response 对象的谓词。如果通过上下文选项提供了 setBaseURL 并且传入的 URL 是路径，则它通过 new URL() 构造函数进行合并。
options Page.WaitForResponseOptions （可选）
- setTimeout double （可选）#
  
  最大等待时间（毫秒），默认为 30 秒，传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
callback Runnable添加于：v1.9#

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

Response #

waitForURL

添加于：v1.11

page.waitForURL

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

用法

page.click("a.delayed-navigation"); // Clicking the link will indirectly cause a 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' - 当收到网络响应且文档开始加载时，认为操作完成。

void #

waitForWebSocket

添加于：v1.9

page.waitForWebSocket

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

用法

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

参数

options Page.WaitForWebSocketOptions （可选）
- setPredicate Predicate<WebSocket> （可选）#
  
  接收 WebSocket 对象，并在等待应解决时解析为真值。
- setTimeout double （可选）#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 更改。
callback Runnable #

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

WebSocket #

waitForWorker

添加于：v1.9

page.waitForWorker

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

用法

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

参数

options Page.WaitForWorkerOptions （可选）
- setPredicate Predicate<Worker> （可选）#
  
  接收 Worker 对象，并在等待应解决时解析为真值。
- setTimeout double （可选）#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 更改。
callback Runnable #

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

Worker #

workers

v1.9 之前添加

page.workers

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

注意

这不包含 ServiceWorkers

用法

Page.workers();

List<Worker>#

属性

clock()

新增于: v1.45

page.clock()

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

用法

Page.clock()

时钟

keyboard()

v1.9 之前添加

page.keyboard()

用法

Page.keyboard()

Keyboard

mouse()

v1.9 之前添加

page.mouse()

用法

Page.mouse()

Mouse

request()

添加于：v1.16

page.request()

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

用法

Page.request()

APIRequestContext

touchscreen()

v1.9 之前添加

page.touchscreen()

用法

Page.touchscreen()

Touchscreen

事件

onClose(handler)

v1.9 之前添加

page.onClose(handler)

当页面关闭时发出。

用法

Page.onClose(handler)

事件数据

Page

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

事件数据

ConsoleMessage

onCrash(handler)

v1.9 之前添加

page.onCrash(handler)

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

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

try {
  // Crash might happen during a click.
  page.click("button");
  // Or while waiting for an event.
  page.waitForPopup(() -> {});
} catch (PlaywrightException e) {
  // When the page crashes, exception message contains "crash".
}

用法

Page.onCrash(handler)

事件数据

Page

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

事件数据

Dialog

onDOMContentLoaded(handler)

添加于：v1.9

page.onDOMContentLoaded(handler)

当 JavaScript DOMContentLoaded 事件被分派时发出。

用法

Page.onDOMContentLoaded(handler)

事件数据

Page

onDownload(handler)

v1.9 之前添加

page.onDownload(handler)

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

用法

Page.onDownload(handler)

事件数据

Download

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)

事件数据

FileChooser

onFrameAttached(handler)

添加于：v1.9

page.onFrameAttached(handler)

当框架附加时发出。

用法

Page.onFrameAttached(handler)

事件数据

Frame

onFrameDetached(handler)

添加于：v1.9

page.onFrameDetached(handler)

当框架分离时发出。

用法

Page.onFrameDetached(handler)

事件数据

Frame

onFrameNavigated(handler)

添加于：v1.9

page.onFrameNavigated(handler)

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

用法

Page.onFrameNavigated(handler)

事件数据

Frame

onLoad(handler)

v1.9 之前添加

page.onLoad(handler)

当 JavaScript load 事件被分派时发出。

用法

Page.onLoad(handler)

事件数据

Page

onPageError(handler)

添加于：v1.9

page.onPageError(handler)

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

// Log all uncaught errors to the terminal
page.onPageError(exception -> {
  System.out.println("Uncaught exception: " + exception);
});

// Navigate to a page with an exception.
page.navigate("data:text/html,<script>throw new Error('Test')</script>");

用法

Page.onPageError(handler)

事件数据

String

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)

事件数据

Page

onRequest(handler)

v1.9 之前添加

page.onRequest(handler)

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

用法

Page.onRequest(handler)

事件数据

Request

onRequestFailed(handler)

添加于：v1.9

page.onRequestFailed(handler)

当请求失败时发出，例如由于超时。

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

注意

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

用法

Page.onRequestFailed(handler)

事件数据

Request

onRequestFinished(handler)

添加于：v1.9

page.onRequestFinished(handler)

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

用法

Page.onRequestFinished(handler)

事件数据

Request

onResponse(handler)

v1.9 之前添加

page.onResponse(handler)

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

用法

Page.onResponse(handler)

事件数据

Response

onWebSocket(handler)

添加于：v1.9

page.onWebSocket(handler)

当发送 WebSocket 请求时触发。

用法

Page.onWebSocket(handler)

事件数据

WebSocket

onWorker(handler)

v1.9 之前添加

page.onWorker(handler)

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

用法

Page.onWorker(handler)

事件数据

Worker

已弃用

check

v1.9 之前添加

page.check

不推荐

改用基于定位器的 Locator.check()。阅读更多关于定位器的信息。

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

查找与 selector 匹配的元素。如果没有，则等待匹配的元素附加到 DOM。
确保匹配的元素是复选框或单选输入。如果不是，此方法将抛出。如果元素已被选中，此方法将立即返回。
等待对匹配元素执行可操作性检查，除非设置了 setForce 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素中心。
确保元素现在已选中。如果不是，此方法将抛出异常。

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

用法

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

参数

selector String #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Page.CheckOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)添加于：v1.11#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double （可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

click

v1.9 之前添加

page.click

不推荐

改用基于定位器的 Locator.click()。阅读更多关于定位器的信息。

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

查找与 selector 匹配的元素。如果没有，则等待匹配的元素附加到 DOM。
等待对匹配元素执行可操作性检查，除非设置了 setForce 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素的中心，或指定的 setPosition。
等待已启动的导航成功或失败，除非设置了 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 （可选）#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double （可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)添加于：v1.11#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以便测试仅在按下这些键时才可见的元素。

void #

dblclick

v1.9 之前添加

page.dblclick

不推荐

改用基于定位器的 Locator.dblclick()。阅读更多关于定位器的信息。

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

查找与 selector 匹配的元素。如果没有，则等待匹配的元素附加到 DOM。
等待对匹配元素执行可操作性检查，除非设置了 setForce 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 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 （可选）#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double （可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)添加于：v1.11#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以便测试仅在按下这些键时才可见的元素。

void #

dispatchEvent

v1.9 之前添加

page.dispatchEvent

不推荐

改用基于定位器的 Locator.dispatchEvent()。阅读更多关于定位器的信息。

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

用法

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

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

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

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

// Note you can only create DataTransfer in Chromium and Firefox
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() 方法更改。

void #

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 （可选）#

要传递给表达式的可选参数。
options Page.EvalOnSelectorOptions (可选)
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

Object #

evalOnSelectorAll

添加于：v1.9

page.evalOnSelectorAll

不推荐

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

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

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

用法

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

参数

selector String #

要查询的选择器。
expression String #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg EvaluationArgument (可选)#

要传递给表达式的可选参数。

Object #

fill

v1.9 之前添加

page.fill

不推荐

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

此方法等待匹配选择器的元素，等待可操作性检查，聚焦元素，填充它并在填充后触发 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() 方法更改。

void #

focus

v1.9 之前添加

page.focus

不推荐

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

此方法获取匹配选择器的元素并聚焦它。如果没有元素匹配选择器，该方法将等待直到 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() 方法更改。

void #

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() 方法更改。

null | String #

hover

v1.9 之前添加

page.hover

不推荐

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

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

查找匹配选择器的元素。如果没有，则等待直到匹配元素附加到 DOM。
等待对匹配元素进行可操作性检查，除非设置了 setForce 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 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 (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double (可选)#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)添加于：v1.11#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以便测试仅在按下这些键时才可见的元素。

void #

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() 方法更改。

String #

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() 方法更改。

String #

inputValue

添加于：v1.13

page.inputValue

不推荐

改用基于定位器的 Locator.inputValue()。阅读更多关于定位器的信息。

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

对非输入元素抛出错误。但是，如果元素位于具有关联控件的 <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() 方法更改。

String #

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() 方法更改。

boolean #

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() 方法更改。

boolean #

isEditable

v1.9 之前添加

page.isEditable

不推荐

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

返回元素是否可编辑。

用法

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() 方法更改。

boolean #

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() 方法更改。

boolean #

isHidden

v1.9 之前添加

page.isHidden

不推荐

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

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

用法

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

参数

selector String #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Page.IsHiddenOptions (可选)
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double (可选)#
  
  已弃用
  此选项被忽略。Page.isHidden() 不会等待元素变为隐藏并立即返回。

boolean #

isVisible

v1.9 之前添加

page.isVisible

不推荐

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

返回元素是否可见。选择器不匹配任何元素被认为不可见。

用法

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

参数

selector String #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Page.IsVisibleOptions (可选)
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double (可选)#
  
  已弃用
  此选项被忽略。Page.isVisible() 不会等待元素变为可见并立即返回。

boolean #

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() 方法更改。

void #

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，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

null | ElementHandle #

querySelectorAll

添加于：v1.9

page.querySelectorAll

不推荐

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

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

用法

Page.querySelectorAll(selector);

参数

selector String #

要查询的选择器。

List<ElementHandle>#

selectOption

v1.9 之前添加

page.selectOption

不推荐

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

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

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

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

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

用法

// Single selection matching the value or label
page.selectOption("select#colors", "blue");
// single selection matching both the value and the label
page.selectOption("select#colors", new SelectOption().setLabel("Blue"));
// multiple selection
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() 方法更改。

List<String>#

setChecked

新增于: v1.15

page.setChecked

不推荐

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

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

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

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

用法

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

参数

selector String #

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

是否选中或取消选中复选框。
options Page.SetCheckedOptions (可选)
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setStrict boolean (可选)#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double (可选)#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

setInputFiles

v1.9 之前添加

page.setInputFiles

不推荐

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

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

此方法需要选择器指向一个 input 元素。但是，如果元素位于具有关联控件的 <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() 方法更改。

void #

tap

v1.9 之前添加

page.tap

不推荐

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

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

查找匹配选择器的元素。如果没有，则等待直到匹配元素附加到 DOM。
等待对匹配元素进行可操作性检查，除非设置了 setForce 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 Page.touchscreen() 点击元素的中心，或指定的 setPosition。

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

注意

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

用法

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 (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double (可选)#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)添加于：v1.11#
  
  当设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以便测试仅在按下这些键时才可见的元素。

void #

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() 方法更改。

null | String #

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() 方法更改。

void #

uncheck

v1.9 之前添加

page.uncheck

不推荐

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

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

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

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

用法

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

参数

selector String #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
options Page.UncheckOptions (可选)
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)添加于：v1.11#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setStrict boolean (可选)新增于：v1.14#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double (可选)#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

v1.9 之前添加

page.waitForNavigation

已弃用

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

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

用法

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

// The method returns after navigation has finished
Response response = page.waitForNavigation(() -> {
  // This action triggers the navigation after a timeout.
  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#

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

null | Response #

waitForSelector

v1.9 之前添加

page.waitForSelector

不推荐

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

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

注意

Playwright 会在执行操作之前自动等待元素就绪。使用 Locator 对象和 Web 优先断言可以使代码摆脱等待选择器。

等待选择器满足 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() 方法更改。

null | ElementHandle #

waitForTimeout

v1.9 之前添加

page.waitForTimeout

不推荐

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

等待给定 timeout 毫秒。

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

用法

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

参数

timeout double #

要等待的超时时间。

void #

方法​

addInitScript​

addLocatorHandler​

addScriptTag​

addStyleTag​

bringToFront​

close​

content​

context​

dragAndDrop​

emulateMedia​

evaluate​

evaluateHandle​

exposeBinding​

exposeFunction​

frame​

frameByUrl​

frameLocator​

frames​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

goBack​

goForward​

isClosed​

locator​

mainFrame​

navigate​

onceDialog​

opener​

pause​

pdf​

reload​

removeLocatorHandler​

requestGC​

route​

routeFromHAR​

routeWebSocket​

screenshot​

setContent​

setDefaultNavigationTimeout​

setDefaultTimeout​

setExtraHTTPHeaders​

setViewportSize​

title​

unroute​

unrouteAll​

url​

video​

viewportSize​

waitForClose​

waitForCondition​

waitForConsoleMessage​

waitForDownload​

waitForFileChooser​

waitForFunction​

waitForLoadState​

waitForPopup​

waitForRequest​

waitForRequestFinished​

waitForResponse​

waitForURL​

waitForWebSocket​

waitForWorker​

workers​

属性​

clock()​

keyboard()​

mouse()​

request()​

touchscreen()​

事件​

onClose(handler)​

onConsoleMessage(handler)​

onCrash(handler)​

onDialog(handler)​

方法

addInitScript

addLocatorHandler

addScriptTag

addStyleTag

bringToFront

close

content

context

dragAndDrop

emulateMedia

evaluate

evaluateHandle

exposeBinding

exposeFunction

frame

frameByUrl

frameLocator

frames

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

goBack

goForward

isClosed

locator

mainFrame

navigate

onceDialog

opener

pause

pdf

reload

removeLocatorHandler

requestGC

route

routeFromHAR

routeWebSocket

screenshot

setContent

setDefaultNavigationTimeout

setDefaultTimeout

setExtraHTTPHeaders

setViewportSize

title

unroute

unrouteAll

url

video

viewportSize

waitForClose

waitForCondition

waitForConsoleMessage

waitForDownload

waitForFileChooser

waitForFunction

waitForLoadState

waitForPopup

waitForRequest

waitForRequestFinished

waitForResponse

waitForURL

waitForWebSocket

waitForWorker

workers

属性

clock()

keyboard()

mouse()

request()

touchscreen()

事件

onClose(handler)

onConsoleMessage(handler)

onCrash(handler)

onDialog(handler)