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

アクション

概要​

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

テキスト入力​

Locator.FillAsync() を使用すると、フォームフィールドを最も簡単に埋めることができます。これは要素にフォーカスし、入力されたテキストで input イベントをトリガーします。<input>、<textarea>、および [contenteditable] 要素で機能します。

// Text input
await page.GetByRole(AriaRole.Textbox).FillAsync("Peter");

// Date input
await page.GetByLabel("Birth date").FillAsync("2020-02-02");

// Time input
await page.GetByLabel("Appointment time").FillAsync("13-15");

// Local datetime input
await page.GetByLabel("Local time").FillAsync("2020-03-02T05:15");

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

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

// Check the checkbox
await page.GetByLabel("I agree to the terms above").CheckAsync();

// Assert the checked state
await Expect(page.GetByLabel("Subscribe to newsletter")).ToBeCheckedAsync();

// Select the radio button
await page.GetByLabel("XL").CheckAsync();

オプションの選択​

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

// Single selection matching the value or label
await page.GetByLabel("Choose a color").SelectOptionAsync("blue");

// Single selection matching the label
await page.GetByLabel("Choose a color").SelectOptionAsync(new SelectOptionValue { Label = "blue" });

// Multiple selected items
await page.GetByLabel("Choose multiple colors").SelectOptionAsync(new[] { "blue", "green", "red" });

マウスクリック​

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

// Generic click
await page.GetByRole(AriaRole.Button).ClickAsync();

// Double click
await page.GetByText("Item").DblClickAsync();

// Right click
await page.GetByText("Item").ClickAsync(new() { Button = MouseButton.Right });

// Shift + click
await page.GetByText("Item").ClickAsync(new() { Modifiers = new[] { KeyboardModifier.Shift } });

// Ctrl + click on Windows and Linux
// Meta + click on macOS
await page.GetByText("Item").ClickAsync(new() { Modifiers = new[] { KeyboardModifier.ControlOrMeta } });

// Hover over element
await page.GetByText("Item").HoverAsync();

// Click the top left corner
await page.GetByText("Item").ClickAsync(new() { position = new Position { X = 0, Y = 0 } });

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

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

クリックの強制​

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

await page.GetByRole(AriaRole.Button).ClickAsync(new() { Force = true });

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

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

await page.GetByRole(AriaRole.Button).DispatchEventAsync("click");

文字の入力​

注意

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

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

// Press keys one by one
await Page.Locator("#area").PressSequentiallyAsync("Hello World!");

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

キーとショートカット​

// Hit Enter
await page.GetByText("Submit").PressAsync("Enter");

// Dispatch Control+Right
await page.GetByRole(AriaRole.Textbox).PressAsync("Control+ArrowRight");

// Press $ sign on keyboard
await page.GetByRole(AriaRole.Textbox).PressAsync("$");

Locator.PressAsync() メソッドは、選択された要素にフォーカスし、単一のキーストロークを生成します。キーボードイベントの 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>
await page.Locator("#name").PressAsync("Shift+A");

// <input id=name>
await page.Locator("#name").PressAsync("Shift+ArrowLeft");

"Control+o" や "Control+Shift+T" のようなショートカットもサポートされています。修飾子とともに指定された場合、修飾子は押されたままになり、その後に続くキーが押されます。

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

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

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

// Select one file
await page.GetByLabel("Upload file").SetInputFilesAsync("myfile.pdf");

// Select multiple files
await page.GetByLabel("Upload files").SetInputFilesAsync(new[] { "file1.txt", "file12.txt" });

// Select a directory
await page.GetByLabel("Upload directory").SetInputFilesAsync("mydir");

// Remove all the selected files
await page.GetByLabel("Upload file").SetInputFilesAsync(new[] {});

// Upload buffer from memory
await page.GetByLabel("Upload file").SetInputFilesAsync(new FilePayload
{
    Name = "file.txt",
    MimeType = "text/plain",
    Buffer = System.Text.Encoding.UTF8.GetBytes("this is a test"),
});

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

var fileChooser = page.RunAndWaitForFileChooserAsync(async () =>
{
    await page.GetByLabel("Upload file").ClickAsync();
});
await fileChooser.SetFilesAsync("myfile.pdf");

要素のフォーカス​

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

await page.GetByLabel("Password").FocusAsync();

ドラッグ＆ドロップ​

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

  • ドラッグされる要素にホバーします。
  • マウスの左ボタンを押します。
  • ドロップ先となる要素にマウスを移動します。
  • マウスの左ボタンを離します。
await page.Locator("#item-to-be-dragged").DragToAsync(page.Locator("#item-to-drop-at"));

手動でのドラッグ​

ドラッグ操作をより細かく制御したい場合は、Locator.HoverAsync()、Mouse.DownAsync()、Mouse.MoveAsync()、および Mouse.UpAsync() などの低レベルメソッドを使用してください。

await page.Locator("#item-to-be-dragged").HoverAsync();
await page.Mouse.DownAsync();
await page.Locator("#item-to-drop-at").HoverAsync();
await page.Mouse.UpAsync();
注

ページが dragover イベントのディスパッチに依存している場合、すべてのブラウザでそれをトリガーするには少なくとも2回のマウス移動が必要です。2回目のマウス移動を確実に発行するには、Mouse.MoveAsync() または Locator.HoverAsync() を2回繰り返してください。操作の順序は、ドラッグ要素にホバー、マウスダウン、ドロップ要素にホバー、ドロップ要素に2回目ホバー、マウスアップとなります。

スクロール​

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

// Scrolls automatically so that button is visible
await page.GetByRole(AriaRole.Button).ClickAsync();

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

// Scroll the footer into view, forcing an "infinite list" to load more content
await page.GetByText("Footer text").ScrollIntoViewIfNeededAsync();

スクロールをより正確に制御したい場合は、Mouse.WheelAsync() または Locator.EvaluateAsync() を使用してください。

// Position the mouse and scroll with the mouse wheel
await page.GetByTestId("scrolling-container").HoverAsync();
await page.Mouse.WheelAsync(0, 10);

// Alternatively, programmatically scroll a specific element
await page.GetByTestId("scrolling-container").EvaluateAsync("e => e.scrollTop += 100");