メインコンテンツにスキップ

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()を使用してください。ページで特別なキーボード処理がある場合にのみ、キーを1つずつ押す必要があります。この場合は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を押し続けても、テキストは大文字で入力されません。

注

USキーボードにない文字の場合、inputイベントのみが送信されます。

引数

  • text str#

    フォーカスされた要素に入力するテキスト。

  • delay float (オプション)#

    キー押下間の待機時間（ミリ秒）。デフォルトは0です。

戻り値

up​

v1.9より前に追加 keyboard.up

keyupイベントをディスパッチします。

使用法

keyboard.up(key)

引数

  • key str#

    押すキーの名前、または ArrowLeft や a などの生成する文字。

戻り値