Skip to content

Keyboard ​

Added in: v1.8

Keyboard provides an api for managing a virtual keyboard. The high level api is keyboard.type(), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.

For finer control, you can use keyboard.down(), keyboard.up(), and keyboard.insertText() to manually fire events as if they were generated from a real keyboard.

INFO

Caps Lock state emulation is not supported. Pressing CapsLock dispatches keyboard events, but does not make subsequent lowercase input uppercase. To type uppercase text, pass uppercase characters to locator.pressSequentially() or keyboard.type().

An example of holding down Shift in order to select and delete some text:

java
page.keyboard().type("Hello World!");
page.keyboard().press("ArrowLeft");
page.keyboard().down("Shift");
for (int i = 0; i < " World".length(); i++)
  page.keyboard().press("ArrowLeft");
page.keyboard().up("Shift");
page.keyboard().press("Backspace");
// Result text will end up saying "Hello!"

An example of pressing uppercase A

java
page.keyboard().press("Shift+KeyA");
// or
page.keyboard().press("Shift+A");

An example to trigger select-all with the keyboard

java
page.keyboard().press("ControlOrMeta+A");

Methods ​

keyboard.down() ​

Added in: v1.8

Dispatches a keydown event.

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta. ControlOrMeta resolves to Control on Windows and Linux and to Meta on macOS.

Holding down Shift will type the text that corresponds to the key in the upper case.

If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

If key is a modifier key, Shift, Meta, Control, or Alt, subsequent key presses will be sent with that modifier active. To release the modifier key, use keyboard.up().

After the key is pressed once, subsequent calls to keyboard.down() will have repeat set to true. To release the key, use keyboard.up().

INFO

Modifier keys DO influence keyboard.down. Holding down Shift will type the text in upper case.

Arguments

  • key string

    Name of the key to press or a character to generate, such as ArrowLeft or a.

keyboard.insertText() ​

Added in: v1.8

Dispatches only input event, does not emit the keydown, keyup or keypress events.

Usage

java
page.keyboard().insertText("嗨");

INFO

Modifier keys DO NOT effect keyboard.insertText. Holding down Shift will not type the text in upper case.

Arguments

  • text string

    Sets input to the specified text value.

keyboard.press() ​

Added in: v1.8

TIP

In most cases, you should use locator.press() instead.

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta. ControlOrMeta resolves to Control on Windows and Linux and to Meta on macOS.

Holding down Shift will type the text that corresponds to the key in the upper case.

If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

Shortcuts such as key: "Control+o", key: "Control++ or key: "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.

Usage

java
Page page = browser.newPage();
page.navigate("https://keycode.info");
page.keyboard().press("A");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("A.png")));
page.keyboard().press("ArrowLeft");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("ArrowLeft.png")));
page.keyboard().press("Shift+O");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("O.png")));
browser.close();

Shortcut for keyboard.down() and keyboard.up().

Arguments

  • key string

    Name of the key to press or a character to generate, such as ArrowLeft or a.

  • options Object (optional)

    • delay float (optional)

      Time to wait between keydown and keyup in milliseconds. Defaults to 0.

keyboard.type() ​

Added in: v1.8

WARNING

In most cases, you should use locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use locator.pressSequentially().

Sends a keydown, keypress/input, and keyup event for each character in the text.

To press a special key, like Control or ArrowDown, use keyboard.press().

Usage

java
// Types instantly
page.keyboard().type("Hello");
// Types slower, like a user
page.keyboard().type("World", new Keyboard.TypeOptions().setDelay(100));

INFO

Modifier keys DO NOT effect keyboard.type. Holding down Shift will not type the text in upper case.

INFO

For characters that are not on a US keyboard, only an input event will be sent.

Arguments

  • text string

    A text to type into a focused element.

  • options Object (optional)

    • delay float (optional)

      Time to wait between key presses in milliseconds. Defaults to 0.

keyboard.up() ​

Added in: v1.8

Dispatches a keyup event.

Arguments

  • key string

    Name of the key to press or a character to generate, such as ArrowLeft or a.

Released under the Apache 2.0 License.