Playwright can interact with HTML Input elements such as text inputs, checkboxes, radio buttons, select options, mouse clicks, type characters, keys and shortcuts as well as upload files and focus elements.
Text inputUsing Locator.fill() is the easiest way to fill out the form fields. It focuses the element and triggers an input event with the entered text. It works for <input>, <textarea> and [contenteditable] elements.
page.getByRole(AriaRole.TEXTBOX).fill("Peter");
page.getByLabel("Birth date").fill("2020-02-02");
page.getByLabel("Appointment time").fill("13-15");
page.getByLabel("Local time").fill("2020-03-02T05:15");
Using Locator.setChecked() is the easiest way to check and uncheck a checkbox or a radio button. This method can be used with input[type=checkbox], input[type=radio] and [role=checkbox] elements.
page.getByLabel("I agree to the terms above").check();
assertTrue(page.getByLabel("Subscribe to newsletter")).isChecked();
page.getByLabel("XL").check();
Selects one or multiple options in the <select> element with Locator.selectOption(). You can specify option value, or label to select. Multiple options can be selected.
page.getByLabel("Choose a color").selectOption("blue");
page.getByLabel("Choose a color").selectOption(new SelectOption().setLabel("Blue"));
page.getByLabel("Choose multiple colors").selectOption(new String[] {"red", "green", "blue"});
Performs a simple human click.
page.getByRole(AriaRole.BUTTON).click();
page.getByText("Item").dblclick();
page.getByText("Item").click(new Locator.ClickOptions().setButton(MouseButton.RIGHT));
page.getByText("Item").click(new Locator.ClickOptions().setModifiers(Arrays.asList(KeyboardModifier.SHIFT)));
page.getByText("Item").click(new Locator.ClickOptions().setModifiers(Arrays.asList(KeyboardModifier.CONTROL_OR_META)));
page.getByText("Item").hover();
page.getByText("Item").click(new Locator.ClickOptions().setPosition(0, 0));
Under the hood, this and other pointer-related methods:
display:none, no visibility:hiddenSometimes, apps use non-trivial logic where hovering the element overlays it with another element that intercepts the click. This behavior is indistinguishable from a bug where element gets covered and the click is dispatched elsewhere. If you know this is taking place, you can bypass the actionability checks and force the click:
page.getByRole(AriaRole.BUTTON).click(new Locator.ClickOptions().setForce(true));
If you are not interested in testing your app under the real conditions and want to simulate the click by any means possible, you can trigger the HTMLElement.click() behavior via simply dispatching a click event on the element with Locator.dispatchEvent():
page.getByRole(AriaRole.BUTTON).dispatchEvent("click");
caution
Most of the time, you should input text with Locator.fill(). See the Text input section above. You only need to type characters if there is special keyboard handling on the page.
Type into the field character by character, as if it was a user with a real keyboard with Locator.pressSequentially().
page.locator("#area").pressSequentially("Hello World!");
This method will emit all the necessary keyboard events, with all the keydown, keyup, keypress events in place. You can even specify the optional delay between the key presses to simulate real user behavior.
page.getByText("Submit").press("Enter");
page.getByRole(AriaRole.TEXTBOX).press("Control+ArrowRight");
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" or "#".Shift, Control, Alt, Meta.Simple version produces a single character. This character is case-sensitive, so "a" and "A" will produce different results.
page.locator("#name").press("Shift+A");
page.locator("#name").press("Shift+ArrowLeft");
Shortcuts such as "Control+o" or "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
Note that you still need to specify the capital A in Shift-A to produce the capital character. Shift-a produces a lower-case one as if you had the CapsLock toggled.
You can select input files for upload using the Locator.setInputFiles() method. It expects first argument to point to an input element with the type "file". Multiple files can be passed in the array. If some of the file paths are relative, they are resolved relative to the current working directory. Empty array clears the selected files.
page.getByLabel("Upload file").setInputFiles(Paths.get("myfile.pdf"));
page.getByLabel("Upload files").setInputFiles(new Path[] {Paths.get("file1.txt"), Paths.get("file2.txt")});
page.getByLabel("Upload directory").setInputFiles(Paths.get("mydir"));
page.getByLabel("Upload file").setInputFiles(new Path[0]);
page.getByLabel("Upload file").setInputFiles(new FilePayload(
"file.txt", "text/plain", "this is test".getBytes(StandardCharsets.UTF_8)));
If you don't have input element in hand (it is created dynamically), you can handle the Page.onFileChooser(handler) event or use a corresponding waiting method upon your action:
FileChooser fileChooser = page.waitForFileChooser(() -> {
page.getByLabel("Upload file").click();
});
fileChooser.setFiles(Paths.get("myfile.pdf"));
For the dynamic pages that handle focus events, you can focus the given element with Locator.focus().
page.getByLabel("Password").focus();
You can perform drag&drop operation with Locator.dragTo(). This method will:
page.locator("#item-to-be-dragged").dragTo(page.locator("#item-to-drop-at"));
If you want precise control over the drag operation, use lower-level methods like Locator.hover(), Mouse.down(), Mouse.move() and Mouse.up().
page.locator("#item-to-be-dragged").hover();
page.mouse().down();
page.locator("#item-to-drop-at").hover();
page.mouse().up();
note
If your page relies on the dragover event being dispatched, you need at least two mouse moves to trigger it in all browsers. To reliably issue the second mouse move, repeat your Mouse.move() or Locator.hover() twice. The sequence of operations would be: hover the drag element, mouse down, hover the drop element, hover the drop element second time, mouse up.
Most of the time, Playwright will automatically scroll for you before doing any actions. Therefore, you do not need to scroll explicitly.
page.getByRole(AriaRole.BUTTON).click();
However, in rare cases you might need to manually scroll. For example, you might want to force an "infinite list" to load more elements, or position the page for a specific screenshot. In such a case, the most reliable way is to find an element that you want to make visible at the bottom, and scroll it into view.
page.getByText("Footer text").scrollIntoViewIfNeeded();
If you would like to control the scrolling more precisely, use Mouse.wheel() or Locator.evaluate():
page.getByTestId("scrolling-container").hover();
page.mouse.wheel(0, 10);
page.getByTestId("scrolling-container").evaluate("e => e.scrollTop += 100");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4