跳至主要内容

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.goto("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.goto("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.goto("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

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

用法

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

参数

  • options Page.AddScriptTagOptions （可选）

    • setContent String （可选）#

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

    • setPath Path （可选）#

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

    • setType String （可选）#

      脚本类型。使用“模块”以加载 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，则不运行任何卸载处理程序并等待页面关闭。如果setRunBeforeUnload为true，则该方法将运行卸载处理程序，但**不会**等待页面关闭。

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

注意

如果将setRunBeforeUnload传递为 true，则可能会出现beforeunload对话框，应通过Page.onDialog(handler)事件手动处理。

用法

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

参数

  • options Page.CloseOptions (可选)

    • setReason String (可选)新增于：v1.40#

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

    • setRunBeforeUnload boolean (可选)#

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

返回值

content​

在 v1.9 之前添加 page.content

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

用法

Page.content();

返回值

context​

在 v1.9 之前添加 page.context

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

用法

Page.context();

返回值

dragAndDrop​

新增于：v1.13 page.dragAndDrop

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

用法

page.dragAndDrop("#source", '#target');
// 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 (可选)#

      是否绕过actionability检查。默认为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 (可选)#

      设置后，此方法仅执行actionability检查并跳过操作。默认为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
page.evaluate("() => matchMedia('(prefers-color-scheme: no-preference)').matches");
// → false

参数

  • options Page.EmulateMediaOptions (可选)

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

      模拟'prefers-colors-scheme'媒体功能，支持的值为'light'、'dark'、'no-preference'。传递null禁用颜色方案模拟。

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

      模拟'forced-colors'媒体功能，支持的值为'active'和'none'。传递null禁用强制颜色模拟。

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

      更改页面的 CSS 媒体类型。唯一允许的值是'screen'、'print'和null。传递null禁用 CSS 媒体模拟。

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

      模拟'prefers-reduced-motion'媒体功能，支持的值为'reduce'、'no-preference'。传递null禁用减少运动模拟。

返回值

evaluate​

在 v1.9 之前添加 page.evaluate

返回expression调用的值。

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

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

用法

将参数传递给expression

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

将 expression 调用的值作为 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 String#

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

  • arg EvaluationArgument （可选）#

    传递给 expression 的可选参数。

返回值

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({ headless: 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 并返回一个 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({ headless: false });
      Page page = browser.newPage();
      page.exposeFunction("sha256", args -> {
        String text = (String) args[0];
        MessageDigest crypto;
        try {
          crypto = MessageDigest.getInstance("SHA-256");
        } catch (NoSuchAlgorithmException e) {
          return null;
        }
        byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));
        return Base64.getEncoder().encodeToString(token);
      });
      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>\n");
      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 时，您可以创建一个框架定位器，它将进入 iframe 并允许在该 iframe 中选择元素。

用法

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

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

参数

  • selector String#

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

返回值

frames​

在 v1.9 之前添加 page.frames

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

用法

Page.frames();

返回值

getByAltText​

新增于：v1.27 page.getByAltText

允许根据替代文本定位元素。

用法

例如，此方法将根据替代文本“Playwright 徽标”查找图像

<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 中根据标签“用户名”和“密码”查找输入

<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="[email protected]" />

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

page.getByPlaceholder("[email protected]").fill("[email protected]");

参数

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

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

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

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

了解有关定位器的更多信息.

用法

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

参数

  • selector String#

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

  • options Page.LocatorOptions (可选)

    • setHas Locator (可选)#

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

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

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

    • setHasNot Locator (可选)新增于：v1.33#

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

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

    • setHasNotText String | Pattern (可选)新增于：v1.33#

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

    • setHasText String | Pattern (可选)#

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

返回值

mainFrame​

在 v1.9 之前添加 page.mainFrame

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

用法

Page.mainFrame();

返回值

navigate​

在 v1.9 之前添加 page.navigate

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

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

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

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

注意

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

注意

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

用法

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

参数

  • url String#

    要导航到的页面的 URL。url 应包含方案，例如https://。当通过上下文选项提供了setBaseURL并且传递的 URL 是路径时，它将通过new URL()构造函数合并。

  • options Page.NavigateOptions (可选)

    • setReferer String (可选)#

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

    • setTimeout double (可选)#

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

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (可选)#

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

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

返回值

onceDialog​

新增于：v1.10 page.onceDialog

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

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

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

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

用法

Page.opener();

返回值

暂停​

新增于：v1.9 page.pause

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

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

注意

此方法要求 Playwright 以有头模式启动，并使用虚假 setHeadless 选项。

用法

Page.pause();

返回值

PDF​

在 v1.9 之前添加 page.pdf

返回 PDF 缓冲区。

注意

目前仅在 Chromium 无头模式下支持生成 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 (可选)#

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

返回值

重新加载​

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

返回值

移除定位器处理程序​

新增于：v1.44 page.removeLocatorHandler

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

用法

Page.removeLocatorHandler(locator);

参数

返回值

请求垃圾回收​

新增于：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();

返回值

路由​

在 v1.9 之前添加 page.route

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

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

注意

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

注意

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

注意

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

用法

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

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

或者使用正则表达式模式的相同代码段

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

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

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

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

要删除带有其处理程序的路由，可以使用 Page.unroute()。

注意

启用路由会禁用 HTTP 缓存。

参数

  • url String | Pattern | Predicate<String>#

    一个 glob 模式、正则表达式模式或接收 [URL] 以匹配的谓词，用于路由。当通过上下文选项提供 setBaseURL 且传递的 URL 是路径时，它将通过 new URL() 构造函数合并。

  • handler Consumer<Route>#

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

  • options Page.RouteOptions (可选)

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

      路由应使用的频率。默认情况下，它将在每次使用。

返回值

routeFromHAR​

新增于：v1.23 page.routeFromHAR

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

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

用法

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

参数

  • har Path#

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

  • options Page.RouteFromHAROptions (可选)

    • setNotFound enum HarNotFound { ABORT, FALLBACK } (可选)#

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

      默认为中止。

    • setUpdate boolean (可选)#

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

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

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

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

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

    • setUrl String | Pattern (可选)#

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

返回值

routeWebSocket​

新增于：v1.48 page.routeWebSocket

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

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

用法

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

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

参数

返回值

screenshot​

在 v1.9 之前添加 page.screenshot

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

用法

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

参数

  • options Page.ScreenshotOptions (可选)

    • setAnimations enum ScreenshotAnimations { DISABLED, ALLOW } (可选)#

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

      • 有限动画被快速转发到完成，因此它们将触发 transitionend 事件。
      • 无限动画被取消到初始状态，然后在屏幕截图后播放。

      默认为 "allow"，它保持动画不变。

    • setCaret enum ScreenshotCaret { HIDE, INITIAL } (可选)#

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

    • setClip Clip (可选)#

      • setX double

        剪裁区域左上角的 x 坐标

      • setY double

        剪裁区域左上角的 y 坐标

      • setWidth double

        剪裁区域的宽度

      • setHeight double

        剪裁区域的高度

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

    • setFullPage boolean (可选)#

      如果为真，则获取整个可滚动页面的屏幕截图，而不是当前可见的视口。默认为 false。

    • setMask List<Locator> (可选)#

      指定在拍摄屏幕截图时应屏蔽的定位器。屏蔽元素将覆盖一个完全覆盖其边界框的粉红色框 #FF00FF（由 setMaskColor 自定义）。

    • setMaskColor String (可选)新增于：v1.35#

      以 CSS 颜色格式 指定屏蔽元素的覆盖框的颜色。默认颜色为粉红色 #FF00FF。

    • setOmitBackground boolean (可选)#

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

    • setPath 路径 (可选)#

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

    • setQuality 整数 (可选)#

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

    • setScale 枚举 ScreenshotScale { CSS, DEVICE } (可选)#

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

      默认为 "device"。

    • setStyle 字符串 (可选)新增于：v1.41#

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

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

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

    • setType 枚举 ScreenshotType { PNG, JPEG } (可选)#

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

返回值

setContent​

在 v1.9 之前添加 page.setContent

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

用法

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

参数

  • html 字符串#

    要分配给页面的 HTML 标记。

  • options Page.SetContentOptions (可选)

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

返回值

setDefaultNavigationTimeout​

在 v1.9 之前添加 page.setDefaultNavigationTimeout

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

注意

Page.setDefaultNavigationTimeout() 优先于 Page.setDefaultTimeout()、BrowserContext.setDefaultTimeout() 和 BrowserContext.setDefaultNavigationTimeout()。

用法

Page.setDefaultNavigationTimeout(timeout);

参数

setDefaultTimeout​

在 v1.9 之前添加 page.setDefaultTimeout

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

注意

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

用法

Page.setDefaultTimeout(timeout);

参数

setExtraHTTPHeaders​

在 v1.9 之前添加 page.setExtraHTTPHeaders

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

注意

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

用法

Page.setExtraHTTPHeaders(headers);

参数

  • headers 映射<字符串, 字符串>#

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

返回值

setViewportSize​

在 v1.9 之前添加 page.setViewportSize

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

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

用法

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

参数

  • width 整数新增于：v1.10#

    以像素为单位的页面宽度。

  • height 整数新增于：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);

参数

返回值

unrouteAll​

新增于：v1.41 page.unrouteAll

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

用法

Page.unrouteAll();

返回值

url​

在 v1.9 之前添加 page.url

用法

Page.url();

返回值

video​

在 v1.9 之前添加 page.video

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

用法

Page.video();

返回值

viewportSize​

在 v1.9 之前添加 page.viewportSize

用法

Page.viewportSize();

返回值

  • 空 | ViewportSize#

    • width 整数

      以像素为单位的页面宽度。

    • height 整数

      以像素为单位的页面高度。

waitForClose​

新增于：v1.11 page.waitForClose

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

用法

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

参数

  • options Page.WaitForCloseOptions (可选)

  • callback 运行新增于：v1.9#

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

返回值

waitForCondition​

新增于：v1.32 page.waitForCondition

该方法会阻塞，直到条件返回 true。在方法等待条件期间，所有 Playwright 事件都会被分派。

用法

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

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

参数

返回值

waitForConsoleMessage​

新增于：v1.9 page.waitForConsoleMessage

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

用法

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

参数

返回值

waitForDownload​

新增于：v1.9 page.waitForDownload

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

用法

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

参数

  • options Page.WaitForDownloadOptions (可选)

  • callback Runnable#

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

返回值

waitForFileChooser​

新增于：v1.9 page.waitForFileChooser

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

用法

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

参数

  • options Page.WaitForFileChooserOptions (可选)

  • callback Runnable#

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

返回值

waitForFunction​

在 v1.9 之前添加 page.waitForFunction

当 表达式 返回真值时返回。它解析为真值的 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 (可选)#

    可选参数，传递给 表达式。

  • options Page.WaitForFunctionOptions (可选)

    • setPollingInterval double (可选)#

      如果指定，则将其视为以毫秒为单位的间隔，在此间隔内将执行函数。默认情况下，如果未指定该选项，则 表达式 将在 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。如果提供了谓词，则将 [Popup] 值传递到 predicate 函数中，并等待 predicate(page) 返回真值。如果在触发弹出窗口事件之前页面关闭，则会抛出错误。

用法

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

参数

  • options Page.WaitForPopupOptions (可选)

  • callback Runnable#

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

返回值

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 字符串 | 模式 | Predicate<请求>#

    请求 URL 字符串、正则表达式或接收请求对象的谓词。当通过上下文选项提供了setBaseURL并且传递的 URL 是路径时，它将通过new URL()构造函数合并。

  • options Page.WaitForRequestOptions (可选)

  • callback 运行新增于：v1.9#

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

返回值

waitForRequestFinished​

新增于：v1.12 page.waitForRequestFinished

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

用法

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

参数

  • options Page.WaitForRequestFinishedOptions (可选)

  • callback Runnable#

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

返回值

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

参数

返回值

waitForURL​

新增于：v1.11 page.waitForURL

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

用法

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

参数

  • url 字符串 | 模式 | Predicate<字符串>#

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

  • options Page.WaitForURLOptions (可选)

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

返回值

waitForWebSocket​

新增于：v1.9 page.waitForWebSocket

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

用法

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

参数

返回值

waitForWorker​

新增于：v1.9 page.waitForWorker

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

用法

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

参数

返回值

workers​

在 v1.9 之前添加 page.workers

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

注意

这并不包含 ServiceWorkers

用法

Page.workers();

返回值

属性​

clock()​

新增于：v1.45 page.clock()

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

用法

Page.clock()

返回值

keyboard()​

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

用法

Page.keyboard()

返回值

mouse()​

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

用法

Page.mouse()

返回值

request()​

新增于：v1.16 page.request()

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

用法

Page.request()

返回值

touchscreen()​

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

用法

Page.touchscreen()

返回值

事件​

onClose(handler)​

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

页面关闭时发出。

用法

Page.onClose(handler)

事件数据

onConsoleMessage(handler)​

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

当页面内的 JavaScript 调用其中一个控制台 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)

