跳到主要内容

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);
// 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 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()，它们不依赖于处理器未改变状态。

用法

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

// 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 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

在页面中添加一个带有指定 URL 的 <link rel="stylesheet"> 标签或一个带有内容的 <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，则不运行任何 unload 处理器并等待页面关闭。如果 setRunBeforeUnload 为 true，该方法将运行 unload 处理器，但不会等待页面关闭。

默认情况下，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 内容，包括 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 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 media type，并通过 colorScheme 参数改变 'prefers-colors-scheme' media feature。

用法

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 media feature，支持的值有 'light' 和 'dark'。传入 null 禁用配色方案模拟。'no-preference' 已弃用。

    • setContrast null | enum Contrast { NO_PREFERENCE, MORE } (可选)新增于: v1.51#

      模拟 'prefers-contrast' media feature，支持的值有 'no-preference'、'more'。传入 null 禁用对比度模拟。

    • setForcedColors null | enum ForcedColors { ACTIVE, NONE } (可选)新增于: v1.15#

      模拟 'forced-colors' media feature，支持的值有 'active' 和 'none'。传入 null 禁用强制颜色模拟。

    • setMedia null | enum Media { SCREEN, PRINT } (可选)新增于: v1.9#

      更改页面的 CSS media type。唯一允许的值是 'screen'、'print' 和 null。传入 null 禁用 CSS media 模拟。

    • setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE } (可选)新增于: v1.12#

      模拟 'prefers-reduced-motion' media feature，支持的值是 'reduce'、'no-preference'。传入 null 禁用 Reduced Motion 模拟。

返回值

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); // prints "56"

也可以传入字符串代替函数

System.out.println(page.evaluate("1 + 2")); // prints "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 解析并返回其值。

用法

// 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 String#

    在浏览器上下文中执行评估的 JavaScript 表达式。如果表达式评估为一个函数，该函数将自动调用。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值

exposeBinding​

在 v1.9 之前添加 page.exposeBinding

此方法在页面中每个帧的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个解析为 callback 返回值的 Promise。如果 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 String#

    window 对象上的函数名称。

  • callback BindingCallback#

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

  • options Page.ExposeBindingOptions (可选)

    • setHandle boolean (可选)#

      已弃用

      此选项将来会移除。

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

返回值

exposeFunction​

在 v1.9 之前添加 page.exposeFunction

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

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

    window 对象上的函数名称

  • 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 时，可以创建一个 frame 定位器，它将进入 iframe 并允许在该 iframe 中选择元素。

用法

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

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

参数

  • selector String#

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

返回值

frames​

在 v1.9 之前添加 page.frames

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

用法

Page.frames();

返回值

getByAltText​

添加于：v1.27 page.getByAltText

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

用法

例如，此方法将通过 alt 文本“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>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 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>

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

// 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 String | Pattern#

    用于定位元素的文本。

  • options Page.GetByTextOptions (可选)

    • setExact boolean (可选)#

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

返回值

详细信息

即使使用精确匹配，通过文本匹配始终会规范化空白字符。例如，它会将多个空格变成一个，将换行符变成空格，并忽略前导和尾随的空白字符。

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

getByTitle​

添加于：v1.27 page.getByTitle

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

用法

考虑以下 DOM 结构。

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

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

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

参数

  • 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

此方法返回一个元素定位器，可用于在此页面/frame 上执行操作。定位器在执行操作之前立即解析为元素，因此对同一定位器执行一系列操作实际上可以作用于不同的 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 外部的任何元素。

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

    • setHasNot Locator (可选)添加于：v1.33#

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

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

    • setHasNotText String | Pattern (可选)添加于：v1.33#

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

    • setHasText String | Pattern (可选)#

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

返回值

mainFrame​

在 v1.9 之前添加 page.mainFrame

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

用法

Page.mainFrame();

返回值

navigate​

在 v1.9 之前添加 page.navigate

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

以下情况会抛出错误：

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

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

注意

方法要么抛出错误，要么返回主要资源响应。唯一的例外是导航到 about:blank 或导航到带有不同 hash 的相同 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");
});

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

参数

