Keyboard

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

如需更精细的控制，可以使用 Keyboard.down()、Keyboard.up() 和 Keyboard.insertText() 手动触发事件，就像这些事件是由真实键盘生成的一样。

以下是一个按住 Shift 键以选中并删除部分文本的示例：

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");
// 最终文本将变为 "Hello!"

以下是一个按下大写字母 A 的示例：

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

以下是一个通过键盘触发全选操作的示例：

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

还支持以下修饰键快捷键：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 键将输入大写文本。

用法

Keyboard.down(key);

参数

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

返回值

• void#

---

insertText

在 v1.9 之前添加 keyboard.insertText

仅触发 input 事件，不触发 keydown、keyup 或 keypress 事件。

用法

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

备注

修饰键对 keyboard.insertText 无效。按住 Shift 不会输入大写文本。

参数

• text String# 将输入设置为指定的文本值。

返回值

• void#

---

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" 这样的快捷键。当指定了修饰键时，在按下后续键时，修饰键将被按下并保持按住状态。

使用方法

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();

这是 Keyboard.down() 和 Keyboard.up() 的快捷方式。

参数

• key String# 要按下的键的名称，或要生成的字符，例如 ArrowLeft 或 a。
• options Keyboard.PressOptions（可选）
  • setDelay double（可选）# keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。

返回值

• void#

---

type

在 v1.9 之前添加 keyboard.type

警告

在大多数情况下，你应该使用 Locator.fill()。只有在页面上有特殊键盘处理时，你才需要逐个按键，此时请使用 Locator.pressSequentially()。

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

要按下特殊键，如 Control 或 ArrowDown，请使用 Keyboard.press()。

用法

// 立即输入
page.keyboard().type("Hello");
// 像用户一样缓慢输入
page.keyboard().type("World", new Keyboard.TypeOptions().setDelay(100));

备注

修饰键对 keyboard.type 无效。按住 Shift 不会输入大写文本。

备注

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

参数

• text String#

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

• options Keyboard.TypeOptions (可选)

  • setDelay double (可选)#

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

返回值

• void#

---

up

在 v1.9 之前添加 keyboard.up

触发 keyup 事件。

用法

Keyboard.up(key);

参数

• key String#

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

返回值

• void#