アクション
はじめに
Playwrightは、テキスト入力、チェックボックス、ラジオボタン、選択オプション、マウスのクリック、文字入力、キーとショートカット、ファイルのアップロード、要素へのフォーカスなど、HTML入力要素とインタラクトできます。
テキスト入力
locator.fill()を使用するのが、フォームフィールドに入力する最も簡単な方法です。これにより、要素にフォーカスが当てられ、入力されたテキストでinputイベントがトリガーされます。これは、<input>、<textarea>、および[contenteditable]要素で機能します。
// Text input
await page.getByRole('textbox').fill('Peter');
// Date input
await page.getByLabel('Birth date').fill('2020-02-02');
// Time input
await page.getByLabel('Appointment time').fill('13:15');
// Local datetime input
await page.getByLabel('Local time').fill('2020-03-02T05:15');
チェックボックスとラジオボタン
locator.setChecked()を使用するのが、チェックボックスまたはラジオボタンをチェックまたはチェック解除する最も簡単な方法です。このメソッドは、input[type=checkbox]、input[type=radio]、および[role=checkbox]要素で使用できます。
// Check the checkbox
await page.getByLabel('I agree to the terms above').check();
// Assert the checked state
expect(page.getByLabel('Subscribe to newsletter')).toBeChecked();
// Select the radio button
await page.getByLabel('XL').check();
選択オプション
locator.selectOption()を使用して、<select>要素で1つまたは複数のオプションを選択します。選択するオプションのvalueまたはlabelを指定できます。複数のオプションを選択できます。
// Single selection matching the value or label
await page.getByLabel('Choose a color').selectOption('blue');
// Single selection matching the label
await page.getByLabel('Choose a color').selectOption({ label: 'Blue' });
// Multiple selected items
await page.getByLabel('Choose multiple colors').selectOption(['red', 'green', 'blue']);
マウスのクリック
単純な人間によるクリックを実行します。
// Generic click
await page.getByRole('button').click();
// Double click
await page.getByText('Item').dblclick();
// Right click
await page.getByText('Item').click({ button: 'right' });
// Shift + click
await page.getByText('Item').click({ modifiers: ['Shift'] });
// Ctrl + click on Windows and Linux
// Meta + click on macOS
await page.getByText('Item').click({ modifiers: ['ControlOrMeta'] });
// Hover over element
await page.getByText('Item').hover();
// Click the top left corner
await page.getByText('Item').click({ position: { x: 0, y: 0 } });
内部的には、これおよび他のポインター関連のメソッドは、
- 指定されたセレクターを持つ要素がDOMに存在することを待つ
- 表示されるようになるのを待つ（つまり、空ではない、
display:noneではない、visibility:hiddenではない） - 移動が停止するのを待つ（たとえば、CSSトランジションが終了するまで）
- 要素をビューにスクロールする
- アクションポイントでポインターイベントを受信するのを待つ（たとえば、要素が他の要素によって隠されなくなるまで待つ）
- 上記のチェック中に要素がデタッチされた場合は再試行する
クリックを強制する
場合によっては、要素にホバーすると、クリックをインターセプトする別の要素がその上に重なるような、些細ではないロジックをアプリが使用することがあります。この動作は、要素が覆われてクリックが別の場所にディスパッチされるバグと区別できません。これが起こっていることがわかっている場合、アクションアビリティチェックをバイパスしてクリックを強制することができます。
await page.getByRole('button').click({ force: true });
プログラムによるクリック
実際の条件下でアプリをテストすることに興味がなく、可能な限りクリックをシミュレートしたい場合は、locator.dispatchEvent()を使用して要素にクリックイベントをディスパッチするだけで、HTMLElement.click()の動作をトリガーできます。
await page.getByRole('button').dispatchEvent('click');
文字を入力する
ほとんどの場合、locator.fill()を使用してテキストを入力する必要があります。上記の「テキスト入力」セクションを参照してください。ページに特別なキーボード処理がある場合にのみ、文字を入力する必要があります。
locator.pressSequentially()を使用して、実際のキーボードを持つユーザーのように、フィールドに文字を1文字ずつ入力します。
// Press keys one by one
await page.locator('#area').pressSequentially('Hello World!');
このメソッドは、必要なすべてのキーボードイベント（keydown、keyup、keypressイベントを含む）を発行します。キー押下間のオプションのdelayを指定して、実際のユーザーの動作をシミュレートすることもできます。
キーとショートカット
// Hit Enter
await page.getByText('Submit').press('Enter');
// Dispatch Control+Right
await page.getByRole('textbox').press('Control+ArrowRight');
// Press $ sign on keyboard
await page.getByRole('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>
await page.locator('#name').press('Shift+A');
// <input id=name>
await page.locator('#name').press('Shift+ArrowLeft');
"Control+o"や"Control+Shift+T"のようなショートカットもサポートされています。修飾子とともに指定された場合、修飾子が押され、その後のキーが押されている間も保持されます。
大文字の文字を生成するには、Shift-Aで大文字のAを指定する必要があることに注意してください。Shift-aは、CapsLockがオンになっているかのように小文字の文字を生成します。
ファイルのアップロード
locator.setInputFiles()メソッドを使用して、アップロードする入力ファイルを選択できます。最初の引数として、タイプが"file"のinput要素を指すことを期待します。複数のファイルを配列で渡すことができます。ファイルパスの一部が相対パスの場合、現在の作業ディレクトリを基準に解決されます。空の配列は選択されたファイルをクリアします。
// Select one file
await page.getByLabel('Upload file').setInputFiles(path.join(__dirname, 'myfile.pdf'));
// Select multiple files
await page.getByLabel('Upload files').setInputFiles([
path.join(__dirname, 'file1.txt'),
path.join(__dirname, 'file2.txt'),
]);
// Select a directory
await page.getByLabel('Upload directory').setInputFiles(path.join(__dirname, 'mydir'));
// Remove all the selected files
await page.getByLabel('Upload file').setInputFiles([]);
// Upload buffer from memory
await page.getByLabel('Upload file').setInputFiles({
name: 'file.txt',
mimeType: 'text/plain',
buffer: Buffer.from('this is test')
});
入力要素が手元にない場合（動的に作成される場合）、page.on('filechooser')イベントを処理するか、アクションに対応する待機メソッドを使用できます。
// Start waiting for file chooser before clicking. Note no await.
const fileChooserPromise = page.waitForEvent('filechooser');
await page.getByLabel('Upload file').click();
const fileChooser = await fileChooserPromise;
await fileChooser.setFiles(path.join(__dirname, 'myfile.pdf'));
要素にフォーカスを当てる
フォーカスイベントを処理する動的ページの場合、locator.focus()を使用して指定された要素にフォーカスを当てることができます。
await page.getByLabel('Password').focus();
ドラッグ＆ドロップ
locator.dragTo()を使用してドラッグ＆ドロップ操作を実行できます。このメソッドは、
- ドラッグされる要素にホバーする。
- 左マウスボタンを押す。
- ドロップを受け取る要素にマウスを移動する。
- 左マウスボタンを離す。
await page.locator('#item-to-be-dragged').dragTo(page.locator('#item-to-drop-at'));
手動でのドラッグ
ドラッグ操作を正確に制御したい場合は、locator.hover()、mouse.down()、mouse.move()、mouse.up()のような低レベルのメソッドを使用してください。
await page.locator('#item-to-be-dragged').hover();
await page.mouse.down();
await page.locator('#item-to-drop-at').hover();
await page.mouse.up();
ページがdragoverイベントのディスパッチに依存している場合、すべてのブラウザでそれをトリガーするには少なくとも2回のマウス移動が必要です。2回目のマウス移動を確実に発行するには、mouse.move()またはlocator.hover()を2回繰り返します。操作の順序は、ドラッグ要素にホバー、マウスダウン、ドロップ要素にホバー、ドロップ要素に2回目ホバー、マウスアップとなります。
スクロール
ほとんどの場合、Playwrightはアクションを実行する前に自動的にスクロールを行います。したがって、明示的にスクロールする必要はありません。
// Scrolls automatically so that button is visible
await page.getByRole('button').click();
しかし、まれに手動でスクロールする必要がある場合があります。例えば、「無限リスト」にさらに要素を読み込ませたい場合や、特定のスクリーンショットのためにページを配置したい場合などです。そのような場合、最も確実な方法は、下部に表示させたい要素を見つけて、それをビューにスクロールすることです。
// Scroll the footer into view, forcing an "infinite list" to load more content
await page.getByText('Footer text').scrollIntoViewIfNeeded();
スクロールをより正確に制御したい場合は、mouse.wheel()またはlocator.evaluate()を使用してください。
// Position the mouse and scroll with the mouse wheel
await page.getByTestId('scrolling-container').hover();
await page.mouse.wheel(0, 10);
// Alternatively, programmatically scroll a specific element
await page.getByTestId('scrolling-container').evaluate(e => e.scrollTop += 100);