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

アクション

イントロダクション​

Playwright は、テキスト入力、チェックボックス、ラジオボタン、選択肢、マウスのクリック、文字入力、キーとショートカット、ファイルのアップロード、要素のフォーカスなど、HTML入力要素を操作できます。

テキスト入力​

locator.fill() を使用すると、フォームフィールドに最も簡単に値を入力できます。要素をフォーカスし、入力されたテキストで input イベントをトリガーします。 <input>、<textarea>、[contenteditable] 要素で動作します。

# Text input
page.get_by_role("textbox").fill("Peter")

# Date input
page.get_by_label("Birth date").fill("2020-02-02")

# Time input
page.get_by_label("Appointment time").fill("13:15")

# Local datetime input
page.get_by_label("Local time").fill("2020-03-02T05:15")

チェックボックスとラジオボタン​

locator.set_checked() を使用すると、チェックボックスまたはラジオボタンを最も簡単にチェックおよびチェック解除できます。このメソッドは、input[type=checkbox]、input[type=radio]、[role=checkbox] 要素で使用できます。

# Check the checkbox
page.get_by_label('I agree to the terms above').check()

# Assert the checked state
expect(page.get_by_label('Subscribe to newsletter')).to_be_checked()

# Select the radio button
page.get_by_label('XL').check()

選択肢の選択​

locator.select_option() を使用して、<select> 要素で1つまたは複数のオプションを選択します。選択するオプションの value または label を指定できます。複数のオプションを選択できます。

# Single selection matching the value or label
page.get_by_label('Choose a color').select_option('blue')

# Single selection matching the label
page.get_by_label('Choose a color').select_option(label='Blue')

# Multiple selected items
page.get_by_label('Choose multiple colors').select_option(['red', 'green', 'blue'])

マウスクリック​

単純な人間のクリックを実行します。

# Generic click
page.get_by_role("button").click()

# Double click
page.get_by_text("Item").dblclick()

# Right click
page.get_by_text("Item").click(button="right")

# Shift + click
page.get_by_text("Item").click(modifiers=["Shift"])

# Hover over element
page.get_by_text("Item").hover()

# Click the top left corner
page.get_by_text("Item").click(position={ "x": 0, "y": 0})

内部的には、このメソッドと他のポインター関連のメソッドは

  • 指定されたセレクターを持つ要素が DOM に存在することを待ちます
  • 要素が表示される（空ではなく、display:none や visibility:hidden ではない）のを待ちます
  • 要素の移動が停止する（例えば、CSS トランジションが完了するまで）のを待ちます
  • 要素をビューにスクロールします
  • 要素がアクションポイントでポインターイベントを受信するのを待ちます。例えば、要素が他の要素によって隠されていない状態になるまで待ちます
  • 上記のチェック中に要素がデタッチされた場合は再試行します

クリックの強制​

アプリによっては、要素をホバーすると、クリックをインターセプトする別の要素がオーバーレイされるという、非自明なロジックを使用する場合があります。この動作は、要素が覆われてクリックが別の場所にディスパッチされるバグと区別がつきません。これが発生していることがわかっている場合は、actionability チェックをバイパスしてクリックを強制できます

page.get_by_role("button").click(force=True)

プログラムによるクリック​

実際の条件下でアプリをテストすることに興味がなく、可能な限りあらゆる手段でクリックをシミュレートしたい場合は、locator.dispatch_event() を使用して要素に click イベントをディスパッチするだけで、HTMLElement.click() の動作をトリガーできます

page.get_by_role("button").dispatch_event('click')

文字入力​

注意

ほとんどの場合、テキストは locator.fill() で入力する必要があります。上記の「テキスト入力」セクションを参照してください。ページに特別なキーボード処理がある場合にのみ、文字を入力する必要があります。

実際のキーボードを持つユーザーのように、locator.press_sequentially() を使用して、フィールドに文字を1文字ずつ入力します。

# Press keys one by one
page.locator('#area').press_sequentially('Hello World!')

このメソッドは、必要なすべてのキーボードイベント（keydown、keyup、keypress イベントを含む）を発行します。キー押下間のオプションの delay を指定して、実際のユーザーの動作をシミュレートすることもできます。

キーとショートカット​

# Hit Enter
page.get_by_text("Submit").press("Enter")

# Dispatch Control+Right
page.get_by_role("textbox").press("Control+ArrowRight")

# Press $ sign on keyboard
page.get_by_role("textbox").press("$")

