Skip to main content

Keyboard

Keyboard 提供了一个用于管理虚拟键盘的 API。高级 API 是 keyboard.type(text[, options])，它接收原始字符并在页面上生成适当的 keydown、keypress/input 和 keyup 事件。

为了进行更精细的控制，您可以使用 keyboard.down(key)、keyboard.up(key) 和 keyboard.insertText(text) 手动触发事件，就像它们是从真实键盘生成的一样。

按住 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');
// 结果文本将最终显示为 'Hello!'

按下大写 A 的示例

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

使用键盘触发全选的示例

// 在 Windows 和 Linux 上
await page.keyboard.press('Control+A');
// 在 macOS 上
await page.keyboard.press('Meta+A');

keyboard.down(key)​

Added in: v1.8
  • key <string> 要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。#
  • returns: <Promise<void>>#

分派 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, etc.

还支持以下修饰键快捷键：Shift, Control, Alt, Meta, ShiftLeft。

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

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

如果 key 是修饰键 Shift、Meta、Control 或 Alt，则随后的按键将在该修饰键激活的情况下发送。要释放修饰键，请使用 keyboard.up(key)。

按键按下一次后，随后调用 keyboard.down(key) 将把 repeat 设置为 true。要释放按键，请使用 keyboard.up(key)。

note

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

keyboard.insertText(text)​

Added in: v1.8

仅分派 input 事件，不发出 keydown、keyup 或 keypress 事件。

page.keyboard.insertText('嗨');
note

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

keyboard.press(key[, options])​

Added in: v1.8
  • key <string> 要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。#
  • options? <Object>
    • delay? <number> keydown 和 keyup 之间等待的时间（以毫秒为单位）。默认为 0。#
  • returns: <Promise<void>>#

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, etc.

还支持以下修饰键快捷键：Shift, Control, Alt, Meta, ShiftLeft。

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

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

也支持快捷键，例如 key: "Control+o" 或 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(key) 和 keyboard.up(key) 的快捷方式。

keyboard.type(text[, options])​

Added in: v1.8
  • text <string> 要输入到焦点元素的文本。#
  • options? <Object>
    • delay? <number> 按键之间等待的时间（以毫秒为单位）。默认为 0。#
  • returns: <Promise<void>>#

为文本中的每个字符发送 keydown、keypress/input 和 keyup 事件。

要按下特殊键，如 Control 或 ArrowDown，请使用 keyboard.press(key[, options])。

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

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

note

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

keyboard.up(key)​

Added in: v1.8
  • key <string> 要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。#
  • returns: <Promise<void>>#

分派 keyup 事件。