键盘

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

一个按下大写 A 的示例

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

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

// on Windows and Linux
page.keyboard().press("Control+A");
// on macOS
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 会以大写形式键入文本。

用法

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

用法

// Types instantly
page.keyboard().type("Hello");
// Types slower, like a user
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#