locator.press() メソッドは、選択された要素にフォーカスし、単一のキーストロークを生成します。キーボードイベントの keyboardEvent.key プロパティで発行される論理キー名を受け入れます

Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape,
ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight,
ArrowUp, F1 - F12, Digit0 - Digit9, KeyA - KeyZ, etc.
  • 代わりに、生成したい単一の文字（"a" や "#" など）を指定することもできます。
  • 次の修飾ショートカットもサポートされています：Shift、Control、Alt、Meta。

シンプルなバージョンでは、単一の文字が生成されます。この文字は大文字と小文字が区別されるため、"a" と "A" では異なる結果が生成されます。

# <input id=name>
page.locator('#name').press('Shift+A')

# <input id=name>
page.locator('#name').press('Shift+ArrowLeft')

"Control+o" や "Control+Shift+T" などのショートカットもサポートされています。修飾キーと一緒に指定すると、修飾キーが押されたままになり、後続のキーが押されます。

大文字の文字を生成するには、Shift-A で大文字の A を指定する必要があることに注意してください。Shift-a は、CapsLock がオンになっているかのように小文字を生成します。

ファイルのアップロード​

locator.set_input_files() メソッドを使用して、アップロードする入力ファイルを選択できます。最初の引数には、type "file" の input 要素 を指定する必要があります。複数のファイルを配列で渡すことができます。ファイルパスの一部が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。空の配列は、選択されたファイルをクリアします。

# Select one file
page.get_by_label("Upload file").set_input_files('myfile.pdf')

# Select multiple files
page.get_by_label("Upload files").set_input_files(['file1.txt', 'file2.txt'])

# Select a directory
page.get_by_label("Upload directory").set_input_files('mydir')

# Remove all the selected files
page.get_by_label("Upload file").set_input_files([])

# Upload buffer from memory
page.get_by_label("Upload file").set_input_files(
    files=[
        {"name": "test.txt", "mimeType": "text/plain", "buffer": b"this is a test"}
    ],
)

入力要素を手元にない場合（動的に作成される場合）、page.on("filechooser") イベントを処理するか、アクションに対応する待機メソッドを使用できます

with page.expect_file_chooser() as fc_info:
    page.get_by_label("Upload file").click()
file_chooser = fc_info.value
file_chooser.set_files("myfile.pdf")

要素のフォーカス​

フォーカスイベントを処理する動的なページの場合、locator.focus() を使用して、指定された要素にフォーカスできます。

page.get_by_label('password').focus()

ドラッグ＆ドロップ​

locator.drag_to() を使用して、ドラッグ＆ドロップ操作を実行できます。このメソッドは

  • ドラッグされる要素をホバーします。
  • 左マウスボタンを押します。
  • ドロップを受け取る要素にマウスを移動します。
  • 左マウスボタンを離します。
page.locator("#item-to-be-dragged").drag_to(page.locator("#item-to-drop-at"))

手動でのドラッグ​

ドラッグ操作を正確に制御したい場合は、locator.hover()、mouse.down()、mouse.move()、mouse.up() などの下位レベルのメソッドを使用してください。

page.locator("#item-to-be-dragged").hover()
page.mouse.down()
page.locator("#item-to-drop-at").hover()
page.mouse.up()
注記

ページが dragover イベントのディスパッチに依存している場合、すべてのブラウザでトリガーするには、少なくとも2回のマウス移動が必要です。2回目のマウス移動を確実に発行するには、mouse.move() または locator.hover() を2回繰り返します。操作のシーケンスは次のようになります：ドラッグ要素をホバー、マウスダウン、ドロップ要素をホバー、ドロップ要素を2回目にホバー、マウスアップ。

スクロール​

ほとんどの場合、Playwright はアクションを実行する前に自動的にスクロールします。したがって、明示的にスクロールする必要はありません。

# Scrolls automatically so that button is visible
page.get_by_role("button").click()

ただし、まれに手動でスクロールする必要がある場合があります。たとえば、「無限リスト」を強制的にロードして要素を増やしたり、特定のスクリーンショットのためにページを配置したりする場合などです。そのような場合、最も確実な方法は、下部に表示したい要素を見つけて、それをビューにスクロールすることです。

# Scroll the footer into view, forcing an "infinite list" to load more content
page.get_by_text("Footer text").scroll_into_view_if_needed()

スクロールをより正確に制御したい場合は、mouse.wheel() または locator.evaluate() を使用してください

# Position the mouse and scroll with the mouse wheel
page.get_by_test_id("scrolling-container").hover()
page.mouse.wheel(0, 10)

# Alternatively, programmatically scroll a specific element
page.get_by_test_id("scrolling-container").evaluate("e => e.scrollTop += 100")