事件数据

onDialog(handler)​

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

当 JavaScript 对话框出现时发出，例如 alert、prompt、confirm 或 beforeunload。监听器**必须**接受或拒绝对话框 - 否则页面将冻结，等待对话框，并且点击等操作将永远无法完成。

用法

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

当没有 Page.onDialog(handler) 或 BrowserContext.onDialog(handler) 监听器存在时，所有对话框都会自动被拒绝。

事件数据

onDOMContentLoaded(handler)​

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

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

用法

Page.onDOMContentLoaded(handler)

事件数据

onDownload(handler)​

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

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

用法

Page.onDownload(handler)

事件数据

onFileChooser(handler)​

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

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

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

用法

Page.onFileChooser(handler)

事件数据

onFrameAttached(handler)​

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

附加框架时发出。

用法

Page.onFrameAttached(handler)

事件数据

onFrameDetached(handler)​

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

分离框架时发出。

用法

Page.onFrameDetached(handler)

事件数据

onFrameNavigated(handler)​

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

框架导航到新 URL 时发出。

用法

Page.onFrameNavigated(handler)

事件数据

onLoad(handler)​

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

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

用法

Page.onLoad(handler)

事件数据

onPageError(handler)​

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

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

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

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

用法

Page.onRequest(handler)

事件数据

