跳到主要內容

操作

簡介

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> 元素中選取一個或多個選項。您可以指定選項的 valuelabel 來選取。可以選取多個選項。

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

程式化點擊

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

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

輸入字元

注意

大多數時候,您應該使用 Locator.fill() 輸入文字。請參閱上面的文字輸入章節。只有在頁面上有特殊的鍵盤處理時,您才需要輸入字元。

像使用真實鍵盤的使用者一樣,使用 Locator.pressSequentially() 逐個字元地輸入到欄位中。

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

此方法將發出所有必要的鍵盤事件,包括所有 keydownkeyupkeypress 事件。您甚至可以指定按鍵之間的可選 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""#"
  • 也支援以下修改快捷鍵:ShiftControlAltMeta

簡單版本產生單個字元。此字元區分大小寫,因此 "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");