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

按下大写 A 的示例

page.keyboard().press("Shift+KeyA");
// or
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 (optional)

  • setDelay double (optional)#

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

  • setDelay double (optional)#

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

返回

• void#

---

up

v1.9 之前添加 keyboard.up

分派 keyup 事件。

用法

Keyboard.up(key);

参数

• key String#

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

返回

• void#