跳至主要内容

键盘

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

为了获得更精细的控制，您可以使用 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');

使用键盘触发全选的示例

// on Windows and Linux
await page.keyboard.press('Control+A');
// on macOS
await page.keyboard.press('Meta+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 等。

还支持以下修改快捷键：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

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

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

如果 key 是修饰键（Shift、Meta、Control 或 Alt），则随后的按键将以该修饰键处于活动状态发送。要释放修饰键，请使用 keyboard.up()。

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

注意

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

用法

await keyboard.down(key);

参数

  • key 字符串#

    要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。

返回值

insertText​

在 v1.9 之前添加 keyboard.insertText

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

用法

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

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

参数

  • text 字符串#

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

返回值

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 等。

还支持以下修改快捷键：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

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

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

还支持诸如 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 字符串#

    要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。

  • options 对象 （可选）

    • delay 数字 （可选）#

      在 keydown 和 keyup 之间等待的时间（以毫秒为单位）。默认为 0。

返回值

type​

在 v1.9 之前添加 keyboard.type
警告

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

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

要按下特殊键（如 Control 或 ArrowDown），请使用 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 字符串#

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

  • options 对象 （可选）

    • delay 数字 （可选）#

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

返回值

向上​

在 v1.9 之前添加 keyboard.up

分发一个keyup事件。

用法

await keyboard.up(key);

参数

  • key 字符串#

    要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。

返回值