Playwrightチートシート

TypeScript 5.1.3
Playwright 1.34.3

Browser関連

ヘッドフルで起動する

実際のブラウザを見ながら挙動を確認したい場合は、
ブラウザ起動時に{ headless: false }をオプションで渡してChroniumを起動します。

ヘッドフルで起動する

import { chromium } from 'playwright';

const browser = await chronium.launch({ headless: false });

参考：Playwright - BrowserType - headless

Cookieを取得

Cookieの取得はbrowserContext.cookies()を利用します。

なお、引数にURLとしてstringまたはstring[]が渡せます。
指定した場合は指定したURLのCookieを、
指定しない場合はブラウザが保持するすべてのCookieを取得できます。

Cookieの取得

const context = await browser.newContext();
const page = await context.newPage();
await page.goto('www.hogehoge.com');
const cookies = page.context().cookies();

参考：Playwright - BrowserContext - cookies

Page関連

指定したURLへ遷移

page.goto(url)を利用します。

指定したURLへ遷移

await page.goto('https://qiita.com/');

参考：Playwright - Page - goto

URLを取得

URLはpage.url()で取得できます。

URLを取得

await page.goto('https://qiita.com/');
const url = page.url();

スクリーンショット撮影とPDF生成

閲覧ページのスクリーンショットを撮影する時はpage.screenshot()を利用します。
オプションが色々用意されているので利用する際は是非公式を確認してください。
下記はフルスクリーンで./tmp/hoge.pngに書き出すサンプルです。

スクリーンショット撮影

await page.screenshot({ './tmp/hoge.png', fullPage: true });

閲覧ページをPDF化するにはpage.pdf()を利用します。
スクリーンショットと同様に多彩なオプションが用意されています。
また、screenshot()もpdf()も返り値はPromise<Buffer>となっており、オプションのパスを渡さない限りディスクへの保存はされません。

PDF生成

// Bufferとして受け取れる
const pdf = await page.pdf();

参考：

• Playwright - Page - screenshot
• Playwright - Page - pdf

ダイアログを操作する

JavaScriptによるダイアログを操作するにはpage.on('dialog')のリスナーを利用します。
リスナーを利用する際は必ずdialog.accept()かdialog.dismiss()を利用するようにしてください。

ダイアログを操作する

page.on('dialog', (dialog) => dialog.accept())

参考：Playwright - Page - on('dialog')

色々な待機処理

load, DOMContentLoaded, networkidle

loadやDOMContentLoadedの待機はおそらく最も利用することになると思います。
これらの待機にはpage.waitForLoadState(state)を利用します。

load, DOMContentLoaded, networkidleの待機

await page.waitForLoadState('load')
await page.waitForLoadState('domcontentloaded')
await page.waitForLoadState('networkidle')

なお、NetworkIdleは非推奨となっているので可能な限り利用を避けたほうが良さそうです。

参考：Playwright - Page - waitForLoadState

別タブページ、ポップアップページ、ダウンロードを待機待機

リンクをクリックした際に、別タブやポップアップでページが開かれるケースや、ダウンロードが始まる際の待機処理です。
これらの待機にはpage.context().waitForEvent(event)を用います。
指定したeventによって返り値が変わることに気を付けてください。

別タブページ、ポップアップページ、ダウンロード待機

// 別タブ（タブをPageとして受け取れる）
const tab = await page.context().waitForEvent('page');
// ポップアップ（ポップアップをPageとして受け取れる）
const popup = await page.context().waitForEvent('popup');
// ダウンロード（Downloadのオブジェクトを受け取れる）
const download = await page.context().waitForEvent('download');

参考：Playwright - BrowserContext - waitForEvent

レスポンスを待機

レスポンスを待機する時はpage.waitForResponse(urlOrPredicate)を利用します。
クリック後に画面遷移はしたけどAPIの通信はまだ完了してなくて、とかって時に有用かもしれません。
下記は指定したURLでメソッドがPOSTでステータスが200であることを待機するサンプルです。

レスポンスを待機

await page.waitForResponse(async (response) => {
  await response.finished();
  return (
    response.url() === 'www.hogehoge.com'
    && response.request().method() === 'POSE'
    && response.status() === 200
  );
})

参考：Playwright - Page - waitForResponse

Locator関連

※Locatorの操作は直感的なものが多いので表形式で列挙させてもらいます。

参考：Playwright - Locator

操作系

操作	メソッド	備考
クリック	click()
入力	fill(value)	似た挙動をするメソッドにtype(text)がありますが、typeはキーイベントを発火します。
チェック	check()
オプション選択	selectOption(value)	引数はstringまたはstring[]で配列を渡せば複数選択が可能です。
フォーカス	focus()

取得系

取得対象	メソッド	備考
テキスト	innerText()
HTML	innerHTML()
属性	getAttribute(name)	classやaltなどを取得する場合に利用します。
n個目	nth(index)	indexは0始まりのため、3個目の要素を取得する場合はnth(2)となります。

その他

ローカルファイルを読み込む

別記事https://qiita.com/rokumura7/items/d708c2cec6a7997556e7をご参照ください。

最後に

ザッとよく使うあたりを列挙してみました。
「こんな処理はどうするの？」という質問も、
「これはこうした方がいいのでは？」というマサカリも、
大歓迎です。