跳到主要内容

Keyboard

Keyboard 提供了一个用于管理虚拟键盘的 API。高级 API 是 keyboard.type()，它接受原始字符并在您的页面上生成正确的 keydown、keypress/input 和 keyup 事件。

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

一个按住 Shift 以选择和删除一些文本的示例

page.keyboard.type("Hello World!")
page.keyboard.press("ArrowLeft")
page.keyboard.down("Shift")
for i in range(6):
    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 str#

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

返回

insert_text​

在 v1.9 之前添加 keyboard.insert_text

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

用法

page.keyboard.insert_text("嗨")
注意

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

参数

  • text str#

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

返回

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 = browser.new_page()
page.goto("https://keycode.info")
page.keyboard.press("a")
page.screenshot(path="a.png")
page.keyboard.press("ArrowLeft")
page.screenshot(path="arrow_left.png")
page.keyboard.press("Shift+O")
page.screenshot(path="o.png")
browser.close()

用于 keyboard.down() 和 keyboard.up() 的快捷方式。

参数

  • key str#

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

  • delay float (可选)#

    keydown 和 keyup 之间等待的时间，以毫秒为单位。默认为 0。

返回

type​

在 v1.9 之前添加 keyboard.type
注意

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

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

要按下特殊键，如 Control 或 ArrowDown，请使用 keyboard.press()。

用法

page.keyboard.type("Hello") # types instantly
page.keyboard.type("World", delay=100) # types slower, like a user
注意

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

注意

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

参数

  • text str#

    要键入到焦点元素中的文本。

  • delay float (可选)#

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

返回

up​

在 v1.9 之前添加 keyboard.up

派发一个 keyup 事件。

用法

keyboard.up(key)

参数

  • key str#

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

返回