跳到主要内容

Keyboard

Keyboard 提供了一个 API 用于管理虚拟键盘。高级 API 是 keyboard.type(),它接受原始字符并在您的页面上生成正确的 keydownkeypress/inputkeyup 事件。

为了更精细的控制,您可以使用 keyboard.down()keyboard.up()keyboard.insertText() 来手动触发事件,就像它们是由真实键盘生成的一样。

一个按住 Shift 键以选择和删除一些文本的示例

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');
// Result text will end up saying 'Hello!'

一个按下大写 A 的示例

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

一个使用键盘触发全选的示例

await page.keyboard.press('ControlOrMeta+A');

方法

down

在 v1.9 之前添加 keyboard.down

派发一个 keydown 事件。

key 可以指定预期的 keyboardEvent.key 值或生成文本的单个字符。 key 值的超集可以在 此处 找到。 键的示例包括

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

还支持以下修饰符快捷键:ShiftControlAltMetaShiftLeftControlOrMetaControlOrMeta 在 Windows 和 Linux 上解析为 Control,在 macOS 上解析为 Meta

按住 Shift 键将键入与大写 key 对应的文本。

如果 key 是单个字符,则它是区分大小写的,因此值 aA 将生成不同的相应文本。

如果 key 是修饰键 ShiftMetaControlAlt,则后续按键将以该修饰符激活状态发送。 要释放修饰键,请使用 keyboard.up()

在按键一次后,后续调用 keyboard.down() 将使 repeat 设置为 true。 要释放键,请使用 keyboard.up()

注意

修饰键会影响 keyboard.down。 按住 Shift 键将以大写形式键入文本。

用法

await keyboard.down(key);

参数

  • key string#

    要按下的键的名称或要生成的字符,例如 ArrowLefta

返回值


insertText

在 v1.9 之前添加 keyboard.insertText

仅派发 input 事件,不发出 keydownkeyupkeypress 事件。

用法

page.keyboard.insertText('嗨');
注意

修饰键不影响 keyboard.insertText。 按住 Shift 键不会以大写形式键入文本。

参数

  • text string#

    将输入设置为指定的文本值。

返回值


press

在 v1.9 之前添加 keyboard.press
提示

在大多数情况下,您应该使用 locator.press() 代替。

key 可以指定预期的 keyboardEvent.key 值或生成文本的单个字符。 key 值的超集可以在 此处 找到。 键的示例包括

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

还支持以下修饰符快捷键:ShiftControlAltMetaShiftLeftControlOrMetaControlOrMeta 在 Windows 和 Linux 上解析为 Control,在 macOS 上解析为 Meta

按住 Shift 键将键入与大写 key 对应的文本。

如果 key 是单个字符,则它是区分大小写的,因此值 aA 将生成不同的相应文本。

也支持诸如 key: "Control+o"key: "Control++key: "Control+Shift+T" 之类的快捷方式。 当使用修饰符指定时,修饰符将被按下并在随后的按键被按下时保持按下状态。

用法

const page = await browser.newPage();
await page.goto('https://keycode.info');
await page.keyboard.press('A');
await page.screenshot({ path: 'A.png' });
await page.keyboard.press('ArrowLeft');
await page.screenshot({ path: 'ArrowLeft.png' });
await page.keyboard.press('Shift+O');
await page.screenshot({ path: 'O.png' });
await browser.close();

keyboard.down()keyboard.up() 的快捷方式。

参数

  • key string#

    要按下的键的名称或要生成的字符,例如 ArrowLefta

  • options Object (可选)

    • delay number (可选)#

      keydownkeyup 之间等待的时间,以毫秒为单位。 默认为 0。

返回值


type

在 v1.9 之前添加 keyboard.type
注意

在大多数情况下,您应该使用 locator.fill() 代替。 只有当页面上有特殊的键盘处理时,才需要逐个按键 - 在这种情况下,请使用 locator.pressSequentially()

为文本中的每个字符发送 keydownkeypress/inputkeyup 事件。

要按下特殊键,如 ControlArrowDown,请使用 keyboard.press()

用法

await page.keyboard.type('Hello'); // Types instantly
await page.keyboard.type('World', { delay: 100 }); // Types slower, like a user
注意

修饰键不影响 keyboard.type。 按住 Shift 键不会以大写形式键入文本。

注意

对于不在美式键盘上的字符,只会发送 input 事件。

参数

  • text string#

    要键入到焦点元素中的文本。

  • options Object (可选)

    • delay number (可选)#

      按键之间等待的时间,以毫秒为单位。 默认为 0。

返回值


up

在 v1.9 之前添加 keyboard.up

派发一个 keyup 事件。

用法

await keyboard.up(key);

参数

  • key string#

    要按下的键的名称或要生成的字符,例如 ArrowLefta

返回值