跳至主要内容

键盘

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

方法​

下载​

Added before 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()。

note

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

用法

keyboard.down(key)

参数

  • key str#

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

返回

insert_text​

Added before v1.9 keyboard.insert_text

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

用法

page.keyboard.insert_text("嗨")
note

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

参数

  • text str#

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

返回

按下​

Added before v1.9 keyboard.press
tip

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

返回

类型​

Added before v1.9 keyboard.type
caution

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

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

note

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

参数

  • text str#

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

  • delay float (可选参数)#

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

返回

向上​

Added before v1.9 keyboard.up

触发一个 keyup 事件。

用法

keyboard.up(key)

参数

  • key str#

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

返回