跳至主要内容

键盘

Keyboard 提供了一个用于管理虚拟键盘的 API。高级别 API 是 Keyboard.TypeAsync(),它接受原始字符并在页面上生成正确的 keydownkeypress/inputkeyup 事件。

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

使用键盘触发全选的示例

// on Windows and Linux
await page.Keyboard.PressAsync("Control+A");
// on macOS
await page.Keyboard.PressAsync("Meta+A");

方法

DownAsync

在 v1.9 之前添加 keyboard.DownAsync

分派 keydown 事件。

key 可以指定预期的 keyboardEvent.key 值或生成文本的单个字符。可以在 此处 找到 key 值的超集。键的示例包括

F1 - F12Digit0- Digit9KeyA- KeyZBackquoteMinusEqualBackslashBackspaceTabDeleteEscapeArrowDownEndEnterHomeInsertPageDownPageUpArrowRightArrowUp 等。

还支持以下修改快捷方式:ShiftControlAltMetaShiftLeftControlOrMetaControlOrMeta 在 Windows 和 Linux 上解析为 Control,在 macOS 上解析为 Meta

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

如果 key 是单个字符,则区分大小写,因此值 aA 将生成不同的文本。

如果 key 是修饰键(ShiftMetaControlAlt),则后续按键将以该修饰键处于活动状态发送。要释放修饰键,请使用 Keyboard.UpAsync()

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

注意

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

用法

await Keyboard.DownAsync(key);

参数

  • key string#

    要按下的键的名称或要生成的字符,例如 ArrowLefta

返回值


InsertTextAsync

在 v1.9 之前添加 keyboard.InsertTextAsync

仅分派 input 事件,不发出 keydownkeyupkeypress 事件。

用法

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

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

参数

  • text string#

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

返回值


PressAsync

在 v1.9 之前添加 keyboard.PressAsync
提示

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

key 可以指定预期的 keyboardEvent.key 值或生成文本的单个字符。可以在 此处 找到 key 值的超集。键的示例包括

F1 - F12Digit0- Digit9KeyA- KeyZBackquoteMinusEqualBackslashBackspaceTabDeleteEscapeArrowDownEndEnterHomeInsertPageDownPageUpArrowRightArrowUp 等。

还支持以下修改快捷方式:ShiftControlAltMetaShiftLeftControlOrMetaControlOrMeta 在 Windows 和 Linux 上解析为 Control,在 macOS 上解析为 Meta

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

如果 key 是单个字符,则区分大小写,因此值 aA 将生成不同的文本。

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

    要按下的键的名称或要生成的字符,例如 ArrowLefta

  • options KeyboardPressOptions? (可选)

    • Delay [float]? (可选)#

      keydownkeyup 之间等待的时间(毫秒)。默认为 0。

返回值


TypeAsync

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

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

为文本中的每个字符发送 keydownkeypress/inputkeyup 事件。

要按下特殊键(如 ControlArrowDown),请使用 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。

返回值


UpAsync

在 v1.9 之前添加 keyboard.UpAsync

分派 keyup 事件。

用法

await Keyboard.UpAsync(key);

参数

  • key string#

    要按下的键的名称或要生成的字符,例如 ArrowLefta

返回值