onRequestFailed(handler)​

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

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

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

HTTP 错误响应（例如 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)

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

用法

Page.onResponse(handler)

事件数据

onWebSocket(handler)​

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

发送 WebSocket 请求时发出。

用法

Page.onWebSocket(handler)

事件数据

onWorker(handler)​

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

页面生成专用 WebWorker 时发出。

用法

Page.onWorker(handler)

事件数据

已弃用​

check​

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

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

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

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

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

用法

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

参数

  • selector String#

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

  • options Page.CheckOptions （可选）

    • setForce boolean （可选）#

      是否绕过actionability检查。默认为false。

    • setNoWaitAfter boolean （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position （可选）新增于：v1.11#

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

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

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

    • setTimeout double （可选）#

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

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

      设置后，此方法仅执行actionability检查并跳过操作。默认为false。用于在执行操作之前等待元素准备就绪。

返回值

click​

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

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

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

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

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

用法

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

参数

  • selector String#

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

  • options Page.ClickOptions （可选）

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } （可选）#

      默认为 left。

    • setClickCount int （可选）#

      默认为 1。参见 UIEvent.detail。

    • setDelay double （可选）#

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

    • setForce boolean （可选）#

      是否绕过actionability检查。默认为false。

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

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

    • setNoWaitAfter boolean （可选）#

      已弃用

      此选项将来将默认为 true。

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

    • setPosition Position （可选）#

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

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

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

    • setTimeout double （可选）#

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

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

      如果设置，此方法仅执行 actionability 检查并跳过操作。默认为 false。可用于等待元素准备好执行操作而无需执行它。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

