Keyboard

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

为了更精细地控制，您可以使用 Keyboard.DownAsync()、Keyboard.UpAsync() 和 Keyboard.InsertTextAsync() 手动触发事件，就像它们是由真实键盘生成的一样。

按住 Shift 键以选择并删除部分文本的示例

await page.Keyboard.TypeAsync("Hello World!");
await page.Keyboard.PressAsync("ArrowLeft");

await page.Keyboard.DownAsync("Shift");
for (int i = 0; i < " World".Length; i++)
    await page.Keyboard.PressAsync("ArrowLeft");

await page.Keyboard.UpAsync("Shift");

await page.Keyboard.PressAsync("Backspace");
// Result text will end up saying "Hello!"

按下大写 A 的示例

await page.Keyboard.PressAsync("Shift+KeyA");
// or
await page.Keyboard.PressAsync("Shift+A");

使用键盘触发全选的示例

await page.Keyboard.PressAsync("ControlOrMeta+A");

---

方法

DownAsync

v1.9 之前添加 keyboard.DownAsync

分派 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.UpAsync()。

按键按下一次后，对 Keyboard.DownAsync() 的后续调用将使 repeat 设置为 true。要释放按键，请使用 Keyboard.UpAsync()。

注意

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

用法

await Keyboard.DownAsync(key);

参数

• key string#

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

返回

• void#

---

InsertTextAsync

v1.9 之前添加 keyboard.InsertTextAsync

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

用法

await page.Keyboard.PressAsync("嗨");

注意

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

参数

• text string#

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

返回

• void#

---

PressAsync

v1.9 之前添加 keyboard.PressAsync

提示

在大多数情况下，您应该使用 Locator.PressAsync()。

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"。当与修饰符一起指定时，修饰符在按下后续键时被按下并保持。

用法

await page.GotoAsync("https://keycode.info");
await page.Keyboard.PressAsync("A");
await page.ScreenshotAsync(new() { Path = "A.png" });
await page.Keyboard.PressAsync("ArrowLeft");
await page.ScreenshotAsync(new() { Path = "ArrowLeft.png" });
await page.Keyboard.PressAsync("Shift+O");
await page.ScreenshotAsync(new() { Path = "O.png" });
await browser.CloseAsync();

Keyboard.DownAsync() 和 Keyboard.UpAsync() 的快捷方式。

参数

• key string#

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

• options KeyboardPressOptions? （可选）

  • Delay [float]? （可选）#

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

返回

• void#

---

TypeAsync

v1.9 之前添加 keyboard.TypeAsync

注意

在大多数情况下，您应该使用 Locator.FillAsync()。只有当页面上有特殊的键盘处理时，才需要逐个按键——在这种情况下，请使用 Locator.PressSequentiallyAsync()。

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

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

用法

await page.Keyboard.TypeAsync("Hello"); // types instantly
await page.Keyboard.TypeAsync("World", new() { Delay = 100 }); // types slower, like a user

注意

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

注意

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

参数

• text string#

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

• options KeyboardTypeOptions? （可选）

  • Delay [float]? （可选）#

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

返回

• void#

---

UpAsync

v1.9 之前添加 keyboard.UpAsync

分派 keyup 事件。

用法

await Keyboard.UpAsync(key);

参数

• key string#

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

返回

• void#