Skip to main content

操作

簡介​

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

選擇選項​

選擇 <select> 元素中的一個或多個選項，使用 Locator.selectOption()。你可以指定選項的 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 過渡完成
  • 滾動元素進入視圖
  • 等待它在動作點接收指標事件，例如，等待元素不再被其他元素遮擋
  • 如果元素在上述任何檢查期間被分離，則重試

強制點擊​

有時，應用程式會使用複雜的邏輯，其中懸停在元素上會覆蓋另一個攔截點擊的元素。這種行為與元素被覆蓋且點擊被分派到其他地方的錯誤無法區分。如果你知道這種情況正在發生，你可以繞過actionability檢查並強制點擊:

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

程式碼點擊​

如果你不想在真實條件下測試你的應用程式，並且想要以任何可能的方式模擬點擊，你可以通過簡單地在元素上分派一個點擊事件來觸發 HTMLElement.click() 行為，使用 Locator.dispatchEvent()：

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

鍵入字元​

caution

大多數情況下，你應該使用 Locator.fill() 輸入文字。請參閱上面的 Text input 部分。只有在頁面上有特殊鍵盤處理時，你才需要輸入字元。

逐字輸入到欄位中，就像使用真實鍵盤的使用者一樣，使用 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("$");

The Locator.press() method focuses the selected element and produces a single keystroke. It accepts the logical key names that are emitted in the keyboardEvent.key property of the keyboard events:

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" 也受到支援。當指定了修飾鍵時，修飾鍵會被按下並保持，同時按下後續的鍵。

請注意，你仍然需要指定大寫的 A 在 Shift-A 中來產生大寫字母。Shift-a 會產生小寫字母，就像你已經切換了 CapsLock 一樣。

上傳檔案​

您可以使用 Locator.setInputFiles() 方法選擇要上傳的輸入檔案。它預期第一個參數指向類型為 "file" 的 input element。多個檔案可以在陣列中傳遞。如果某些檔案路徑是相對的，它們會相對於當前工作目錄解析。空陣列會清除選定的檔案。

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

如果您的頁面依賴於 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");