opener​

在 v1.9 之前添加 page.opener

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

用法

Page.opener();

返回值

pause​

新增于: v1.9 page.pause

暂停脚本执行。Playwright 将停止执行脚本，并等待用户按下页面叠加层中的“Resume”按钮或在 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 选项包括：

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

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

返回值

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​

Added in: 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 拦截的请求。请参阅 this issue。我们建议在使用请求拦截时通过将 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 数据（post data）的请求，而保持所有其他请求不变

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

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

  • handler Consumer<Route>#

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

  • options Page.RouteOptions （可选）

    • setTimes int (可选)新增于: v1.15#

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

返回值

routeFromHAR​

Added in: v1.23 page.routeFromHAR

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

Playwright 不会从 HAR 文件提供由 Service Worker 拦截的请求。请参阅 this issue。我们建议在使用请求拦截时通过将 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 } （可选）Added in: v1.32#

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

    • setUpdateMode enum HarMode { FULL, MINIMAL } （可选）Added in: v1.32#

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

    • setUrl String | Pattern （可选）#

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

返回值

routeWebSocket​

Added in: v1.48 page.routeWebSocket

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

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

用法

以下是一个简单 mock 的示例，它响应单个消息。有关更多详细信息和示例，请参阅 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 Animations。动画根据其持续时间获得不同的处理

      • 有限动画会快进到完成，因此它们会触发 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 定制）覆盖。遮罩也适用于不可见元素，请参阅 Matching only visible elements 以禁用此行为。

    • setMaskColor String （可选）Added in: 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 （可选）Added in: v1.41#

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

    • setTimeout double （可选）#

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

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

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

返回值

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

    一个 glob 模式、正则表达式模式或接收 [URL] 以在路由时匹配的谓词。

  • handler Consumer<Route> （可选）#

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

返回值

unrouteAll​

Added in: v1.41 page.unrouteAll

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

用法

Page.unrouteAll();

返回值

url​

在 v1.9 之前添加 page.url

用法

Page.url();

返回值

video​

在 v1.9 之前添加 page.video

与此页面关联的 Video 对象。

用法

Page.video();

返回值

viewportSize​

在 v1.9 之前添加 page.viewportSize

用法

Page.viewportSize();

返回值

  • null | ViewportSize#

    • width int

      页面宽度，单位像素。

    • height int

      页面高度，单位像素。

waitForClose​

Added in: v1.11 page.waitForClose

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

用法

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

参数

  • options Page.WaitForCloseOptions （可选）

    • setTimeout double （可选）新增于: v1.9#

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

  • callback Runnable新增于: v1.9#

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

返回值

waitForCondition​

Added in: 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。如果提供了 predicate，则将 ConsoleMessage 值传递给 predicate 函数，并等待 predicate(message) 返回一个真值。如果在 Page.onConsoleMessage(handler) 事件触发之前页面关闭，则会抛出错误。

用法

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

参数

返回值

waitForDownload​

新增于: v1.9 page.waitForDownload

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

用法

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

参数

  • options Page.WaitForDownloadOptions (可选)

  • callback Runnable#

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

返回值

waitForFileChooser​

新增于: v1.9 page.waitForFileChooser

执行操作并等待创建新的 FileChooser。如果提供了 predicate，则将 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() 函数的 expression 传递参数

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(); // 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 (可选)

返回值

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

等待匹配的 request 并返回它。有关 events 的更多详细信息，请参阅waiting for event。

用法

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

    Request URL 字符串、正则表达式或接收 Request 对象的 predicate。当通过 context options 提供了 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

返回匹配的 response。有关 events 的更多详细信息，请参阅waiting for event。

用法

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

参数

返回值

waitForURL​

Added in: v1.11 page.waitForURL

等待主 frame 导航到给定的 URL。

用法

page.click("a.delayed-navigation"); // Clicking the link will indirectly cause a navigation
page.waitForURL("**/target.html");

参数

  • url String | Pattern | Predicate<String>#

    glob 模式、regex 模式或接收 [URL] 的 predicate，用于在等待导航时匹配。注意，如果参数是不带通配符的字符串，则该方法将等待导航到与该字符串完全相等的 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

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

