Playwright Page クラス API リファレンス
Page は Playwright で最もよく使われるクラスであり、ページ操作のすべてのメソッドを提供します。
ナビゲーションメソッド
| メソッド | 説明 |
page.goto(url, options?) | URL へ移動 |
page.goBack(options?) | 戻る |
page.goForward(options?) | 進む |
page.reload(options?) | ページを更新 |
ロケーターメソッド
| メソッド | 説明 |
page.getByRole(role, options?) | ARIA ロールで特定 |
page.getByText(text, options?) | テキスト内容で特定 |
page.getByLabel(text, options?) | 関連する label で特定 |
page.getByPlaceholder(text) | placeholder で特定 |
page.getByAltText(text) | 画像の alt 属性で特定 |
page.getByTitle(text) | title 属性で特定 |
page.getByTestId(id) | data-testid で特定 |
page.locator(selector) | CSS / XPath ロケーター |
page.frameLocator(selector) | iframe ロケーター |
ページプロパティの取得
| メソッド | 説明 |
page.title() | ページタイトルを取得 |
page.url() | 現在の URL を取得 |
page.content() | 完全な HTML 内容を取得 |
page.viewportSize() | ビューポートサイズを取得 |
スクリーンショットと PDF
| メソッド | 説明 |
page.screenshot(options?) | ページスクリーンショット |
page.pdf(options?) | PDF 生成(Chromium のみ) |
page.video() | ビデオオブジェクトを取得 |
キーボードとマウス
| プロパティ | 説明 |
page.keyboard | Keyboard オブジェクト |
page.mouse | Mouse オブジェクト |
page.touchscreen | Touchscreen オブジェクト |
JS 実行
| メソッド | 説明 |
page.evaluate(fn, arg?) | ページコンテキストで JS を実行 |
page.evaluateHandle(fn, arg?) | JS を実行して JSHandle を返す |
page.addInitScript(script) | 初期化スクリプトを注入 |
page.addStyleTag(options?) | スタイルタグを追加 |
page.addScriptTag(options?) | スクリプトタグを追加 |
page.exposeFunction(name, fn) | ページに関数を公開 |
待機メソッド
| メソッド | 説明 |
page.waitForURL(url, options?) | URL の変化を待機 |
page.waitForLoadState(state?) | ロード状態を待機 |
page.waitForTimeout(ms) | 固定待機 |
page.waitForEvent(event, options?) | イベントを待機 |
page.waitForResponse(urlOrPredicate, options?) | ネットワークレスポンスを待機 |
page.waitForRequest(urlOrPredicate, options?) | ネットワークリクエストを待機 |
ネットワークとルーティング
| メソッド | 説明 |
page.route(url, handler) | ネットワークリクエストをインターセプト |
page.unroute(url, handler?) | インターセプトを解除 |
page.routeFromHAR(har, options?) | HAR ファイルからネットワークを再生 |
イベント
| イベント | 説明 |
page.on('request', handler) | リクエストを監視 |
page.on('response', handler) | レスポンスを監視 |
page.on('dialog', handler) | ポップアップを監視 |
page.on('download', handler) | ダウンロードを監視 |
page.on('popup', handler) | ポップアップページを監視 |
page.on('console', handler) | コンソールを監視 |
page.on('pageerror', handler) | ページエラーを監視 |
page.on('close', handler) | ページクローズを監視 |
Frame 関連
| メソッド | 説明 |
page.mainFrame() | メインフレームを取得 |
page.frames() | すべてのフレームを取得 |
その他
| メソッド | 説明 |
page.context() | 所属する BrowserContext を取得 |
page.close() | ページを閉じる |
page.pause() | 実行を一時停止(デバッグ用) |
page.setViewportSize(size) | ビューポートサイズを設定 |
page.bringToFront() | ページをフォアグラウンドに設定 |
page.emulateMedia(options?) | メディア特性をシミュレート |
page.clock | Clock オブジェクト(時間シミュレーション) |
PageAssertions(自動リトライアサーション)
| アサーションメソッド | 説明 |
expect(page).toHaveTitle(title) | ページタイトルのアサーション |
expect(page).toHaveURL(url) | ページ URL のアサーション |
expect(page).toHaveScreenshot(options?) | ページスクリーンショット比較 |
その他の拡張