跳至主要内容

操作

简介​

Playwright 可以与 HTML 输入元素进行交互，例如文本输入、复选框、单选按钮、选择选项、鼠标点击、输入字符、按键和快捷键，以及上传文件和聚焦元素。

文本输入​

使用 Locator.fill() 是填写表单字段的最简单方法。它会聚焦元素并触发带有输入文本的 input 事件。它适用于 <input>、<textarea> 和 [contenteditable] 元素。

// Text input
page.getByRole(AriaRole.TEXTBOX).fill("Peter");

// Date input
page.getByLabel("Birth date").fill("2020-02-02");

// Time input
page.getByLabel("Appointment time").fill("13-15");

// Local datetime input
page.getByLabel("Local time").fill("2020-03-02T05:15");

复选框和单选按钮​

使用 Locator.setChecked() 是选中和取消选中复选框或单选按钮的最简单方法。此方法可用于 input[type=checkbox]、input[type=radio] 和 [role=checkbox] 元素。

// Check the checkbox
page.getByLabel("I agree to the terms above").check();

// Assert the checked state
assertTrue(page.getByLabel("Subscribe to newsletter")).isChecked();

// Select the radio button
page.getByLabel("XL").check();

选择选项​

使用 Locator.selectOption() 在 <select> 元素中选择一个或多个选项。你可以指定选项 value 或 label 进行选择。可以选中多个选项。

// Single selection matching the value or label
page.getByLabel("Choose a color").selectOption("blue");

// Single selection matching the label
page.getByLabel("Choose a color").selectOption(new SelectOption().setLabel("Blue"));

// Multiple selected items
page.getByLabel("Choose multiple colors").selectOption(new String[] {"red", "green", "blue"});

鼠标点击​

执行简单的鼠标点击。

// Generic click
page.getByRole(AriaRole.BUTTON).click();

// Double click
page.getByText("Item").dblclick();

// Right click
page.getByText("Item").click(new Locator.ClickOptions().setButton(MouseButton.RIGHT));

// Shift + click
page.getByText("Item").click(new Locator.ClickOptions().setModifiers(Arrays.asList(KeyboardModifier.SHIFT)));

// Ctrl + click or Windows and Linux
// Meta + click on macOS
page.getByText("Item").click(new Locator.ClickOptions().setModifiers(Arrays.asList(KeyboardModifier.CONTROL_OR_META)));

// Hover over element
page.getByText("Item").hover();

// Click the top left corner
page.getByText("Item").click(new Locator.ClickOptions().setPosition(0, 0));

在内部，此方法和其他与指针相关的操作会

  • 等待具有指定选择器的元素出现在 DOM 中
  • 等待它显示，即不为空，没有 display:none，没有 visibility:hidden
  • 等待它停止移动，例如，直到 CSS 过渡完成
  • 滚动元素到视图中
  • 等待它在操作点接收指针事件，例如，等待元素不再被其他元素遮挡
  • 如果元素在上述任何检查过程中被分离，则重试

强制点击​

有时，应用程序会使用非平凡的逻辑，其中将鼠标悬停在元素上会用另一个元素覆盖它，该元素会拦截点击。这种行为与元素被覆盖并将点击分派到其他地方的错误无法区分。如果你知道正在发生这种情况，你可以绕过 可操作性 检查并强制点击

page.getByRole(AriaRole.BUTTON).click(new Locator.ClickOptions().setForce(true));

编程点击​

如果你对在真实条件下测试你的应用程序不感兴趣，并且希望通过任何可能的方式模拟点击，你可以通过在元素上简单地分派点击事件来触发 HTMLElement.click() 行为，使用 Locator.dispatchEvent()

page.getByRole(AriaRole.BUTTON).dispatchEvent("click");

输入字符​

警告

大多数情况下，你应该使用 Locator.fill() 输入文本。请参阅上面的 文本输入 部分。只有在页面上存在特殊键盘处理时，才需要输入字符。

使用 Locator.pressSequentially() 在字段中逐个字符地输入，就像使用带有真实键盘的用户一样。

// Press keys one by one
page.locator("#area").pressSequentially("Hello World!");

此方法会发出所有必要的键盘事件，包括所有 keydown、keyup、keypress 事件。你甚至可以指定按键之间的可选 delay，以模拟真实用户的行为。

按键和快捷键​

// Hit Enter
page.getByText("Submit").press("Enter");

// Dispatch Control+Right
page.getByRole(AriaRole.TEXTBOX).press("Control+ArrowRight");

// Press $ sign on keyboard
page.getByRole(AriaRole.TEXTBOX).press("$");