注意

这不包含 ServiceWorker

用法

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 测试助手。此方法返回与页面 context 上的 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 {
  // 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)

事件数据

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

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

page.onDialog(handler)

用法

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

当 JavaScript 对话框出现时触发，例如 alert、prompt、confirm 或 beforeunload。监听器必须 Dialog.accept() 或 Dialog.dismiss() 对话框 - 否则页面将因等待对话框而冻结，并且 click 等操作将永远不会完成。

事件数据

当没有 Page.onDialog(handler) 或 BrowserContext.onDialog(handler) 监听器时，所有对话框都会自动关闭。

新增于: v1.9 onDOMContentLoaded(handler)​

page.onDOMContentLoaded(handler)

用法

Page.onDOMContentLoaded(handler)

事件数据

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

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

page.onDownload(handler)

用法

Page.onDownload(handler)

事件数据

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

新增于: v1.9 onFileChooser(handler)​

page.onFileChooser(handler)

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

用法

Page.onFileChooser(handler)

事件数据

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

新增于: v1.9 onFrameAttached(handler)​

page.onFrameAttached(handler)

用法

Page.onFrameAttached(handler)

事件数据

当 frame 附加时触发。

新增于: v1.9 onFrameDetached(handler)​

page.onFrameDetached(handler)

用法

Page.onFrameDetached(handler)

事件数据

当 frame 分离时触发。

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

当 frame 导航到新的 URL 时触发。

用法

Page.onFrameNavigated(handler)

事件数据

onLoad(handler)​

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

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

用法

Page.onLoad(handler)

事件数据

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)

事件数据

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)

当页面发出请求时触发。请求对象是只读的。要拦截和修改请求，请参见 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 错误响应，例如 404 或 503，从 HTTP 的角度来看仍然是成功的响应，因此请求将以 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 的 Locator.check()。了解更多关于 locators 的信息。

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

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

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

用法

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

参数

  • selector String#

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

  • options Page.CheckOptions (可选)

    • setForce boolean (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)Added in: v1.11#

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

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

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

    • setTimeout double (可选)#

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

    • setTrial boolean (可选)Added in: v1.11#

      设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备就绪以便进行操作而无需实际执行操作时很有用。

返回值

click​

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

请改用基于 locator 的 Locator.click()。了解更多关于 locators 的信息。

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

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

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

用法

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

参数

  • selector String#

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

  • 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 (可选)Added in: v1.11#

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

返回值

dblclick​

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

请改用基于 locator 的 Locator.dblclick()。了解更多关于 locators 的信息。

此方法通过执行以下步骤来双击与 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#

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

  • 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 (可选)Added in: v1.11#

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

返回值

dispatchEvent​

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

请改用基于 locator 的 Locator.dispatchEvent()。了解更多关于 locators 的信息。

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

用法

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

在底层，它基于给定的 type 创建事件实例，使用 eventInit 属性初始化它，并在元素上分派它。事件默认是 composed（组合）、cancelable（可取消）和 bubble（冒泡）的。

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

如果您希望将 live 对象传递给事件，您还可以指定 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#

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

  • 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-first 断言。

此方法查找页面内与指定 selector 匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素匹配该 selector，则此方法抛出错误。返回 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#

    要查询的 selector。

  • expression String#

    在浏览器上下文中执行评估的 JavaScript 表达式。如果表达式评估为一个函数，该函数将自动调用。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

  • options Page.EvalOnSelectorOptions (可选)

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

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

返回值

evalOnSelectorAll​

新增于: v1.9 page.evalOnSelectorAll
不推荐

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

此方法查找页面内与指定 selector 匹配的所有元素，并将匹配元素的数组作为第一个参数传递给 expression。返回 expression 调用的结果。

如果 expression 返回一个 Promise，则 Page.evalOnSelectorAll() 会等待该 Promise 解析并返回其值。

用法

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

参数

  • selector String#

    要查询的 selector。

  • expression String#

    在浏览器上下文中执行评估的 JavaScript 表达式。如果表达式评估为一个函数，该函数将自动调用。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值

