跳至主要内容

键盘

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

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

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

方法

DownAsync

Added before 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, 等。

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

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

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

如果key是修饰键ShiftMetaControlAlt,后续按键操作将保持该修饰键处于激活状态。要释放修饰键,请使用Keyboard.UpAsync()

按键按下一次后,后续调用Keyboard.DownAsync()repeat参数将被设为true。要释放按键,请使用Keyboard.UpAsync()

note

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

用法

await Keyboard.DownAsync(key);

参数

  • key string#

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

返回


InsertTextAsync

Added before v1.9 keyboard.InsertTextAsync

仅触发input事件,不会发出keydownkeyupkeypress事件。

用法

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

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

参数

  • text string#

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

返回


PressAsync

Added before v1.9 keyboard.PressAsync
tip

在大多数情况下,您应该使用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, 等。

还支持以下修改快捷键: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

Added before v1.9 keyboard.TypeAsync
caution

在大多数情况下,您应该使用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
note

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

note

对于不在美式键盘上的字符,只会发送一个input事件。

参数

  • text string#

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

  • options KeyboardTypeOptions? (可选)

    • Delay [float]? (可选)#

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

返回


异步上传

Added before v1.9 keyboard.UpAsync

触发一个 keyup 事件。

用法

await Keyboard.UpAsync(key);

参数

  • key string#

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

返回