Struct playwright::api::input_device::Keyboard

pub struct Keyboard { /* fields omitted */ }

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

For finer control, you can use [method: Keyboard.down], [method: Keyboard.up], and [method: Keyboard.insertText] to manually fire events as if they were generated from a real keyboard.

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

await page.keyboard.type('Hello World!');
await page.keyboard.press('ArrowLeft');

await page.keyboard.down('Shift');
for (let i = 0; i < ' World'.length; i++)
 await page.keyboard.press('ArrowLeft');
await page.keyboard.up('Shift');

await page.keyboard.press('Backspace');

An example of pressing uppercase A

await page.keyboard.press('Shift+KeyA');
await page.keyboard.press('Shift+A');

An example to trigger select-all with the keyboard

await page.keyboard.press('Control+A');
await page.keyboard.press('Meta+A');

Implementations

impl Keyboard

pub async fn down(&self, key: &str) -> Result<(), Arc<Error>>

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.

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 [method: Keyboard.up].

After the key is pressed once, subsequent calls to [method: Keyboard.down] will have repeat set to true. To release the key, use [method: Keyboard.up].

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

pub async fn up(&self, key: &str) -> Result<(), Arc<Error>>

pub async fn input_text(&self, text: &str) -> Result<(), Arc<Error>>

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

page.keyboard.insertText('嗨');

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

pub async fn type(
    &self,
    text: &str,
    delay: Option<f64>
) -> Result<(), Arc<Error>>

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

pub async fn press(
    &self,
    key: &str,
    delay: Option<f64>
) -> Result<(), Arc<Error>>

Shortcut for [method: Keyboard.down] and [method: Keyboard.up].

Trait Implementations

impl Debug for Keyboard

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.