アクション
はじめに
Playwrightは、テキスト入力、チェックボックス、ラジオボタン、選択オプション、マウスのクリック、文字入力、キーとショートカット、ファイルのアップロード、要素へのフォーカスなど、HTML入力要素とインタラクトできます。
テキスト入力
Locator.fill() を使用するのが、フォームフィールドに入力する最も簡単な方法です。要素にフォーカスを合わせ、入力されたテキストで input イベントをトリガーします。これは <input>、<textarea>、および [contenteditable] 要素で機能します。
// Text input
page.getByRole(AriaRole.TEXTBOX).fill("Peter");
// Date input
page.getByLabel("Birth date").fill("2020-02-02");
// Time input
page.getByLabel("Appointment time").fill("13-15");
// Local datetime input
page.getByLabel("Local time").fill("2020-03-02T05:15");
チェックボックスとラジオボタン
Locator.setChecked() を使用するのが、チェックボックスまたはラジオボタンをチェック/チェック解除する最も簡単な方法です。このメソッドは、input[type=checkbox]、input[type=radio]、および [role=checkbox] 要素で使用できます。
// Check the checkbox
page.getByLabel("I agree to the terms above").check();
// Assert the checked state
assertTrue(page.getByLabel("Subscribe to newsletter")).isChecked();
// Select the radio button
page.getByLabel("XL").check();
選択オプション
Locator.selectOption() を使用して、<select> 要素で1つまたは複数のオプションを選択します。選択するオプションの value または label を指定できます。複数のオプションを選択できます。
// Single selection matching the value or label
page.getByLabel("Choose a color").selectOption("blue");
// Single selection matching the label
page.getByLabel("Choose a color").selectOption(new SelectOption().setLabel("Blue"));
// Multiple selected items
page.getByLabel("Choose multiple colors").selectOption(new String[] {"red", "green", "blue"});
マウスのクリック
単純な人間によるクリックを実行します。
// Generic click
page.getByRole(AriaRole.BUTTON).click();
// Double click
page.getByText("Item").dblclick();
// Right click
page.getByText("Item").click(new Locator.ClickOptions().setButton(MouseButton.RIGHT));
// Shift + click
page.getByText("Item").click(new Locator.ClickOptions().setModifiers(Arrays.asList(KeyboardModifier.SHIFT)));
// Ctrl + click on Windows and Linux
// Meta + click on macOS
page.getByText("Item").click(new Locator.ClickOptions().setModifiers(Arrays.asList(KeyboardModifier.CONTROL_OR_META)));
// Hover over element
page.getByText("Item").hover();
// Click the top left corner
page.getByText("Item").click(new Locator.ClickOptions().setPosition(0, 0));
内部的には、これおよび他のポインター関連のメソッドは、
- 指定されたセレクターを持つ要素がDOMに存在することを待つ
- 表示されるようになるのを待つ（つまり、空ではない、
display:noneではない、visibility:hiddenではない） - 移動が停止するのを待つ（たとえば、CSSトランジションが終了するまで）
- 要素をビューにスクロールする
- アクションポイントでポインターイベントを受信するのを待つ（たとえば、要素が他の要素によって隠されなくなるまで待つ）
- 上記のチェック中に要素がデタッチされた場合は再試行する
クリックを強制する
アプリによっては、要素をホバーすると別の要素が重なり、クリックがインターセプトされるような非自明なロジックを使用することがあります。この動作は、要素が隠れてクリックが別の場所にディスパッチされるバグと区別できません。このようなことが起きているとわかっている場合は、アクションアビリティ チェックをバイパスしてクリックを強制することができます。
page.getByRole(AriaRole.BUTTON).click(new Locator.ClickOptions().setForce(true));
プログラムによるクリック
実際の状況でアプリをテストすることに興味がなく、可能なあらゆる手段でクリックをシミュレートしたい場合は、Locator.dispatchEvent() を使用して要素にクリックイベントをディスパッチするだけで、HTMLElement.click() の動作をトリガーできます。
page.getByRole(AriaRole.BUTTON).dispatchEvent("click");
文字を入力する
ほとんどの場合、Locator.fill() を使用してテキストを入力する必要があります。上記のテキスト入力セクションを参照してください。ページに特殊なキーボード処理がある場合にのみ、文字を入力する必要があります。
Locator.pressSequentially() を使用して、実際のキーボードを持ったユーザーのように、1文字ずつフィールドに入力します。
// Press keys one by one
page.locator("#area").pressSequentially("Hello World!");
このメソッドは、必要なすべてのキーボードイベント（keydown、keyup、keypressイベントを含む）を発行します。キー押下間のオプションのdelayを指定して、実際のユーザーの動作をシミュレートすることもできます。
キーとショートカット
// Hit Enter
page.getByText("Submit").press("Enter");
// Dispatch Control+Right
page.getByRole(AriaRole.TEXTBOX).press("Control+ArrowRight");
// Press $ sign on keyboard
page.getByRole(AriaRole.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.setInputFiles() メソッドを使用して、アップロードする入力ファイルを選択できます。最初の引数は、タイプ "file" の 入力要素を指す必要があります。複数のファイルを配列で渡すことができます。ファイルパスの一部が相対パスの場合、現在の作業ディレクトリを基準に解決されます。空の配列は、選択されたファイルをクリアします。
// Select one file
page.getByLabel("Upload file").setInputFiles(Paths.get("myfile.pdf"));
// Select multiple files
page.getByLabel("Upload files").setInputFiles(new Path[] {Paths.get("file1.txt"), Paths.get("file2.txt")});
// Select a directory
page.getByLabel("Upload directory").setInputFiles(Paths.get("mydir"));
// Remove all the selected files
page.getByLabel("Upload file").setInputFiles(new Path[0]);
// Upload buffer from memory
page.getByLabel("Upload file").setInputFiles(new FilePayload(
"file.txt", "text/plain", "this is test".getBytes(StandardCharsets.UTF_8)));
入力要素が手元にない場合（動的に作成される場合）、Page.onFileChooser(handler) イベントを処理するか、アクションに対応する待機メソッドを使用できます。
FileChooser fileChooser = page.waitForFileChooser(() -> {
page.getByLabel("Upload file").click();
});
fileChooser.setFiles(Paths.get("myfile.pdf"));
要素にフォーカスを当てる
フォーカスイベントを処理する動的なページでは、Locator.focus() を使用して指定された要素にフォーカスを合わせることができます。
page.getByLabel("Password").focus();
ドラッグ＆ドロップ
Locator.dragTo() を使用してドラッグ＆ドロップ操作を実行できます。このメソッドは、
- ドラッグされる要素にホバーする。
- 左マウスボタンを押す。
- ドロップを受け取る要素にマウスを移動する。
- 左マウスボタンを離す。
page.locator("#item-to-be-dragged").dragTo(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.getByRole(AriaRole.BUTTON).click();
しかし、まれに手動でスクロールする必要がある場合があります。例えば、「無限リスト」にさらに要素を読み込ませたい場合や、特定のスクリーンショットのためにページを配置したい場合などです。そのような場合、最も確実な方法は、下部に表示させたい要素を見つけて、それをビューにスクロールすることです。
// Scroll the footer into view, forcing an "infinite list" to load more content
page.getByText("Footer text").scrollIntoViewIfNeeded();
スクロールをより正確に制御したい場合は、Mouse.wheel() または Locator.evaluate() を使用します。
// Position the mouse and scroll with the mouse wheel
page.getByTestId("scrolling-container").hover();
page.mouse.wheel(0, 10);
// Alternatively, programmatically scroll a specific element
page.getByTestId("scrolling-container").evaluate("e => e.scrollTop += 100");