dblclick​

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

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

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

  1. 查找与 selector 匹配的元素。如果没有，请等待匹配的元素附加到 DOM。
  2. 等待匹配元素上的 actionability 检查，除非设置了 setForce 选项。如果在检查期间元素已分离，则会重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.mouse() 在元素的中心或指定的 setPosition 位置双击。

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

注意

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

用法

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

参数

  • selector String#

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

  • options Page.DblclickOptions （可选）

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } （可选）#

      默认为 left。

    • setDelay double （可选）#

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

    • setForce boolean （可选）#

      是否绕过actionability检查。默认为false。

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

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

    • setNoWaitAfter boolean （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position （可选）#

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

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

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

    • setTimeout double （可选）#

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

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

      如果设置，此方法仅执行 actionability 检查并跳过操作。默认为 false。可用于等待元素准备好执行操作而无需执行它。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

dispatchEvent​

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

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

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

用法

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

在后台，它会根据给定的 type 创建一个事件实例，使用 eventInit 属性对其进行初始化，并在元素上分派它。事件默认情况下为 composed、cancelable 并冒泡。

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

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

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

返回值

evalOnSelector​

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

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

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

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

用法

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

参数

  • selector String#

    要查询的选择器。

  • expression String#

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

  • arg EvaluationArgument （可选）#

    要传递给 expression 的可选参数。

  • options Page.EvalOnSelectorOptions （可选）

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

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