Locator.press() 方法会聚焦选定的元素并产生一个按键。它接受在 keyboardEvent.key 的键盘事件属性中发出的逻辑键名。

Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape,
ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight,
ArrowUp, F1 - F12, Digit0 - Digit9, KeyA - KeyZ, etc.
  • 你也可以选择指定你想要产生的单个字符，例如 "a" 或 "#"。
  • 还支持以下修改快捷键：Shift、Control、Alt、Meta。

简单版本会产生一个字符。此字符区分大小写，因此 "a" 和 "A" 会产生不同的结果。

// <input id=name>
page.locator("#name").press("Shift+A");

// <input id=name>
page.locator("#name").press("Shift+ArrowLeft");

也支持 "Control+o" 或 "Control+Shift+T" 等快捷键。当与修饰符一起指定时，修饰符会被按下并保持按住状态，同时按下后续键。

请注意，你仍然需要在 Shift-A 中指定大写 A 才能产生大写字符。Shift-a 会产生小写字符，就好像你打开了 CapsLock 一样。

上传文件​

你可以使用 Locator.setInputFiles() 方法选择要上传的输入文件。它期望第一个参数指向类型为 "file" 的 输入元素。可以将多个文件传递到数组中。如果某些文件路径是相对路径，则会相对于当前工作目录解析它们。空数组会清除所选文件。

// Select one file
page.getByLabel("Upload file").setInputFiles(Paths.get("myfile.pdf"));

// Select multiple files
page.getByLabel("Upload files").setInputFiles(new Path[] {Paths.get("file1.txt"), Paths.get("file2.txt")});

// Select a directory
page.getByLabel("Upload directory").setInputFiles(Paths.get("mydir"));

// Remove all the selected files
page.getByLabel("Upload file").setInputFiles(new Path[0]);

// Upload buffer from memory
page.getByLabel("Upload file").setInputFiles(new FilePayload(
  "file.txt", "text/plain", "this is test".getBytes(StandardCharsets.UTF_8)));

如果你没有输入元素（它是动态创建的），你可以处理 Page.onFileChooser(handler) 事件，或者在操作后使用相应的等待方法。

FileChooser fileChooser = page.waitForFileChooser(() -> {
  page.getByLabel("Upload file").click();
});
fileChooser.setFiles(Paths.get("myfile.pdf"));

聚焦元素​

对于处理聚焦事件的动态页面，你可以使用 Locator.focus() 聚焦给定元素。

page.getByLabel("Password").focus();

拖放​

你可以使用 Locator.dragTo() 执行拖放操作。此方法会

  • 将鼠标悬停在将要拖动的元素上。
  • 按下鼠标左键。
  • 将鼠标移动到将接收拖放的元素。
  • 释放鼠标左键。
page.locator("#item-to-be-dragged").dragTo(page.locator("#item-to-drop-at"));

手动拖动​

如果你想要精确控制拖动操作，请使用更低级别的操作，例如 Locator.hover()、Mouse.down()、Mouse.move() 和 Mouse.up().

page.locator("#item-to-be-dragged").hover();
page.mouse().down();
page.locator("#item-to-drop-at").hover();
page.mouse().up();
注意

如果你的页面依赖于 dragover 事件的分派，则至少需要两次鼠标移动才能在所有浏览器中触发它。为了可靠地发出第二次鼠标移动，请重复你的 Mouse.move() 或 Locator.hover() 两次。操作顺序将是：将鼠标悬停在拖动元素上，按下鼠标左键，将鼠标悬停在拖放元素上，再次将鼠标悬停在拖放元素上，释放鼠标左键。

滚动​

大多数情况下，Playwright 会在执行任何操作之前自动为你滚动。因此，你不需要显式滚动。

// Scrolls automatically so that button is visible
page.getByRole(AriaRole.BUTTON).click();

但是，在极少数情况下，你可能需要手动滚动。例如，你可能想要强制“无限列表”加载更多元素，或者为特定屏幕截图定位页面。在这种情况下，最可靠的方法是找到你想在底部使其可见的元素，并将其滚动到视图中。

// Scroll the footer into view, forcing an "infinite list" to load more content
page.getByText("Footer text").scrollIntoViewIfNeeded();

如果你想要更精确地控制滚动，请使用 Mouse.wheel() 或 Locator.evaluate()

// Position the mouse and scroll with the mouse wheel
page.getByTestId("scrolling-container").hover();
page.mouse.wheel(0, 10);

// Alternatively, programmatically scroll a specific element
page.getByTestId("scrolling-container").evaluate("e => e.scrollTop += 100");