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

アクション

はじめに​

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トランジションが終了するまで)
  • 要素をビュー内にスクロールする
  • アクションポイントでポインタイベントを受信するまで待機する (例: 他の要素によって要素が隠れなくなるまで待機する)
  • 上記いずれかのチェック中に要素がデタッチされた場合は再試行する

クリックの強制​

アプリケーションによっては、要素をホバーすると別の要素が重なり、クリックがインターセプトされるという複雑なロジックを使用する場合があります。この動作は、要素が隠れてクリックが別の場所にディスパッチされるバグと区別できません。この状況が発生していることがわかっている場合は、アクション可能性チェックをバイパスしてクリックを強制できます。

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

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

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

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" を持つ入力要素を指すことを期待します。複数のファイルを配列で渡すことができます。ファイルパスの一部が相対パスの場合、現在の作業ディレクトリを基準に解決されます。空の配列は選択されたファイルをクリアします。

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