fill​

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

请改用基于 locator 的 Locator.fill()。了解更多关于 locators 的信息。

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

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

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

用法

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

参数

  • selector String#

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

  • 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 的 Locator.focus()。了解更多关于 locators 的信息。

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

用法

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

参数

  • selector String#

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

  • options Page.FocusOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值

getAttribute​

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

请改用基于 locator 的 Locator.getAttribute()。了解更多关于 locators 的信息。

返回元素的属性值。

用法

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

参数

  • selector String#

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

  • 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 的 Locator.hover()。了解更多关于 locators 的信息。

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

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

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

用法

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

参数

  • selector String#

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

  • 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 (可选)Added in: v1.11#

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

返回值

innerHTML​

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

请改用基于 locator 的 Locator.innerHTML()。了解更多关于 locators 的信息。

返回 element.innerHTML。

用法

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

参数

  • selector String#

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

  • options Page.InnerHTMLOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值

innerText​

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

请改用基于 locator 的 Locator.innerText()。了解更多关于 locators 的信息。

返回 element.innerText。

用法

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

参数

  • selector String#

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

  • options Page.InnerTextOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值

inputValue​

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

请改用基于 locator 的 Locator.inputValue()。了解更多关于 locators 的信息。

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

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

用法

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

参数

  • selector String#

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

  • options Page.InputValueOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值

isChecked​

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

请改用基于 locator 的 Locator.isChecked()。了解更多关于 locators 的信息。

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

用法

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

参数

  • selector 字符串 (String)#

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

  • options Page.IsCheckedOptions （可选）

返回值

isDisabled​

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

请改用基于 locator 的 Locator.isDisabled()。阅读更多关于 locators 的信息。

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

用法

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

参数

  • selector 字符串 (String)#

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

  • options Page.IsDisabledOptions （可选）

返回值

isEditable​

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

请改用基于 locator 的 Locator.isEditable()。阅读更多关于 locators 的信息。

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

用法

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

参数

  • selector 字符串 (String)#

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

  • options Page.IsEditableOptions （可选）

返回值

isEnabled​

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

请改用基于 locator 的 Locator.isEnabled()。阅读更多关于 locators 的信息。

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

用法

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

参数

  • selector 字符串 (String)#

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

  • options Page.IsEnabledOptions （可选）

返回值

isHidden​

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

请改用基于 locator 的 Locator.isHidden()。阅读更多关于 locators 的信息。

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

用法

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

参数

  • selector 字符串 (String)#

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

  • options Page.IsHiddenOptions （可选）

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

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

    • setTimeout 双精度浮点数 (double) （可选）#

      已弃用

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

返回值

isVisible​

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

请改用基于 locator 的 Locator.isVisible()。阅读更多关于 locators 的信息。

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

用法

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

参数

  • selector 字符串 (String)#

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

  • options Page.IsVisibleOptions （可选）

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

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

    • setTimeout 双精度浮点数 (double) （可选）#

      已弃用

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

返回值

press​

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

请改用基于 locator 的 Locator.press()。阅读更多关于 locators 的信息。

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

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

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

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

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

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

也支持 key: "Control+o", key: "Control++ 或 key: "Control+Shift+T" 等快捷方式。与修改器一起指定时，修改器被按下并保持，同时后续按键被按下。

用法

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

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

  • 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
不推荐

请改用基于 locator 的 Page.locator()。阅读更多关于 locators 的信息。

此方法在页面中查找匹配指定 selector 的元素。如果没有元素匹配 selector，则返回值解析为 null。要在页面上等待元素，请使用 Locator.waitFor()。

用法

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

参数

  • selector 字符串 (String)#

    要查询的 selector。

  • options Page.QuerySelectorOptions （可选）

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

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

返回值

querySelectorAll​

新增于: v1.9 page.querySelectorAll
不推荐

请改用基于 locator 的 Page.locator()。阅读更多关于 locators 的信息。

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

用法

Page.querySelectorAll(selector);

参数

返回值

selectOption​

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

请改用基于 locator 的 Locator.selectOption()。阅读更多关于 locators 的信息。

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

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

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

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