返回值

evalOnSelectorAll​

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

在大多数情况下，Locator.evaluateAll()、其他 Locator 辅助方法和以 Web 为中心的断言可以更好地完成工作。

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

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

用法

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

参数

  • selector 字符串#

    要查询的选择器。

  • expression 字符串#

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

  • arg EvaluationArgument (可选)#

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

返回值

fill​

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

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

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

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

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

用法

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

参数

  • selector 字符串#

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

  • value 字符串#

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

  • options Page.FillOptions (可选)

返回值

focus​

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

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

此方法使用选择器获取元素并将其聚焦。如果没有与选择器匹配的元素，则该方法将等待直到DOM中出现匹配的元素。

用法

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

参数

  • selector 字符串#

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

  • options Page.FocusOptions (可选)

返回值

getAttribute​

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

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

返回元素属性值。

用法

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

参数

  • selector 字符串#

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

  • name 字符串#

    要获取其值的属性名称。

  • options Page.GetAttributeOptions (可选)

返回值

hover​

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

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

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

  1. 查找与选择器匹配的元素。如果没有，请等待将匹配的元素附加到DOM。
  2. 等待匹配元素上的可操作性检查，除非设置了setForce选项。如果元素在检查期间分离，则整个操作将重试。
  3. 如果需要，将元素滚动到视图中。
  4. 使用Page.mouse()将鼠标悬停在元素的中心或指定的setPosition上。

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

用法

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

参数

  • selector 字符串#

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

  • options Page.HoverOptions (可选)

    • setForce 布尔值 (可选)#

      是否绕过actionability检查。默认为false。

    • setModifiers 列表<枚举 KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#

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

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

      已弃用

      此选项无效。

      此选项无效。

    • setPosition 位置 (可选)#

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

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

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

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

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

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

      如果设置，此方法仅执行 actionability 检查并跳过操作。默认为 false。可用于等待元素准备好执行操作而无需执行它。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

innerHTML​

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

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

返回element.innerHTML。

用法

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

参数

  • selector 字符串#

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

  • options Page.InnerHTMLOptions (可选)

返回值

innerText​

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

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

返回element.innerText。

用法

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

参数

  • selector 字符串#

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

  • options Page.InnerTextOptions (可选)

返回值

inputValue​

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

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options Page.InputValueOptions (可选)

返回值

isChecked​

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options Page.IsCheckedOptions (可选)

返回值

isDisabled​

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options Page.IsDisabledOptions (可选)

返回值

isEditable​

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

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

返回元素是否 可编辑。

用法

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

参数

  • selector 字符串#

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

  • options Page.IsEditableOptions (可选)

返回值

isEnabled​

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

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

返回元素是否 启用。

用法

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

参数

  • selector 字符串#

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

  • options Page.IsEnabledOptions (可选)

返回值

isHidden​

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

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

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

用法

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

参数

  • selector 字符串#

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

  • options Page.IsHiddenOptions (可选)

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

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

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

      已弃用

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

返回值

isVisible​

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

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

返回元素是否 可见。与任何元素都不匹配的 选择器 被视为不可见。

用法

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

参数

  • selector 字符串#

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

  • options Page.IsVisibleOptions (可选)

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

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

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

      已弃用

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

返回值

press​

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

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

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

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

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

以下修改快捷方式也受支持：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

按住 Shift 将以大写形式键入与 key 对应的文本。

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

也支持诸如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 之类的快捷方式。当与修饰符一起指定时，修饰符会被按下并保持按住状态，同时按下后续键。

用法

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

参数

  • selector 字符串#

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

  • key 字符串#

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

  • options Page.PressOptions (可选)

    • setDelay 双精度浮点数 (可选)#

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

    • setNoWaitAfter 布尔值 (可选)#

      已弃用

      此选项将来将默认为 true。

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

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

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

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

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

返回值

querySelector​

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

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

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

用法

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

参数

  • selector 字符串#

    要查询的选择器。

  • options Page.QuerySelectorOptions (可选)

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

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

返回值

querySelectorAll​

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

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

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

用法

Page.querySelectorAll(selector);

参数

