Keyboard
Keyboard API 提供了管理虚拟键盘的功能。keyboard.type() 是高级 API,它接受原始字符,并在您的页面上生成正确的 keydown
、keypress
/input
和 keyup
事件。
为了更精细的控制,您可以使用 keyboard.down()、keyboard.up() 和 keyboard.insertText() 手动触发事件,就像它们是由真实键盘生成的一样。
以下示例展示了如何按住 Shift
键来选择和删除一些文本
await page.keyboard.type('Hello World!');
await page.keyboard.press('ArrowLeft');
await page.keyboard.down('Shift');
for (let i = 0; i < ' World'.length; i++)
await page.keyboard.press('ArrowLeft');
await page.keyboard.up('Shift');
await page.keyboard.press('Backspace');
// Result text will end up saying 'Hello!'
以下示例展示了如何按下大写字母 A
await page.keyboard.press('Shift+KeyA');
// or
await page.keyboard.press('Shift+A');
以下示例展示了如何使用键盘触发全选
await page.keyboard.press('ControlOrMeta+A');
方法
down
在 v1.9 版本之前添加派发一个 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
键将键入大写文本。
用法
await keyboard.down(key);
参数
返回值
insertText
在 v1.9 版本之前添加仅派发 input
事件,不触发 keydown
、keyup
或 keypress
事件。
用法
page.keyboard.insertText('嗨');
修饰键不会影响 keyboard.insertText
。 按住 Shift
键不会键入大写文本。
参数
返回值
press
在 v1.9 版本之前添加在大多数情况下,您应该使用 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"
之类的快捷方式。当与修饰符一起指定时,修饰符会被按下并保持,同时按下后续的键。
用法
const page = await browser.newPage();
await page.goto('https://keycode.info');
await page.keyboard.press('A');
await page.screenshot({ path: 'A.png' });
await page.keyboard.press('ArrowLeft');
await page.screenshot({ path: 'ArrowLeft.png' });
await page.keyboard.press('Shift+O');
await page.screenshot({ path: 'O.png' });
await browser.close();
keyboard.down()
和 keyboard.up()
的快捷方式。
参数
-
要按下的键的名称或要生成的字符,例如
ArrowLeft
或a
。 -
options
Object (可选)
返回值
type
在 v1.9 版本之前添加在大多数情况下,您应该使用 locator.fill() 代替。 只有当页面上有特殊的键盘处理时,才需要逐个按键 - 在这种情况下,请使用 locator.pressSequentially()。
为文本中的每个字符发送 keydown
、keypress
/input
和 keyup
事件。
要按下特殊键,例如 Control
或 ArrowDown
,请使用 keyboard.press()。
用法
await page.keyboard.type('Hello'); // Types instantly
await page.keyboard.type('World', { delay: 100 }); // Types slower, like a user
修饰键不会影响 keyboard.type
。 按住 Shift
键不会键入大写文本。
对于美国键盘上没有的字符,只会发送 input
事件。
参数
返回值
up
在 v1.9 版本之前添加派发一个 keyup
事件。
用法
await keyboard.up(key);
参数
返回值