用法

// Single selection matching the value or label
page.selectOption("select#colors", "blue");
// single selection matching 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)#

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

  • values 空值 (null) | 字符串 (String) | ElementHandle | 字符串 (String)[] | SelectOption | ElementHandle[] | SelectOption[]#

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

  • options Page.SelectOptionOptions （可选）

返回值

setChecked​

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

请改用基于 locator 的 Locator.setChecked()。阅读更多关于 locators 的信息。

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

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

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

用法

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

参数

  • selector 字符串 (String)#

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

  • checked 布尔值 (boolean)#

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

  • options Page.SetCheckedOptions （可选）

返回值

setInputFiles​

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

请改用基于 locator 的 Locator.setInputFiles()。阅读更多关于 locators 的信息。

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

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

用法

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

参数

返回值

tap​

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

请改用基于 locator 的 Locator.tap()。阅读更多关于 locators 的信息。

此方法通过执行以下步骤来轻触（tap）匹配 selector 的元素：

  1. 查找匹配 selector 的元素。如果不存在，则等待直到找到匹配的元素并附加到 DOM 中。
  2. 在匹配的元素上等待 actionability 检查，除非设置了 setForce 选项。如果在检查期间元素被分离，则整个操作会重试。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.touchscreen() 轻触元素的中心，或指定的 setPosition。

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

注意

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

用法

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

参数

  • selector 字符串 (String)#

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

  • 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 (可选)Added in: v1.11#

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

返回值

textContent​

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

请改用基于 locator 的 Locator.textContent()。阅读更多关于 locators 的信息。

返回 element.textContent。

用法

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

参数

  • selector 字符串 (String)#

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

  • options Page.TextContentOptions （可选）

返回值

type​

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

在大多数情况下，应使用 Locator.fill()。只有在页面有特殊的键盘处理时，才需要一个一个地按键 - 在这种情况下，请使用 Locator.pressSequentially()。

为文本中的每个字符发送一个 keydown、keypress/input 和 keyup 事件。page.type 可用于发送精细的键盘事件。要在表单字段中填写值，请使用 Page.fill()。

要按下特殊键，如 Control 或 ArrowDown，请使用 Keyboard.press()。

用法

参数

返回值

uncheck​

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

请改用基于 locator 的 Locator.uncheck()。阅读更多关于 locators 的信息。

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

  1. 查找匹配 selector 的元素。如果不存在，则等待直到找到匹配的元素并附加到 DOM 中。
  2. 确保匹配的元素是复选框或单选输入。如果不是，则此方法抛出错误。如果元素已经未选中，则此方法立即返回。
  3. 在匹配的元素上等待 actionability 检查，除非设置了 setForce 选项。如果在检查期间元素被分离，则整个操作会重试。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 Page.mouse() 点击元素的中心。
  6. 确保元素现在已取消选中。如果不是，则此方法抛出错误。

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

用法

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

参数

  • selector 字符串 (String)#

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

  • options Page.UncheckOptions （可选）

    • setForce 布尔值 (boolean) （可选）#

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

    • setNoWaitAfter 布尔值 (boolean) （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position (可选)Added in: v1.11#

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

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

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

    • setTimeout 双精度浮点数 (double) （可选）#

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

    • setTrial boolean (可选)Added in: v1.11#

      设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备就绪以便进行操作而无需实际执行操作时很有用。

返回值

waitForNavigation​

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

此方法存在固有的竞态条件，请改用 Page.waitForURL()。

等待主 frame 导航并返回主资源响应。在多次重定向的情况下，导航将解析为最后一次重定向的响应。如果导航到不同的锚点或由于 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)> （可选）#

      glob 模式、regex 模式或接收 [URL] 的 predicate，用于在等待导航时匹配。注意，如果参数是不带通配符的字符串，则该方法将等待导航到与该字符串完全相等的 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
不推荐

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

当由选择器指定的元素满足 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#

    要查询的 selector。

  • 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 断言。

等待给定的以毫秒为单位的 超时。

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

用法

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

参数

  • timeout double#

    要等待的超时时间

返回值