跳至主要内容

操作

简介​

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

文本输入​

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

// Text input
await page.GetByRole(AriaRole.Textbox).FillAsync("Peter");

// Date input
await page.GetByLabel("Birth date").FillAsync("2020-02-02");

// Time input
await page.GetByLabel("Appointment time").FillAsync("13-15");

// Local datetime input
await page.GetByLabel("Local time").FillAsync("2020-03-02T05:15");

复选框和单选按钮​

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

// Check the checkbox
await page.GetByLabel("I agree to the terms above").CheckAsync();

// Assert the checked state
await Expect(page.GetByLabel("Subscribe to newsletter")).ToBeCheckedAsync();

// Select the radio button
await page.GetByLabel("XL").CheckAsync();

选择选项​

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

// Single selection matching the value or label
await page.GetByLabel("Choose a color").SelectOptionAsync("blue");

// Single selection matching the label
await page.GetByLabel("Choose a color").SelectOptionAsync(new SelectOptionValue { Label = "blue" });

// Multiple selected items
await page.GetByLabel("Choose multiple colors").SelectOptionAsync(new[] { "blue", "green", "red" });

鼠标点击​

执行简单的鼠标点击操作。

// Generic click
await page.GetByRole(AriaRole.Button).ClickAsync();

// Double click
await page.GetByText("Item").DblClickAsync();

// Right click
await page.GetByText("Item").ClickAsync(new() { Button = MouseButton.Right });

// Shift + click
await page.GetByText("Item").ClickAsync(new() { Modifiers = new[] { KeyboardModifier.Shift } });

// Ctrl + click or Windows and Linux
// Meta + click on macOS
await page.GetByText("Item").ClickAsync(new() { Modifiers = new[] { KeyboardModifier.ControlOrMeta } });

// Hover over element
await page.GetByText("Item").HoverAsync();

// Click the top left corner
await page.GetByText("Item").ClickAsync(new() { position = new Position { X = 0, Y = 0 } });

在底层，此方法和其他与指针相关的方法

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

强制点击​

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

await page.GetByRole(AriaRole.Button).ClickAsync(new() { Force = true });

编程点击​

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

await page.GetByRole(AriaRole.Button).DispatchEventAsync("click");

键入字符​

注意

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

使用 Locator.PressSequentiallyAsync() 以字符为单位键入字段，就像使用带有真实键盘的用户一样。

// Press keys one by one
await Page.Locator("#area").PressSequentiallyAsync("Hello World!");

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

按键和快捷键​

// Hit Enter
await page.GetByText("Submit").PressAsync("Enter");

// Dispatch Control+Right
await page.GetByRole(AriaRole.Textbox).PressAsync("Control+ArrowRight");

// Press $ sign on keyboard
await page.GetByRole(AriaRole.Textbox).PressAsync("$");

Locator.PressAsync() 方法聚焦选定的元素并生成单个击键。它接受在键盘事件的 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>
await page.Locator("#name").PressAsync("Shift+A");

// <input id=name>
await page.Locator("#name").PressAsync("Shift+ArrowLeft");

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

请注意，您仍然需要在 Shift-A 中指定大写 A 以生成大写字符。Shift-a 生成小写字符，就像您已切换 CapsLock 一样。

上传文件​

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

// Select one file
await page.GetByLabel("Upload file").SetInputFilesAsync("myfile.pdf");

// Select multiple files
await page.GetByLabel("Upload files").SetInputFilesAsync(new[] { "file1.txt", "file12.txt" });

// Select a directory
await page.GetByLabel("Upload directory").SetInputFilesAsync("mydir");

// Remove all the selected files
await page.GetByLabel("Upload file").SetInputFilesAsync(new[] {});

// Upload buffer from memory
await page.GetByLabel("Upload file").SetInputFilesAsync(new FilePayload
{
    Name = "file.txt",
    MimeType = "text/plain",
    Buffer = System.Text.Encoding.UTF8.GetBytes("this is a test"),
});

如果您没有输入元素（它是动态创建的），则可以处理 Page.FileChooser 事件或在您的操作后使用相应的等待方法

var fileChooser = page.RunAndWaitForFileChooserAsync(async () =>
{
    await page.GetByLabel("Upload file").ClickAsync();
});
await fileChooser.SetFilesAsync("myfile.pdf");

聚焦元素​

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

await page.GetByLabel("Password").FocusAsync();

拖放​

您可以使用 Locator.DragToAsync() 执行拖放操作。此方法将

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

手动拖动​

如果您希望精确控制拖动操作，请使用较低级别的使用方法，例如 Locator.HoverAsync()、Mouse.DownAsync()、Mouse.MoveAsync() 和 Mouse.UpAsync()。

await page.Locator("#item-to-be-dragged").HoverAsync();
await page.Mouse.DownAsync();
await page.Locator("#item-to-drop-at").HoverAsync();
await page.Mouse.UpAsync();
注意

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

滚动​

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

// Scrolls automatically so that button is visible
await page.GetByRole(AriaRole.Button).ClickAsync();

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

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

如果您希望更精确地控制滚动，请使用 Mouse.WheelAsync() 或 Locator.EvaluateAsync()

// Position the mouse and scroll with the mouse wheel
await page.GetByTestId("scrolling-container").HoverAsync();
await page.Mouse.WheelAsync(0, 10);

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