アクション
はじめに
Playwright は、テキスト入力、チェックボックス、ラジオボタン、セレクトオプション、マウスクリック、文字入力、キーとショートカット、ファイルのアップロード、要素へのフォーカスなど、HTML Input 要素を操作できます。
テキスト入力
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();
セレクトオプション
<select> 要素で Locator.selectOption() を使用して、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));
プログラマティッククリック
アプリケーションを実際の条件下でテストすることに関心がなく、可能な限りクリックをシミュレートしたい場合は、HTMLElement.click() の動作をトリガーできます。これは、Locator.dispatchEvent() を使用して要素にクリックイベントをディスパッチするだけで実現できます。
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 の input 要素を指す最初の引数を予期します。複数のファイルを配列で渡すことができます。一部のファイルパスが相対パスの場合、それらは現在の作業ディレクトリからの相対パスとして解決されます。空の配列は、選択されたファイルをクリアします。
// 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");