返回值

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

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

  • values null | 字符串 | ElementHandle | 字符串[] | SelectOption | ElementHandle[] | SelectOption[]#

    • setValue 字符串 （可选）

      按 option.value 匹配。可选。

    • setLabel 字符串 （可选）

      按 option.label 匹配。可选。

    • setIndex 整数 （可选）

      按索引匹配。可选。

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

  • options Page.SelectOptionOptions （可选）

    • setForce 布尔值 (可选)新增于：v1.13#

      是否绕过actionability检查。默认为false。

    • setNoWaitAfter 布尔值 （可选）#

      已弃用

      此选项无效。

      此选项无效。

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

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

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

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

返回值

setChecked​

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

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

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

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

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

用法

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

参数

  • selector 字符串#

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

  • checked 布尔值#

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

  • options Page.SetCheckedOptions （可选）

    • setForce 布尔值 （可选）#

      是否绕过actionability检查。默认为false。

    • setNoWaitAfter 布尔值 （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position （可选）#

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

    • setStrict 布尔值 （可选）#

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

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

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

    • setTrial 布尔值 （可选）#

      设置后，此方法仅执行actionability检查并跳过操作。默认为false。用于在执行操作之前等待元素准备就绪。

返回值

setInputFiles​

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

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

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

此方法期望 选择器 指向 输入元素。但是，如果元素位于具有关联 控件 的 <label> 元素内，则会改为定位该控件。

用法

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

参数

  • selector 字符串#

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

  • files 路径 | 路径[] | FilePayload | FilePayload[]#

  • options Page.SetInputFilesOptions （可选）

    • setNoWaitAfter 布尔值 （可选）#

      已弃用

      此选项无效。

      此选项无效。

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

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

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

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

返回值

tap​

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

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

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

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

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

注意

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

用法

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

参数

  • selector 字符串#

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

  • options Page.TapOptions （可选）

    • setForce 布尔值 （可选）#

      是否绕过actionability检查。默认为false。

    • setModifiers 列表<枚举 KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> （可选）#

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

    • setNoWaitAfter 布尔值 （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position （可选）#

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

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

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

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

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

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

      如果设置，此方法仅执行 actionability 检查并跳过操作。默认为 false。可用于等待元素准备好执行操作而无需执行它。请注意，无论 trial 如何，键盘 modifiers 都将被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

textContent​

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

请使用基于定位器的 Locator.textContent() 方法代替。了解更多关于 定位器 的信息。

返回 element.textContent。

用法

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

参数

  • selector String#

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

  • options Page.TextContentOptions (可选)

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

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

    • setTimeout double (可选)#

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

返回值

type​

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

在大多数情况下，您应该使用 Locator.fill() 方法代替。只有当页面上存在特殊的键盘处理时，您才需要逐个按键，在这种情况下，请使用 Locator.pressSequentially()。

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

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

用法

参数

  • selector String#

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

  • text String#

    要输入到聚焦元素中的文本。

  • options Page.TypeOptions (可选)

    • setDelay double (可选)#

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

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

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

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

    • setTimeout double (可选)#

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

返回值

uncheck​

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

请使用基于定位器的 Locator.uncheck() 方法代替。了解更多关于 定位器 的信息。

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

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

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

用法

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

参数

  • selector String#

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

  • options Page.UncheckOptions (可选)

    • setForce boolean (可选)#

      是否绕过actionability检查。默认为false。

    • setNoWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • setPosition Position （可选）新增于：v1.11#

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

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

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

    • setTimeout double (可选)#

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

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

      设置后，此方法仅执行actionability检查并跳过操作。默认为false。用于在执行操作之前等待元素准备就绪。

返回值

waitForNavigation​

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

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

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (可选)#

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

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

  • callback 运行新增于：v1.9#

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

返回值

waitForSelector​

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

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

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

注意

Playwright 会自动等待元素准备好，然后再执行操作。使用 Locator 对象和 Web-first 断言可以使代码无需使用 waitForSelector。

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

用法

此方法可在导航之间使用

import com.microsoft.playwright.*;

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

参数

  • selector String#

    要查询的选择器。

  • options Page.WaitForSelectorOptions (可选)

    • setState enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN } (可选)#

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

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

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

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

    • setTimeout double (可选)#

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

返回值

waitForTimeout​

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

永远不要在生产环境中等待超时。等待时间的测试本质上是易于出错的。请使用 Locator 操作和自动等待的 Web 断言。

等待给定的 timeout（以毫秒为单位）。

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

用法

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

参数

  • timeout double#

    要等待的超时时间

返回值