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

Page

Pageは、Browser内の単一タブ、またはChromium内の拡張機能のバックグラウンドページと対話するためのメソッドを提供します。1つのBrowserインスタンスには、複数のPageインスタンスが存在する場合があります。

この例では、ページを作成し、URLにナビゲートしてから、スクリーンショットを保存します。

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch();
      BrowserContext context = browser.newContext();
      Page page = context.newPage();
      page.navigate("https://example.com");
      page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("screenshot.png")));
      browser.close();
    }
  }
}

Pageクラスは、on、once、removeListenerなどのNodeのネイティブなEventEmitterメソッドを使用して処理できるさまざまなイベント（以下に説明）を発行します。

この例では、単一ページのloadイベントのメッセージをログに記録します。

page.onLoad(p -> System.out.println("Page loaded!"));

イベントの登録を解除するには、removeListenerメソッドを使用します。

Consumer<Request> logRequest = interceptedRequest -> {
  System.out.println("A request was made: " + interceptedRequest.url());
};
page.onRequest(logRequest);
// Sometime later...
page.offRequest(logRequest);

メソッド​

addInitScript​

v1.9より前に追加 page.addInitScript

以下のいずれかのシナリオで評価されるスクリプトを追加します。

  • ページがナビゲートされるたびに。
  • 子フレームがアタッチまたはナビゲートされるたびに。この場合、スクリプトは新しくアタッチされたフレームのコンテキストで評価されます。

スクリプトは、ドキュメントが作成された後、そのスクリプトが実行される前に評価されます。これは、JavaScript 環境を修正する場合に役立ちます (例: Math.random をシードする場合)。

使用法

ページが読み込まれる前に Math.random をオーバーライドする例

// preload.js
Math.random = () => 42;
// In your playwright script, assuming the preload.js file is in same directory
page.addInitScript(Paths.get("./preload.js"));
注

BrowserContext.addInitScript()とPage.addInitScript()を介してインストールされた複数のスクリプトの評価順序は定義されていません。

引数

  • script String | Path#

    ブラウザコンテキスト内のすべてのページで評価されるスクリプト。

戻り値

addLocatorHandler​

追加バージョン: v1.42 page.addLocatorHandler

ウェブページをテストしていると、「サインアップ」ダイアログのような予期しないオーバーレイが表示され、ボタンのクリックなどの自動化したいアクションがブロックされることがあります。これらのオーバーレイは常に同じように、または同じ時間に表示されるわけではないため、自動テストで処理するのが難しいです。

このメソッドを使用すると、オーバーレイが表示されていることを検出したときにアクティブになる、ハンドラーと呼ばれる特別な関数を設定できます。ハンドラーの役割はオーバーレイを削除し、オーバーレイがないかのようにテストを続行できるようにすることです。

留意すべき点

  • オーバーレイが予測可能に表示される場合、Page.addLocatorHandler()を使用する代わりに、テストで明示的にオーバーレイを待機し、通常のテストフローの一部として閉じることをお勧めします。
  • Playwrightは、アクション可能性チェックを必要とするアクションを実行または再試行するたびに、または自動待機アサーションチェックを実行する前に、オーバーレイをチェックします。オーバーレイが表示されている場合、Playwrightは最初にハンドラーを呼び出し、その後アクション/アサーションに進みます。ハンドラーは、アクション/アサーションを実行した場合にのみ呼び出されることに注意してください。オーバーレイが表示されてもアクションを実行しない場合、ハンドラーはトリガーされません。
  • ハンドラーの実行後、Playwrightはハンドラーをトリガーしたオーバーレイがもう表示されていないことを確認します。setNoWaitAfterを使用すると、この動作をオプトアウトできます。
  • ハンドラーの実行時間は、ハンドラーを実行したアクション/アサーションのタイムアウトにカウントされます。ハンドラーの実行時間が長すぎると、タイムアウトが発生する可能性があります。
  • 複数のハンドラーを登録できます。ただし、一度に実行されるハンドラーは1つだけです。ハンドラー内のアクションが他のハンドラーに依存しないようにしてください。
警告

ハンドラーを実行すると、テスト中にページのステートが変更されます。たとえば、現在フォーカスされている要素が変更され、マウスが移動します。ハンドラーの後に実行されるアクションが自己完結型であり、フォーカスとマウスのステートが変更されていないことに依存しないことを確認してください。

たとえば、Locator.focus()の後にKeyboard.press()を呼び出すテストを考えてみましょう。これら2つのアクションの間にハンドラーがボタンをクリックした場合、フォーカスされた要素は間違っている可能性が高く、キープレスは予期しない要素で発生します。この問題を回避するには、代わりにLocator.press()を使用してください。

もう1つの例は、Mouse.move()の後にMouse.down()が続く一連のマウスアクションです。この場合も、これら2つのアクションの間にハンドラーが実行されると、マウスダウン中にマウスの位置が間違っています。ハンドラーによって状態が変更されないことに依存しない、Locator.click()のような自己完結型のアクションを優先してください。

使用法

「ニュースレターに登録する」ダイアログが表示されたときに閉じる例

// Setup the handler.
page.addLocatorHandler(page.getByText("Sign up to the newsletter"), () -> {
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("No thanks")).click();
});

// Write the test as usual.
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("Start here")).click();

「セキュリティ詳細の確認」ページが表示されたときにスキップする例

// Setup the handler.
page.addLocatorHandler(page.getByText("Confirm your security details"), () -> {
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Remind me later")).click();
});

// Write the test as usual.
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("Start here")).click();

すべてのアクション可能性チェックでカスタムコールバックを使用する例です。常に表示されるロケーターを使用するため、ハンドラーはすべてのアクション可能性チェックの前に呼び出されます。ハンドラーは要素を非表示にしないため、setNoWaitAfterを指定することが重要です。

// Setup the handler.
page.addLocatorHandler(page.locator("body"), () -> {
  page.evaluate("window.removeObstructionsForTestIfNeeded()");
}, new Page.AddLocatorHandlerOptions().setNoWaitAfter(true));

// Write the test as usual.
page.navigate("https://example.com");
page.getByRole("button", Page.GetByRoleOptions().setName("Start here")).click();

ハンドラーは元のロケーターを引数として受け取ります。setTimesを設定することで、呼び出し回数後にハンドラーを自動的に削除することもできます。

page.addLocatorHandler(page.getByLabel("Close"), locator -> {
  locator.click();
}, new Page.AddLocatorHandlerOptions().setTimes(1));

引数

  • locator Locator#

    ハンドラーをトリガーするロケーター。

  • handler Consumer<Locator>#

    locatorが表示されたときに実行される関数。この関数は、クリックなどのアクションをブロックする要素を取り除く必要があります。

  • options Page.AddLocatorHandlerOptions (任意)

    • setNoWaitAfter boolean (任意)追加バージョン: v1.44#

      デフォルトでは、ハンドラーを呼び出した後、Playwrightはオーバーレイが非表示になるまで待機し、その後、ハンドラーをトリガーしたアクション/アサーションを続行します。このオプションを使用すると、この動作をオプトアウトできるため、ハンドラーの実行後もオーバーレイを表示したままにすることができます。

    • setTimes int (任意)追加バージョン: v1.44#

      このハンドラーが呼び出される最大回数を指定します。デフォルトは無制限です。

戻り値

addScriptTag​

v1.9より前に追加 page.addScriptTag

目的のURLまたはコンテンツを持つ<script>タグをページに追加します。スクリプトのonloadが発火したとき、またはスクリプトコンテンツがフレームに挿入されたときに、追加されたタグを返します。

使用法

Page.addScriptTag();
Page.addScriptTag(options);

引数

  • options Page.AddScriptTagOptions (任意)

    • setContent String (任意)#

      フレームに挿入される生のJavaScriptコンテンツ。

    • setPath Path (任意)#

      フレームに挿入されるJavaScriptファイルへのパス。pathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。

    • setType String (任意)#

      スクリプトの種類。JavaScript ES6モジュールをロードするには、「module」を使用します。詳細については、scriptを参照してください。

    • setUrl String (任意)#

      追加するスクリプトのURL。

戻り値

addStyleTag​

v1.9より前に追加 page.addStyleTag

目的のURLを持つ<link rel="stylesheet">タグ、またはコンテンツを持つ<style type="text/css">タグをページに追加します。スタイルシートのonloadが発火したとき、またはCSSコンテンツがフレームに挿入されたときに、追加されたタグを返します。

使用法

Page.addStyleTag();
Page.addStyleTag(options);

引数

  • options Page.AddStyleTagOptions (任意)

    • setContent String (任意)#

      フレームに挿入される生のCSSコンテンツ。

    • setPath Path (任意)#

      フレームに挿入されるCSSファイルへのパス。pathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。

    • setUrl String (任意)#

      <link>タグのURL。

戻り値

bringToFront​

v1.9より前に追加 page.bringToFront

ページを前面に表示します（タブをアクティブにします）。

使用法

Page.bringToFront();

戻り値

close​

v1.9より前に追加 page.close

setRunBeforeUnloadがfalseの場合、アンロードハンドラーは実行されず、ページが閉じるのを待ちます。setRunBeforeUnloadがtrueの場合、このメソッドはアンロードハンドラーを実行しますが、ページが閉じるのを待機しません。

デフォルトでは、page.close()はbeforeunloadハンドラーを実行しません。

注

setRunBeforeUnloadがtrueとして渡された場合、beforeunloadダイアログが呼び出される可能性があり、Page.onDialog(handler)イベントを介して手動で処理する必要があります。

使用法

Page.close();
Page.close(options);

引数

  • options Page.CloseOptions (任意)

    • setReason String (オプション)追加されたバージョン: v1.40#

      ページの閉鎖によって中断された操作に報告される理由。

    • setRunBeforeUnload boolean (任意)#

      デフォルトはfalseです。before unloadページハンドラーを実行するかどうか。

戻り値

content​

v1.9より前に追加 page.content

doctypeを含む、ページの完全なHTMLコンテンツを取得します。

使用法

Page.content();

戻り値

context​

v1.9より前に追加 page.context

ページが属するブラウザコンテキストを取得します。

使用法

Page.context();

戻り値

dragAndDrop​

追加バージョン: v1.13 page.dragAndDrop

このメソッドは、ソース要素をターゲット要素にドラッグします。まずソース要素に移動し、mousedownを実行し、次にターゲット要素に移動してmouseupを実行します。

使用法

page.dragAndDrop("#source", "#target");
// or specify exact positions relative to the top-left corners of the elements:
page.dragAndDrop("#source", "#target", new Page.DragAndDropOptions()
  .setSourcePosition(34, 7).setTargetPosition(10, 20));

引数

  • source String#

    ドラッグする要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合、最初のものが使用されます。

  • target String#

    ドロップする要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合、最初のものが使用されます。

  • options Page.DragAndDropOptions (任意)

    • setForce boolean (任意)#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setSourcePosition SourcePosition (任意)追加されたバージョン: v1.14#

      要素のパディングボックスの左上隅を基準としたこの点でソース要素をクリックします。指定しない場合、要素のいくつかの可視点が使用されます。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTargetPosition TargetPosition (任意)追加されたバージョン: v1.14#

      要素のパディングボックスの左上隅を基準としたこの点でターゲット要素にドロップします。指定しない場合、要素のいくつかの可視点が使用されます。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setTrial boolean (任意)#

      設定すると、このメソッドは アクション可能性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備ができるまで待機するのに便利です。

戻り値

emulateMedia​

v1.9より前に追加 page.emulateMedia

このメソッドは、media引数によってCSS media typeを、および/またはcolorScheme引数を使用して'prefers-colors-scheme'メディア機能を変更します。

使用法

page.evaluate("() => matchMedia('screen').matches");
// → true
page.evaluate("() => matchMedia('print').matches");
// → false

page.emulateMedia(new Page.EmulateMediaOptions().setMedia(Media.PRINT));
page.evaluate("() => matchMedia('screen').matches");
// → false
page.evaluate("() => matchMedia('print').matches");
// → true

page.emulateMedia(new Page.EmulateMediaOptions());
page.evaluate("() => matchMedia('screen').matches");
// → true
page.evaluate("() => matchMedia('print').matches");
// → false
page.emulateMedia(new Page.EmulateMediaOptions().setColorScheme(ColorScheme.DARK));
page.evaluate("() => matchMedia('(prefers-color-scheme: dark)').matches");
// → true
page.evaluate("() => matchMedia('(prefers-color-scheme: light)').matches");
// → false

引数

  • options Page.EmulateMediaOptions (任意)

    • setColorScheme null | enum ColorScheme { LIGHT, DARK, NO_PREFERENCE } (任意)追加バージョン: v1.9#

      prefers-colors-schemeメディア機能をエミュレートします。サポートされる値は'light'と'dark'です。nullを渡すと、カラースキームのエミュレーションが無効になります。'no-preference'は非推奨です。

    • setContrast null | enum Contrast { NO_PREFERENCE, MORE } (任意)追加バージョン: v1.51#

      'prefers-contrast'メディア機能をエミュレートします。サポートされる値は'no-preference'、'more'です。nullを渡すと、コントラストエミュレーションが無効になります。

    • setForcedColors null | enum ForcedColors { ACTIVE, NONE } (任意)追加されたバージョン: v1.15#

      'forced-colors'メディア機能をエミュレートします。サポートされる値は'active'と'none'です。nullを渡すと、強制色エミュレーションが無効になります。

    • setMedia null | enum Media { SCREEN, PRINT } (任意)追加バージョン: v1.9#

      ページのCSSメディアタイプを変更します。許可される値は'screen'、'print'、nullのみです。nullを渡すと、CSSメディアエミュレーションが無効になります。

    • setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE } (任意)追加日: v1.12#

      'prefers-reduced-motion'メディア機能をエミュレートします。サポートされる値は'reduce'、'no-preference'です。nullを渡すと、モーション削減エミュレーションが無効になります。

戻り値

evaluate​

v1.9より前に追加 page.evaluate

expression呼び出しの値を返します。

Page.evaluate()に渡された関数がPromiseを返す場合、Page.evaluate()はそのPromiseが解決されるのを待ってその値を返します。

Page.evaluate()に渡された関数が非Serializable値を返す場合、Page.evaluate()はundefinedに解決されます。Playwrightは、JSONによってシリアル化できないいくつかの追加値も転送をサポートしています: -0、NaN、Infinity、-Infinity。

使用法

expressionへの引数渡し

Object result = page.evaluate("([x, y]) => {\n" +
  "  return Promise.resolve(x * y);\n" +
  "}", Arrays.asList(7, 8));
System.out.println(result); // prints "56"

関数ではなく文字列を渡すこともできます。

System.out.println(page.evaluate("1 + 2")); // prints "3"

ElementHandleインスタンスは、Page.evaluate()への引数として渡すことができます。

ElementHandle bodyHandle = page.evaluate("document.body");
String html = (String) page.evaluate("([body, suffix]) => body.innerHTML + suffix", Arrays.asList(bodyHandle, "hello"));
bodyHandle.dispose();

引数

  • expression String#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (任意)#

    expressionに渡すオプション引数。

戻り値

evaluateHandle​

v1.9より前に追加 page.evaluateHandle

expression呼び出しの値をJSHandleとして返します。

Page.evaluate()とPage.evaluateHandle()の唯一の違いは、Page.evaluateHandle()がJSHandleを返すことです。

Page.evaluateHandle()に渡された関数がPromiseを返す場合、Page.evaluateHandle()はそのPromiseが解決されるのを待ってその値を返します。

使用法

// Handle for the window object.
JSHandle aWindowHandle = page.evaluateHandle("() => Promise.resolve(window)");

関数ではなく文字列を渡すこともできます。

JSHandle aHandle = page.evaluateHandle("document"); // Handle for the "document".

JSHandleインスタンスは、Page.evaluateHandle()への引数として渡すことができます。

JSHandle aHandle = page.evaluateHandle("() => document.body");
JSHandle resultHandle = page.evaluateHandle("([body, suffix]) => body.innerHTML + suffix", Arrays.asList(aHandle, "hello"));
System.out.println(resultHandle.jsonValue());
resultHandle.dispose();

引数

  • expression String#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (任意)#

    expressionに渡すオプション引数。

戻り値

exposeBinding​

v1.9より前に追加 page.exposeBinding

このメソッドは、このページのすべてのフレームのwindowオブジェクトにnameという関数を追加します。呼び出されると、この関数はcallbackを実行し、Promiseを返します。このPromiseはcallbackの戻り値に解決されます。callbackがPromiseを返す場合、それは待機されます。

callback関数の最初の引数には、呼び出し元に関する情報が含まれます: { browserContext: BrowserContext, page: Page, frame: Frame }。

コンテキスト全体にわたるバージョンについては、BrowserContext.exposeBinding()を参照してください。

注

Page.exposeBinding()を介してインストールされた関数はナビゲーション後も存続します。

使用法

ページURLをページのすべてのフレームに公開する例

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
      BrowserContext context = browser.newContext();
      Page page = context.newPage();
      page.exposeBinding("pageURL", (source, args) -> source.page().url());
      page.setContent("<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.pageURL();\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>");
      page.click("button");
    }
  }
}

引数

  • name String#

    ウィンドウオブジェクト上の関数の名前。

  • callback BindingCallback#

    Playwright のコンテキストで呼び出されるコールバック関数。

  • options Page.ExposeBindingOptions (任意)

    • setHandle boolean (任意)#

      非推奨

      このオプションは将来削除されます。

      引数を値で渡す代わりに、ハンドルとして渡すかどうか。ハンドルとして渡す場合、引数は1つのみサポートされます。値で渡す場合、複数の引数がサポートされます。

戻り値

exposeFunction​

v1.9より前に追加 page.exposeFunction

このメソッドは、ページのすべてのフレームのwindowオブジェクトにnameという関数を追加します。呼び出されると、この関数はcallbackを実行し、Promiseを返します。このPromiseはcallbackの戻り値に解決されます。

callbackがPromiseを返す場合、それは待機されます。

コンテキスト全体にわたる公開関数については、BrowserContext.exposeFunction()を参照してください。

注

Page.exposeFunction()を介してインストールされた関数はナビゲーション後も存続します。

使用法

ページにsha256関数を追加する例

import com.microsoft.playwright.*;

import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
      Page page = browser.newPage();
      page.exposeFunction("sha256", args -> {
        try {
          String text = (String) args[0];
          MessageDigest crypto = MessageDigest.getInstance("SHA-256");
          byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));
          return Base64.getEncoder().encodeToString(token);
        } catch (NoSuchAlgorithmException e) {
          return null;
        }
      });
      page.setContent(
        "<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>"
      );
      page.click("button");
    }
  }
}

引数

  • name String#

    windowオブジェクト上の関数の名前。

  • callback FunctionCallback#

    Playwrightのコンテキストで呼び出されるコールバック関数。

戻り値

frame​

v1.9より前に追加 page.frame

指定された条件に一致するフレームを返します。nameまたはurlのいずれかを指定する必要があります。

使用法

Frame frame = page.frame("frame-name");
Frame frame = page.frameByUrl(Pattern.compile(".*domain.*"));

引数

  • name String追加バージョン: v1.9#

    iframeのname属性で指定されたフレーム名。

戻り値

frameByUrl​

追加バージョン: v1.9 page.frameByUrl

一致するURLを持つフレームを返します。

使用法

Page.frameByUrl(url);

引数

  • url String | Pattern | Predicate<String>#

    フレームのurlを[URL]オブジェクトとして受け取るグロブパターン、正規表現パターン、または述語。

戻り値

frameLocator​

追加バージョン: v1.17 page.frameLocator

iframeを操作する場合、iframeに入り、そのiframe内の要素を選択できるフレームロケーターを作成できます。

使用法

次のスニペットは、IDがmy-frameのiframeにあるテキスト「Submit」を持つ要素を検索します（例: <iframe id="my-frame">）。

Locator locator = page.frameLocator("#my-iframe").getByText("Submit");
locator.click();

引数

  • selector String#

    DOM要素を解決するときに使用するセレクター。

戻り値

frames​

v1.9より前に追加 page.frames

ページにアタッチされたすべてのフレームの配列。

使用法

Page.frames();

戻り値

getByAltText​

追加バージョン: v1.27 page.getByAltText

要素をそのaltテキストで特定できます。

使用法

例えば、このメソッドはaltテキスト「Playwright logo」で画像を見つけます。

<img alt='Playwright logo'>
page.getByAltText("Playwright logo").click();

引数

  • text String | Pattern#

    要素を特定するためのテキスト。

  • options Page.GetByAltTextOptions (任意)

    • setExact boolean (任意)#

      完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

getByLabel​

追加バージョン: v1.27 page.getByLabel

関連する<label>またはaria-labelledby要素のテキスト、またはaria-label属性によって入力要素を特定できます。

使用法

例えば、このメソッドは以下のDOMでラベル「Username」と「Password」を持つ入力を見つけます。

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
page.getByLabel("Username").fill("john");
page.getByLabel("Password").fill("secret");

引数

  • text String | Pattern#

    要素を特定するためのテキスト。

  • options Page.GetByLabelOptions (任意)

    • setExact boolean (任意)#

      完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

getByPlaceholder​

追加バージョン: v1.27 page.getByPlaceholder

プレースホルダーテキストによって入力要素を特定できます。

使用法

例えば、以下のDOM構造を考えてみましょう。

<input type="email" placeholder="name@example.com" />

プレースホルダーテキストで入力を見つけてから、入力できます。

page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");

引数

  • text String | Pattern#

    要素を特定するためのテキスト。

  • options Page.GetByPlaceholderOptions (任意)

    • setExact boolean (任意)#

      完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

getByRole​

追加バージョン: v1.27 page.getByRole

要素をそのARIAロール、ARIA属性、およびアクセシブルネームで特定できます。

使用法

以下のDOM構造を考えてみましょう。

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

各要素をその暗黙的なロールで特定できます。

assertThat(page
    .getByRole(AriaRole.HEADING,
               new Page.GetByRoleOptions().setName("Sign up")))
    .isVisible();

page.getByRole(AriaRole.CHECKBOX,
               new Page.GetByRoleOptions().setName("Subscribe"))
    .check();

page.getByRole(AriaRole.BUTTON,
               new Page.GetByRoleOptions().setName(
                   Pattern.compile("submit", Pattern.CASE_INSENSITIVE)))
    .click();

引数

  • role enum AriaRole { ALERT, ALERTDIALOG, APPLICATION, ARTICLE, BANNER, BLOCKQUOTE, BUTTON, CAPTION, CELL, CHECKBOX, CODE, COLUMNHEADER, COMBOBOX, COMPLEMENTARY, CONTENTINFO, DEFINITION, DELETION, DIALOG, DIRECTORY, DOCUMENT, EMPHASIS, FEED, FIGURE, FORM, GENERIC, GRID, GRIDCELL, GROUP, HEADING, IMG, INSERTION, LINK, LIST, LISTBOX, LISTITEM, LOG, MAIN, MARQUEE, MATH, METER, MENU, MENUBAR, MENUITEM, MENUITEMCHECKBOX, MENUITEMRADIO, NAVIGATION, NONE, NOTE, OPTION, PARAGRAPH, PRESENTATION, PROGRESSBAR, RADIO, RADIOGROUP, REGION, ROW, ROWGROUP, ROWHEADER, SCROLLBAR, SEARCH, SEARCHBOX, SEPARATOR, SLIDER, SPINBUTTON, STATUS, STRONG, SUBSCRIPT, SUPERSCRIPT, SWITCH, TAB, TABLE, TABLIST, TABPANEL, TERM, TEXTBOX, TIME, TIMER, TOOLBAR, TOOLTIP, TREE, TREEGRID, TREEITEM }#

    必須のariaロール。

  • options Page.GetByRoleOptions (任意)

    • setChecked boolean (任意)#

      通常、aria-checkedまたはネイティブの<input type=checkbox>コントロールによって設定される属性。

      aria-checkedの詳細。

    • setDisabled boolean (任意)#

      通常、aria-disabledまたはdisabledによって設定される属性。

      注

      他のほとんどの属性とは異なり、disabledはDOM階層を介して継承されます。aria-disabledの詳細。

    • setExact boolean (任意)追加バージョン: v1.28#

      setNameが完全に一致するかどうか: 大文字と小文字を区別し、文字列全体を一致させます。デフォルトはfalseです。setNameが正規表現の場合は無視されます。完全一致でも空白はトリミングされます。

    • setExpanded boolean (任意)#

      通常、aria-expandedによって設定される属性。

      aria-expandedの詳細。

    • setIncludeHidden boolean (任意)#

      非表示要素が一致するかどうかを制御するオプション。デフォルトでは、ARIAで定義されているように、非表示でない要素のみがロールセレクターによって一致します。

      aria-hiddenの詳細。

    • setLevel int (任意)#

      通常、heading、listitem、row、treeitemのロールに存在する数値属性で、<h1>-<h6>要素のデフォルト値があります。

      aria-levelの詳細。

    • setName String | Pattern (任意)#

      アクセシブルネームに一致するオプション。デフォルトでは、大文字と小文字を区別せず部分文字列を検索します。setExactを使用してこの動作を制御します。

      アクセシブルネームの詳細。

    • setPressed boolean (任意)#

      通常、aria-pressedによって設定される属性。

      aria-pressedの詳細。

    • setSelected boolean (任意)#

      通常、aria-selectedによって設定される属性。

      aria-selectedの詳細。

戻り値

詳細

ロールセレクターは、アクセシビリティ監査や適合性テストを**置き換えるものではなく**、ARIAガイドラインに関する早期のフィードバックを提供します。

多くのHTML要素には、ロールセレクターによって認識される暗黙的に定義されたロールがあります。サポートされているすべてのロールはこちらで確認できます。ARIAガイドラインは、roleおよび/またはaria-*属性をデフォルト値に設定して暗黙的なロールと属性を重複させることを**推奨しません**。

getByTestId​

追加バージョン: v1.27 page.getByTestId

テストIDによって要素を特定します。

使用法

以下のDOM構造を考えてみましょう。

<button data-testid="directions">Itinéraire</button>

テストIDによって要素を特定できます。

page.getByTestId("directions").click();

引数

戻り値

詳細

デフォルトでは、data-testid 属性がテスト ID として使用されます。必要に応じて、Selectors.setTestIdAttribute() を使用して異なるテスト ID 属性を設定できます。

getByText​

追加バージョン: v1.27 page.getByText

指定されたテキストを含む要素を特定できます。

アクセシブルロールなどの別の条件で一致させ、その後テキストコンテンツでフィルタリングできる Locator.filter() メソッドも参照してください。

使用法

以下のDOM構造を考えてみましょう。

<div>Hello <span>world</span></div>
<div>Hello</div>

テキストの部分文字列、完全な文字列、または正規表現で特定できます。

// Matches <span>
page.getByText("world");

// Matches first <div>
page.getByText("Hello world");

// Matches second <div>
page.getByText("Hello", new Page.GetByTextOptions().setExact(true));

// Matches both <div>s
page.getByText(Pattern.compile("Hello"));

// Matches second <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));

引数

  • text String | Pattern#

    要素を特定するためのテキスト。

  • options Page.GetByTextOptions (任意)

    • setExact boolean (任意)#

      完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

詳細

テキストによる一致は、厳密な一致であっても常に空白を正規化します。例えば、複数のスペースを1つにまとめ、改行をスペースに変換し、先頭と末尾の空白を無視します。

buttonおよびsubmit型の入力要素は、テキストコンテンツの代わりにそのvalueによって一致します。例えば、テキスト"Log in"で特定すると、<input type=button value="Log in">が一致します。

getByTitle​

追加バージョン: v1.27 page.getByTitle

要素をそのタイトル属性で特定できます。

使用法

以下のDOM構造を考えてみましょう。

<span title='Issues count'>25 issues</span>

タイトルテキストで問題数を特定した後、確認できます。

assertThat(page.getByTitle("Issues count")).hasText("25 issues");

引数

  • text String | Pattern#

    要素を特定するためのテキスト。

  • options Page.GetByTitleOptions (任意)

    • setExact boolean (任意)#

      完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

goBack​

v1.9より前に追加 page.goBack

メインリソース応答を返します。複数のリダイレクトの場合、ナビゲーションは最後のリダイレクトの応答で解決されます。戻ることができない場合、nullを返します。

履歴の前のページに移動します。

使用法

Page.goBack();
Page.goBack(options);

引数

  • options Page.GoBackOptions (任意)

    • setTimeout double (任意)#

      ミリ秒単位の最大操作時間。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値は、BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout()、またはPage.setDefaultTimeout()メソッドを使用して変更できます。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (任意)#

      操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

      • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
      • 'load' - loadイベントが発火したときに操作が終了したと見なします。
      • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
      • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

goForward​

v1.9より前に追加 page.goForward

メインリソース応答を返します。複数のリダイレクトの場合、ナビゲーションは最後のリダイレクトの応答で解決されます。進むことができない場合、nullを返します。

履歴の次のページに移動します。

使用法

Page.goForward();
Page.goForward(options);

引数

  • options Page.GoForwardOptions (任意)

    • setTimeout double (任意)#

      ミリ秒単位の最大操作時間。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値は、BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout()、またはPage.setDefaultTimeout()メソッドを使用して変更できます。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (任意)#

      操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

      • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
      • 'load' - loadイベントが発火したときに操作が終了したと見なします。
      • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
      • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

isClosed​

v1.9より前に追加 page.isClosed

ページが閉じられたことを示します。

使用法

Page.isClosed();

戻り値

locator​

追加されたバージョン: v1.14 page.locator

このメソッドは、このページ/フレームでアクションを実行するために使用できる要素ロケーターを返します。ロケーターはアクションを実行する直前に要素に解決されるため、同じロケーターに対する一連のアクションは、実際には異なるDOM要素に対して実行される可能性があります。これは、それらのアクション間でDOM構造が変更された場合に発生します。

ロケーターの詳細.

使用法

Page.locator(selector);
Page.locator(selector, options);

引数

  • selector String#

    DOM要素を解決するときに使用するセレクター。

  • options Page.LocatorOptions (任意)

    • setHas Locator (任意)#

      この相対ロケーターに一致する要素を含む結果にメソッドの結果を絞り込みます。例えば、text=Playwrightを持つarticleは<article><div>Playwright</div></article>に一致します。

      内部ロケーターは**外部ロケーターに対して相対的**でなければならず、ドキュメントルートではなく外部ロケーターの一致からクエリが開始されます。例えば、<article><content><div>Playwright</div></content></article>でdivを持つcontentを見つけることができます。しかし、article divを持つcontentを探すと、内部ロケーターは相対的でなければならず、contentの外部の要素を使用すべきではないため、失敗します。

      外部ロケーターと内部ロケーターは同じフレームに属している必要があります。内部ロケーターには FrameLocator を含めることはできません。

    • setHasNot Locator (任意)追加バージョン: v1.33#

      内部ロケーターに一致する要素を含まない要素に一致します。内部ロケーターは外部ロケーターに対してクエリされます。例えば、divを持たないarticleは<article><span>Playwright</span></article>に一致します。

      外部ロケーターと内部ロケーターは同じフレームに属している必要があります。内部ロケーターには FrameLocator を含めることはできません。

    • setHasNotText String | Pattern (任意)追加バージョン: v1.33#

      指定されたテキストを内部、子、または子孫要素のどこにも含まない要素と一致します。 文字列 が渡された場合、大文字と小文字を区別せずに部分文字列を検索します。

    • setHasText String | Pattern (任意)#

      指定されたテキストを内部、子、または子孫要素のどこかに含む要素と一致します。 文字列 が渡された場合、大文字と小文字を区別せずに部分文字列を検索します。たとえば、"Playwright" は <article><div>Playwright</div></article> と一致します。

戻り値

mainFrame​

v1.9より前に追加 page.mainFrame

ページのメインフレーム。ページにはナビゲーション中に持続するメインフレームがあることが保証されます。

使用法

Page.mainFrame();

戻り値

navigate​

v1.9より前に追加 page.navigate

メインリソース応答を返します。複数のリダイレクトの場合、ナビゲーションは最初の非リダイレクト応答で解決されます。

このメソッドは、以下の場合にエラーをスローします。

  • SSLエラーがある場合（例: 自己署名証明書の場合）。
  • ターゲットURLが無効な場合。
  • setTimeoutを超過した場合、ナビゲーション中にタイムアウトします。
  • リモートサーバーが応答しないか、アクセスできない場合。
  • メインリソースの読み込みに失敗した場合。

このメソッドは、404 "Not Found" や 500 "Internal Server Error" を含む、リモートサーバーから有効なHTTPステータスコードが返された場合でもエラーをスローしません。そのような応答のステータスコードは、Response.status()を呼び出すことで取得できます。

注

このメソッドは、エラーをスローするか、メインリソース応答を返します。唯一の例外は、about:blankへのナビゲーション、または異なるハッシュを持つ同じURLへのナビゲーションであり、これらは成功しnullを返します。

注

ヘッドレスモードはPDFドキュメントへのナビゲーションをサポートしていません。上流の問題を参照してください。

使用法

Page.navigate(url);
Page.navigate(url, options);

引数

  • url String#

    ページをナビゲートするURL。URLにはスキーム (例: https://) を含める必要があります。コンテキストオプションでsetBaseURLが提供されており、渡されたURLがパスである場合、それはnew URL()コンストラクタを介して結合されます。

  • options Page.NavigateOptions (任意)

    • setReferer String (任意)#

      リファラーヘッダー値。提供された場合、Page.setExtraHTTPHeaders()によって設定されたリファラーヘッダー値よりも優先されます。

    • setTimeout double (任意)#

      ミリ秒単位の最大操作時間。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値は、BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout()、またはPage.setDefaultTimeout()メソッドを使用して変更できます。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (任意)#

      操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

      • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
      • 'load' - loadイベントが発火したときに操作が終了したと見なします。
      • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
      • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

onceDialog​

追加バージョン: v1.10 page.onceDialog

使い捨てのDialogハンドラーを追加します。ハンドラーは次のDialogが作成されるとすぐに削除されます。

page.onceDialog(dialog -> {
  dialog.accept("foo");
});

// prints 'foo'
System.out.println(page.evaluate("prompt('Enter string:')"));

// prints 'null' as the dialog will be auto-dismissed because there are no handlers.
System.out.println(page.evaluate("prompt('Enter string:')"));

上記のコードは以下と同等です

Consumer<Dialog> handler = new Consumer<Dialog>() {
  @Override
  public void accept(Dialog dialog) {
    dialog.accept("foo");
    page.offDialog(this);
  }
};
page.onDialog(handler);

// prints 'foo'
System.out.println(page.evaluate("prompt('Enter string:')"));

// prints 'null' as the dialog will be auto-dismissed because there are no handlers.
System.out.println(page.evaluate("prompt('Enter string:')"));

使用法

Page.onceDialog(handler);

引数

  • handler Consumer<Dialog>#

    Dialogオブジェクトを受け取ります。Dialog.accept()またはDialog.dismiss()のいずれかでダイアログを処理する必要があります。そうしないと、ページはダイアログを待機してフリーズし、クリックなどのアクションは決して完了しません。

opener​

v1.9より前に追加 page.opener

ポップアップページの場合にオープナーを返し、その他の場合はnullを返します。オープナーがすでに閉じられている場合、nullを返します。

使用法

Page.opener();

戻り値

pause​

追加バージョン: v1.9 page.pause

スクリプトの実行を一時停止します。Playwrightはスクリプトの実行を停止し、ユーザーがページオーバーレイの「Resume」ボタンを押すか、DevToolsコンソールでplaywright.resume()を呼び出すのを待ちます。

ユーザーは一時停止中にセレクターを検査したり、手動のステップを実行したりできます。再開すると、元のスクリプトは一時停止した場所から実行を続けます。

注

このメソッドは、Playwrightがヘッドレスモードではなく、setHeadlessオプションが偽値で起動されていることを必要とします。

使用法

Page.pause();

戻り値

pdf​

v1.9より前に追加 page.pdf

PDFバッファを返します。

page.pdf()は、print CSSメディアを使用してページのPDFを生成します。screenメディアでPDFを生成するには、page.pdf()を呼び出す前にPage.emulateMedia()を呼び出してください。

注

デフォルトでは、page.pdf()は印刷用に色が変更されたPDFを生成します。正確な色のレンダリングを強制するには、-webkit-print-color-adjustプロパティを使用します。

使用法

// Generates a PDF with "screen" media type.
page.emulateMedia(new Page.EmulateMediaOptions().setMedia(Media.SCREEN));
page.pdf(new Page.PdfOptions().setPath(Paths.get("page.pdf")));

setWidth、setHeight、およびsetMarginオプションは、単位付きの値を受け入れます。単位なしの値はピクセルとして扱われます。

いくつかの例

  • page.pdf({width: 100}) - 幅を100ピクセルに設定して印刷
  • page.pdf({width: '100px'}) - 幅を100ピクセルに設定して印刷
  • page.pdf({width: '10cm'}) - 幅を10センチメートルに設定して印刷。

すべての可能な単位は

  • px - ピクセル
  • in - インチ
  • cm - センチメートル
  • mm - ミリメートル

setFormatオプションは

  • Letter: 8.5インチ x 11インチ
  • Legal: 8.5インチ x 14インチ
  • Tabloid: 11インチ x 17インチ
  • Ledger: 17インチ x 11インチ
  • A0: 33.1インチ x 46.8インチ
  • A1: 23.4インチ x 33.1インチ
  • A2: 16.54インチ x 23.4インチ
  • A3: 11.7インチ x 16.54インチ
  • A4: 8.27インチ x 11.7インチ
  • A5: 5.83インチ x 8.27インチ
  • A6: 4.13インチ x 5.83インチ
注

setHeaderTemplateとsetFooterTemplateのマークアップには以下の制限があります: > 1. テンプレート内のスクリプトタグは評価されません。 > 2. ページスタイルはテンプレート内では表示されません。

引数

  • options Page.PdfOptions (任意)

    • setDisplayHeaderFooter boolean (任意)#

      ヘッダーとフッターを表示します。デフォルトはfalseです。

    • setFooterTemplate String (任意)#

      印刷フッター用のHTMLテンプレート。setHeaderTemplateと同じ形式を使用する必要があります。

    • setFormat String (任意)#

      用紙形式。設定されている場合、setWidthまたはsetHeightオプションよりも優先されます。デフォルトは「Letter」です。

    • setHeaderTemplate String (任意)#

      印刷ヘッダーのHTMLテンプレート。印刷値を挿入するために次のクラスが使用される有効なHTMLマークアップである必要があります。

      • 'date' 形式化された印刷日付
      • 'title' ドキュメントタイトル
      • 'url' ドキュメントの場所
      • 'pageNumber' 現在のページ番号
      • 'totalPages' ドキュメントの総ページ数

    • setHeight String (任意)#

      用紙の高さ。単位付きの値を受け入れます。

    • setLandscape boolean (任意)#

      用紙の向き。デフォルトはfalseです。

    • setMargin Margin (任意)#

      • setTop String (任意)

        上余白。単位付きの値を受け入れます。デフォルトは0です。

      • setRight String (任意)

        右余白。単位付きの値を受け入れます。デフォルトは0です。

      • setBottom String (任意)

        下余白。単位付きの値を受け入れます。デフォルトは0です。

      • setLeft String (任意)

        左余白。単位付きの値を受け入れます。デフォルトは0です。

      用紙の余白。デフォルトはなし。

    • setOutline boolean (任意)追加バージョン: v1.42#

      ドキュメントのアウトラインをPDFに埋め込むかどうか。デフォルトはfalseです。

    • setPageRanges String (任意)#

      印刷するページの範囲。例: '1-5, 8, 11-13'。デフォルトは空文字列で、すべてのページを印刷することを意味します。

    • setPath Path (任意)#

      PDFを保存するファイルパス。setPathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。パスが提供されていない場合、PDFはディスクに保存されません。

    • setPreferCSSPageSize boolean (任意)#

      ページで宣言されたCSS @page サイズに、setWidthやsetHeight、またはsetFormatオプションで宣言されたものよりも優先させます。デフォルトはfalseで、コンテンツは用紙サイズに合わせて拡大縮小されます。

    • setPrintBackground boolean (任意)#

      背景グラフィックを印刷します。デフォルトはfalseです。

    • setScale double (任意)#

      ウェブページのレンダリングのスケール。デフォルトは1です。スケール量は0.1から2の間である必要があります。

    • setTagged boolean (任意)追加バージョン: v1.42#

      タグ付けされた（アクセシブルな）PDFを生成するかどうか。デフォルトはfalseです。

    • setWidth String (任意)#

      用紙の幅。単位付きの値を受け入れます。

戻り値

reload​

v1.9より前に追加 page.reload

このメソッドは、ユーザーがブラウザの更新をトリガーしたかのように、現在のページをリロードします。メインリソース応答を返します。複数のリダイレクトの場合、ナビゲーションは最後のリダイレクトの応答で解決されます。

使用法

Page.reload();
Page.reload(options);

引数

  • options Page.ReloadOptions (任意)

    • setTimeout double (任意)#

      ミリ秒単位の最大操作時間。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値は、BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout()、またはPage.setDefaultTimeout()メソッドを使用して変更できます。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (任意)#

      操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

      • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
      • 'load' - loadイベントが発火したときに操作が終了したと見なします。
      • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
      • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

removeLocatorHandler​

追加バージョン: v1.44 page.removeLocatorHandler

特定のロケーターに対してPage.addLocatorHandler()によって追加されたすべてのロケーターハンドラーを削除します。

使用法

Page.removeLocatorHandler(locator);

引数

戻り値

requestGC​

追加日: v1.48 page.requestGC

ページにガベージコレクションを実行するように要求します。到達不能なすべてのオブジェクトが収集される保証はありません。

これはメモリリークを検出するのに役立ちます。たとえば、ページにリークする可能性のある大きなオブジェクト 'suspect' がある場合、WeakRef を使用してリークしないことを確認できます。

// 1. In your page, save a WeakRef for the "suspect".
page.evaluate("globalThis.suspectWeakRef = new WeakRef(suspect)");
// 2. Request garbage collection.
page.requestGC();
// 3. Check that weak ref does not deref to the original object.
assertTrue(page.evaluate("!globalThis.suspectWeakRef.deref()"));

使用法

Page.requestGC();

戻り値

route​

v1.9より前に追加 page.route

ルーティングは、ページによって行われるネットワークリクエストを変更する機能を提供します。

ルーティングが有効になると、URLパターンに一致するすべてのリクエストは、続行、完了、または中止されない限り停止します。

注

レスポンスがリダイレクトの場合、ハンドラーは最初のURLに対してのみ呼び出されます。

注

Page.route()はService Workerによって傍受されたリクエストを傍受しません。このissueを参照してください。リクエスト傍受を使用する場合は、setServiceWorkersを'block'に設定してService Workerを無効にすることをお勧めします。

注

Page.route()はポップアップページの最初のリクエストを傍受しません。代わりにBrowserContext.route()を使用してください。

使用法

すべての画像リクエストを中止する素朴なハンドラの例

Page page = browser.newPage();
page.route("**/*.{png,jpg,jpeg}", route -> route.abort());
page.navigate("https://example.com");
browser.close();

または、代わりに正規表現パターンを使用する同じスニペット

Page page = browser.newPage();
page.route(Pattern.compile("(\\.png$)|(\\.jpg$)"),route -> route.abort());
page.navigate("https://example.com");
browser.close();

リクエストを調べてルートアクションを決定することができます。たとえば、一部の POST データを含むすべてのリクエストをモックし、その他のすべてのリクエストをそのままにするなどです。

page.route("/api/**", route -> {
  if (route.request().postData().contains("my-string"))
    route.fulfill(new Route.FulfillOptions().setBody("mocked-data"));
  else
    route.resume();
});

リクエストが両方のハンドラーに一致する場合、ページルートはブラウザコンテキストルート（BrowserContext.route()で設定）よりも優先されます。

ハンドラー付きのルートを削除するには、Page.unroute()を使用できます。

注

ルーティングを有効にすると、HTTP キャッシュが無効になります。

引数

  • url String | Pattern | Predicate<String>#

    ルーティング中に一致させる[URL]を受け取るグロブパターン、正規表現パターン、または述語。setBaseURLがコンテキストオプションで設定されており、提供されたURLが*で始まらない文字列である場合、new URL()コンストラクタを使用して解決されます。

  • handler Consumer<Route>#

    リクエストをルーティングするハンドラ関数。

  • options Page.RouteOptions (任意)

    • setTimes int (任意)追加されたバージョン: v1.15#

      ルートが使用される頻度。デフォルトでは毎回使用されます。

戻り値

routeFromHAR​

追加日: v1.23 page.routeFromHAR

指定されている場合、ページで行われたネットワークリクエストはHARファイルから提供されます。HARからのリプレイについて詳しくはこちらをご覧ください。

Playwrightは、Service Workerによって傍受されたリクエストをHARファイルから提供しません。このissueを参照してください。リクエスト傍受を使用する場合は、setServiceWorkersを'block'に設定してService Workerを無効にすることをお勧めします。

使用法

Page.routeFromHAR(har);
Page.routeFromHAR(har, options);

引数

  • har Path#

    事前に記録されたネットワークデータを含む HAR ファイルへのパス。path が相対パスの場合、現在の作業ディレクトリに対して解決されます。

  • options Page.RouteFromHAROptions (任意)

    • setNotFound enum HarNotFound { ABORT, FALLBACK } (任意)#

      • 'abort' に設定されている場合、HAR ファイルに見つからないリクエストは中止されます。
      • 'fallback' に設定すると、見つからないリクエストはネットワークに送信されます。

      デフォルトは abort です。

    • setUpdate boolean (任意)#

      指定されている場合、提供されたHARをファイルから提供する代わりに実際のネットワーク情報で更新します。BrowserContext.close()が呼び出されたときにファイルがディスクに書き込まれます。

    • setUpdateContent enum RouteFromHarUpdateContentPolicy { EMBED, ATTACH } (任意)追加日: v1.32#

      リソースコンテンツ管理を制御するためのオプション設定。attach が指定されている場合、リソースは個別のファイルまたは ZIP アーカイブ内のエントリとして永続化されます。embed が指定されている場合、コンテンツは HAR ファイル内にインラインで格納されます。

    • setUpdateMode enum HarMode { FULL, MINIMAL } (任意)追加日: v1.32#

      minimal に設定すると、HAR からルーティングするために必要な情報のみが記録されます。これにより、HAR からリプレイするときに使用されないサイズ、タイミング、ページ、クッキー、セキュリティ、およびその他の種類の HAR 情報が省略されます。デフォルトは minimal です。

    • setUrl String | Pattern (任意)#

      リクエスト URL に一致するグロブパターン、正規表現、または述語。パターンに一致する URL を持つリクエストのみが HAR ファイルから提供されます。指定されていない場合、すべてのリクエストが HAR ファイルから提供されます。

戻り値

routeWebSocket​

追加日: v1.48 page.routeWebSocket

このメソッドを使用すると、ページによって行われるwebsocket接続を変更できます。

このメソッドが呼び出された後に作成された WebSocket のみがルーティングされることに注意してください。ページをナビゲートする前にこのメソッドを呼び出すことをお勧めします。

使用法

以下は、単一のメッセージに応答する簡単なモックの例です。詳細と例については、WebSocketRouteを参照してください。

page.routeWebSocket("/ws", ws -> {
  ws.onMessage(frame -> {
    if ("request".equals(frame.text()))
      ws.send("response");
  });
});

引数

  • url String | Pattern | Predicate<String>#

    このパターンに一致するURLを持つWebSocketのみがルーティングされます。文字列パターンはsetBaseURLコンテキストオプションに対して相対的に指定できます。

  • handler Consumer<WebSocketRoute>#

    WebSocket をルーティングするハンドラ関数。

戻り値

screenshot​

v1.9より前に追加 page.screenshot

キャプチャされたスクリーンショットを含むバッファを返します。

使用法

Page.screenshot();
Page.screenshot(options);

引数

  • options Page.ScreenshotOptions (任意)

    • setAnimations enum ScreenshotAnimations { DISABLED, ALLOW } (任意)#

      "disabled"に設定すると、CSSアニメーション、CSSトランジション、Webアニメーションが停止します。アニメーションは期間によって異なる扱いを受けます。

      • 有限のアニメーションは完了まで早送りされ、transitionendイベントが発生します。
      • 無限のアニメーションは初期状態にキャンセルされ、スクリーンショットの後に再生されます。

      デフォルトは"allow"で、アニメーションはそのまま残されます。

    • setCaret enum ScreenshotCaret { HIDE, INITIAL } (任意)#

      "hide"に設定すると、スクリーンショットはテキストキャレットを非表示にします。"initial"に設定すると、テキストキャレットの動作は変更されません。デフォルトは"hide"です。

    • setClip Clip (任意)#

      • setX double

        クリップ領域の左上隅のx座標

      • setY double

        クリップ領域の左上隅のy座標

      • setWidth double

        クリッピング領域の幅

      • setHeight double

        クリッピング領域の高さ

      結果の画像のクリッピングを指定するオブジェクト。

    • setFullPage boolean (任意)#

      trueの場合、現在表示されているビューポートではなく、スクロール可能なページ全体のスクリーンショットを撮ります。デフォルトは false です。

    • setMask List<Locator> (任意)#

      スクリーンショットを撮る際にマスクするロケーターを指定します。マスクされた要素は、バウンディングボックスを完全に覆うピンクのボックス#FF00FF（setMaskColorでカスタマイズ可能）で重ねて表示されます。マスクは非表示の要素にも適用されます。これを無効にするには、可視要素のみを一致させるを参照してください。

    • setMaskColor String (任意)追加されたバージョン: v1.35#

      CSSカラー形式で、マスクされた要素のオーバーレイボックスの色を指定します。デフォルトの色はピンク#FF00FFです。

    • setOmitBackground boolean (任意)#

      デフォルトの白い背景を非表示にし、透過性のあるスクリーンショットをキャプチャできるようにします。jpeg画像には適用されません。デフォルトはfalseです。

    • setPath Path (任意)#

      画像を保存するファイルパス。スクリーンショットの種類はファイル拡張子から推測されます。setPathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。パスが提供されていない場合、画像はディスクに保存されません。

    • setQuality int (任意)#

      画像の品質（0～100）。png画像には適用されません。

    • setScale enum ScreenshotScale { CSS, DEVICE } (任意)#

      "css"に設定すると、スクリーンショットはページ上の各CSSピクセルにつき1ピクセルになります。高DPIデバイスの場合、これによりスクリーンショットが小さく保たれます。"device"オプションを使用すると、各デバイスピクセルにつき1ピクセルが生成されるため、高DPIデバイスのスクリーンショットは2倍以上大きくなります。

      デフォルトは"device"です。

    • setStyle String (任意)追加日: v1.41#

      スクリーンショット作成時に適用するスタイルシートのテキスト。これにより、動的な要素を非表示にしたり、要素を見えなくしたり、プロパティを変更したりして、再現性のあるスクリーンショットを作成するのに役立ちます。このスタイルシートはShadow DOMを貫通し、内部フレームにも適用されます。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setType enum ScreenshotType { PNG, JPEG } (任意)#

      スクリーンショットの種類を指定します。デフォルトはpngです。

戻り値

setContent​

v1.9より前に追加 page.setContent

このメソッドは内部的に document.write() を呼び出し、そのすべての特定の特性と動作を継承します。

使用法

Page.setContent(html);
Page.setContent(html, options);

引数

  • html String#

    ページに割り当てる HTML マークアップ。

  • options Page.SetContentOptions (任意)

    • setTimeout double (任意)#

      ミリ秒単位の最大操作時間。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値は、BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout()、またはPage.setDefaultTimeout()メソッドを使用して変更できます。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (任意)#

      操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

      • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
      • 'load' - loadイベントが発火したときに操作が終了したと見なします。
      • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
      • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

setDefaultNavigationTimeout​

v1.9より前に追加 page.setDefaultNavigationTimeout

この設定は、以下のメソッドと関連するショートカットのデフォルトの最大ナビゲーション時間を変更します。

注

Page.setDefaultNavigationTimeout()は、Page.setDefaultTimeout()、BrowserContext.setDefaultTimeout()、およびBrowserContext.setDefaultNavigationTimeout()よりも優先されます。

使用法

Page.setDefaultNavigationTimeout(timeout);

引数

  • timeout double#

    最大ナビゲーション時間 (ミリ秒)

setDefaultTimeout​

v1.9より前に追加 page.setDefaultTimeout

この設定により、timeoutオプションを受け入れるすべてのメソッドのデフォルトの最大時間が変更されます。

注

Page.setDefaultNavigationTimeout()は、Page.setDefaultTimeout()よりも優先されます。

使用法

Page.setDefaultTimeout(timeout);

引数

  • timeout double#

    最大時間 (ミリ秒)。タイムアウトを無効にするには 0 を渡します。

setExtraHTTPHeaders​

v1.9より前に追加 page.setExtraHTTPHeaders

追加のHTTPヘッダーは、ページが開始するすべてのリクエストとともに送信されます。

注

Page.setExtraHTTPHeaders()は、送信リクエスト内のヘッダーの順序を保証しません。

使用法

Page.setExtraHTTPHeaders(headers);

引数

  • headers Map<String, String>#

    すべてのリクエストとともに送信される追加の HTTP ヘッダーを含むオブジェクト。すべてのヘッダー値は文字列である必要があります。

戻り値

setViewportSize​

v1.9より前に追加 page.setViewportSize

単一のブラウザ内に複数のページがある場合、各ページは独自のビューポートサイズを持つことができます。しかし、Browser.newContext()を使用すると、コンテキスト内のすべてのページに対して一度にビューポートサイズ（およびその他の設定）を設定できます。

Page.setViewportSize()はページのサイズを変更します。多くのウェブサイトは電話のサイズが変更されることを期待していないため、ページにナビゲートする前にビューポートサイズを設定する必要があります。Page.setViewportSize()はscreenサイズもリセットします。これらのプロパティをより細かく制御する必要がある場合は、screenとviewportパラメータを使用してBrowser.newContext()を使用してください。

使用法

Page page = browser.newPage();
page.setViewportSize(640, 480);
page.navigate("https://example.com");

引数

  • width int追加バージョン: v1.10#

    ページの幅（ピクセル単位）。

  • height int追加バージョン: v1.10#

    ページの高さ（ピクセル単位）。

戻り値

title​

v1.9より前に追加 page.title

ページのタイトルを返します。

使用法

Page.title();

戻り値

unroute​

v1.9より前に追加 page.unroute

Page.route()で作成されたルートを削除します。handlerが指定されていない場合、urlに対するすべてのルートを削除します。

使用法

Page.unroute(url);
Page.unroute(url, handler);

引数

  • url String | Pattern | Predicate<String>#

    ルーティング中に一致させる[URL]を受け取るグロブパターン、正規表現パターン、または述語。

  • handler Consumer<Route> (任意)#

    リクエストをルーティングするためのオプションのハンドラー関数。

戻り値

unrouteAll​

追加日: v1.41 page.unrouteAll

Page.route()とPage.routeFromHAR()で作成されたすべてのルートを削除します。

使用法

Page.unrouteAll();

戻り値

url​

v1.9より前に追加 page.url

使用法

Page.url();

戻り値

video​

v1.9より前に追加 page.video

このページに関連付けられたビデオオブジェクト。

使用法

Page.video();

戻り値

viewportSize​

v1.9より前に追加 page.viewportSize

使用法

Page.viewportSize();

戻り値

  • null | ViewportSize#

    • width int

      ページ幅（ピクセル単位）。

    • height int

      ページ高さ（ピクセル単位）。

waitForClose​

追加されたバージョン: v1.11 page.waitForClose

アクションを実行し、Pageが閉じるのを待ちます。

使用法

Page.waitForClose(callback);
Page.waitForClose(callback, options);

引数

  • options Page.WaitForCloseOptions (任意)

    • setTimeout double (オプション)追加バージョン: v1.9#

      ミリ秒単位で待機する最大時間。デフォルトは30000 (30秒) です。タイムアウトを無効にするには0を渡します。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable追加バージョン: v1.9#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForCondition​

追加日: v1.32 page.waitForCondition

このメソッドは、条件がtrueを返すまでブロックします。このメソッドが条件を待っている間、すべてのPlaywrightイベントがディスパッチされます。

使用法

ページイベントに依存する条件を待つには、このメソッドを使用します。

List<String> messages = new ArrayList<>();
page.onConsoleMessage(m -> messages.add(m.text()));
page.getByText("Submit button").click();
page.waitForCondition(() -> messages.size() > 3);

引数

  • condition [BooleanSupplier]#

    待機する条件。

  • options Page.WaitForConditionOptions (任意)

戻り値

waitForConsoleMessage​

追加バージョン: v1.9 page.waitForConsoleMessage

アクションを実行し、ページにConsoleMessageがログに記録されるのを待ちます。predicateが提供された場合、ConsoleMessage値をpredicate関数に渡し、predicate(message)がtruthy値を返すのを待ちます。Page.onConsoleMessage(handler)イベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

Page.waitForConsoleMessage(callback);
Page.waitForConsoleMessage(callback, options);

引数

  • options Page.WaitForConsoleMessageOptions (任意)

    • setPredicate Predicate<ConsoleMessage> (任意)#

      ConsoleMessageオブジェクトを受け取り、待機が解決されるときにtruthy値に解決します。

    • setTimeout double (任意)#

      ミリ秒単位で待機する最大時間。デフォルトは30000 (30秒) です。タイムアウトを無効にするには0を渡します。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForDownload​

追加バージョン: v1.9 page.waitForDownload

アクションを実行し、新しいDownloadを待ちます。predicateが提供された場合、Download値をpredicate関数に渡し、predicate(download)がtruthy値を返すのを待ちます。ダウンロードイベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

Page.waitForDownload(callback);
Page.waitForDownload(callback, options);

引数

  • options Page.WaitForDownloadOptions (任意)

    • setPredicate Predicate<Download> (任意)#

      Downloadオブジェクトを受け取り、待機が解決されるときにtruthy値に解決します。

    • setTimeout double (任意)#

      ミリ秒単位で待機する最大時間。デフォルトは30000 (30秒) です。タイムアウトを無効にするには0を渡します。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForFileChooser​

追加バージョン: v1.9 page.waitForFileChooser

アクションを実行し、新しいFileChooserが作成されるのを待ちます。predicateが提供された場合、FileChooser値をpredicate関数に渡し、predicate(fileChooser)がtruthy値を返すのを待ちます。ファイルチューザーが開かれる前にページが閉じられた場合、エラーがスローされます。

使用法

Page.waitForFileChooser(callback);
Page.waitForFileChooser(callback, options);

引数

  • options Page.WaitForFileChooserOptions (任意)

    • setPredicate Predicate<FileChooser> (任意)#

      FileChooserオブジェクトを受け取り、待機が解決されるときにtruthy値に解決します。

    • setTimeout double (任意)#

      ミリ秒単位で待機する最大時間。デフォルトは30000 (30秒) です。タイムアウトを無効にするには0を渡します。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForFunction​

v1.9より前に追加 page.waitForFunction

expressionがtruthy値を返すときに戻ります。truthy値のJSHandleに解決されます。

使用法

Page.waitForFunction()はビューポートサイズの変更を監視するために使用できます

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch();
      Page page = browser.newPage();
      page.setViewportSize(50,  50);
      page.waitForFunction("() => window.innerWidth < 100");
      browser.close();
    }
  }
}

Page.waitForFunction()関数の述語に引数を渡すには

String selector = ".foo";
page.waitForFunction("selector => !!document.querySelector(selector)", selector);

引数

  • expression String#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (任意)#

    expressionに渡すオプションの引数。

  • options Page.WaitForFunctionOptions (任意)

    • setPollingInterval double (任意)#

      指定された場合、関数が実行されるミリ秒単位の間隔として扱われます。デフォルトでは、オプションが指定されていない場合、expressionはrequestAnimationFrameコールバックで実行されます。

    • setTimeout double (任意)#

      待機する最大時間（ミリ秒）。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は、BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

waitForLoadState​

v1.9より前に追加 page.waitForLoadState

必要な読み込み状態に到達すると解決されます。

これは、ページがデフォルトで load という必要な読み込み状態に達したときに解決します。このメソッドが呼び出されたときにナビゲーションがコミットされている必要があります。現在のドキュメントがすでに必要な状態に達している場合は、すぐに解決されます。

注

ほとんどの場合、Playwrightはすべてのアクションの前に自動的に待機するため、このメソッドは必要ありません。

使用法

page.getByRole(AriaRole.BUTTON).click(); // Click triggers navigation.
page.waitForLoadState(); // The promise resolves after "load" event.
Page popup = page.waitForPopup(() -> {
  page.getByRole(AriaRole.BUTTON).click(); // Click triggers a popup.
});
// Wait for the "DOMContentLoaded" event
popup.waitForLoadState(LoadState.DOMCONTENTLOADED);
System.out.println(popup.title()); // Popup is ready to use.

引数

  • state enum LoadState { LOAD, DOMCONTENTLOADED, NETWORKIDLE } (任意)#

    待機するオプションの読み込み状態。デフォルトは load です。現在のドキュメントの読み込み中にすでに状態に達している場合、メソッドはすぐに解決します。次のいずれかです。

    • 'load' - load イベントが発火するまで待ちます。
    • 'domcontentloaded' - DOMContentLoaded イベントが発火するまで待ちます。
    • 'networkidle' - 推奨されません 少なくとも 500 ミリ秒間ネットワーク接続がないまで待ちます。テストにはこのメソッドを使用せず、代わりにウェブアサーションに頼って準備状況を評価してください。

  • options Page.WaitForLoadStateOptions (任意)

戻り値

waitForPopup​

追加バージョン: v1.9 page.waitForPopup

アクションを実行し、ポップアップPageを待ちます。predicateが提供された場合、[Popup]値をpredicate関数に渡し、predicate(page)がtruthy値を返すのを待ちます。ポップアップイベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

Page.waitForPopup(callback);
Page.waitForPopup(callback, options);

引数

  • options Page.WaitForPopupOptions (任意)

    • setPredicate Predicate<Page> (任意)#

      Pageオブジェクトを受け取り、待機が解決されるときにtruthy値に解決します。

    • setTimeout double (任意)#

      ミリ秒単位で待機する最大時間。デフォルトは30000 (30秒) です。タイムアウトを無効にするには0を渡します。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForRequest​

v1.9より前に追加 page.waitForRequest

一致するリクエストを待機し、それを返します。イベントの詳細については、イベントの待機を参照してください。

使用法

// Waits for the next request with the specified url
Request request = page.waitForRequest("https://example.com/resource", () -> {
  // Triggers the request
  page.getByText("trigger request").click();
});

// Waits for the next request matching some conditions
Request request = page.waitForRequest(request -> "https://example.com".equals(request.url()) && "GET".equals(request.method()), () -> {
  // Triggers the request
  page.getByText("trigger request").click();
});

引数

  • urlOrPredicate String | Pattern | Predicate<Request>#

    リクエストURL文字列、正規表現、またはRequestオブジェクトを受け取る述語。コンテキストオプション経由でsetBaseURLが提供され、渡されたURLがパスである場合、new URL()コンストラクタ経由でマージされます。

  • options Page.WaitForRequestOptions (任意)

    • setTimeout double (任意)#

      最大待機時間（ミリ秒単位）。デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はPage.setDefaultTimeout()メソッドを使用して変更できます。

  • callback Runnable追加バージョン: v1.9#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForRequestFinished​

追加日: v1.12 page.waitForRequestFinished

アクションを実行し、Requestのロードが完了するのを待ちます。predicateが提供された場合、Request値をpredicate関数に渡し、predicate(request)がtruthy値を返すのを待ちます。Page.onRequestFinished(handler)イベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

Page.waitForRequestFinished(callback);
Page.waitForRequestFinished(callback, options);

引数

  • options Page.WaitForRequestFinishedOptions (任意)

    • setPredicate Predicate<Request> (任意)#

      Requestオブジェクトを受け取り、待機が解決されるときにtruthy値に解決します。

    • setTimeout double (任意)#

      ミリ秒単位で待機する最大時間。デフォルトは30000 (30秒) です。タイムアウトを無効にするには0を渡します。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForResponse​

v1.9より前に追加 page.waitForResponse

一致するレスポンスを返します。イベントの詳細については、イベントの待機を参照してください。

使用法

// Waits for the next response with the specified url
Response response = page.waitForResponse("https://example.com/resource", () -> {
  // Triggers the response
  page.getByText("trigger response").click();
});

// Waits for the next response matching some conditions
Response response = page.waitForResponse(response -> "https://example.com".equals(response.url()) && response.status() == 200 && "GET".equals(response.request().method()), () -> {
  // Triggers the response
  page.getByText("trigger response").click();
});

引数

  • urlOrPredicate String | Pattern | Predicate<Response>#

    リクエストURL文字列、正規表現、またはResponseオブジェクトを受け取る述語。コンテキストオプション経由でsetBaseURLが提供され、渡されたURLがパスである場合、new URL()コンストラクタ経由でマージされます。

  • options Page.WaitForResponseOptions (任意)

  • callback Runnable追加バージョン: v1.9#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForURL​

追加されたバージョン: v1.11 page.waitForURL

メインフレームが指定されたURLにナビゲートするのを待ちます。

使用法

page.click("a.delayed-navigation"); // Clicking the link will indirectly cause a navigation
page.waitForURL("**/target.html");

引数

  • url String | Pattern | Predicate<String>#

    ナビゲーションを待機中に一致させる[URL]を受け取るグロブパターン、正規表現パターン、または述語。ワイルドカード文字のない文字列がパラメータの場合、メソッドは文字列と正確に一致するURLへのナビゲーションを待機します。

  • options Page.WaitForURLOptions (任意)

    • setTimeout double (任意)#

      ミリ秒単位の最大操作時間。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値は、BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout()、またはPage.setDefaultTimeout()メソッドを使用して変更できます。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (任意)#

      操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

      • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
      • 'load' - loadイベントが発火したときに操作が終了したと見なします。
      • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
      • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

waitForWebSocket​

追加バージョン: v1.9 page.waitForWebSocket

アクションを実行し、新しいWebSocketを待ちます。predicateが提供された場合、WebSocket値をpredicate関数に渡し、predicate(webSocket)がtruthy値を返すのを待ちます。WebSocketイベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

Page.waitForWebSocket(callback);
Page.waitForWebSocket(callback, options);

引数

  • options Page.WaitForWebSocketOptions (任意)

    • setPredicate Predicate<WebSocket> (任意)#

      WebSocketオブジェクトを受け取り、待機が解決されるときにtruthy値に解決します。

    • setTimeout double (任意)#

      ミリ秒単位で待機する最大時間。デフォルトは30000 (30秒) です。タイムアウトを無効にするには0を渡します。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForWorker​

追加バージョン: v1.9 page.waitForWorker

アクションを実行し、新しいWorkerを待ちます。predicateが提供された場合、Worker値をpredicate関数に渡し、predicate(worker)がtruthy値を返すのを待ちます。ワーカーイベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

Page.waitForWorker(callback);
Page.waitForWorker(callback, options);

引数

  • options Page.WaitForWorkerOptions (任意)

    • setPredicate Predicate<Worker> (任意)#

      Workerオブジェクトを受け取り、待機が解決されるときにtruthy値に解決します。

    • setTimeout double (任意)#

      ミリ秒単位で待機する最大時間。デフォルトは30000 (30秒) です。タイムアウトを無効にするには0を渡します。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

workers​

v1.9より前に追加 page.workers

このメソッドは、ページに関連付けられたすべての専用 WebWorkers を返します。

注

これにはサービスワーカーは含まれません

使用法

Page.workers();

戻り値

プロパティ​

clock()​

追加されたバージョン: v1.45 page.clock()

Playwright には、クロックと時間の経過をモックする機能があります。

使用法

Page.clock()

戻り値

keyboard()​

v1.9より前に追加 page.keyboard()

使用法

Page.keyboard()

戻り値

mouse()​

v1.9より前に追加 page.mouse()

使用法

Page.mouse()

戻り値

request()​

追加バージョン: v1.16 page.request()

このページに関連するAPIテストヘルパー。このメソッドは、ページのコンテキストにおけるBrowserContext.request()と同じインスタンスを返します。詳細については、BrowserContext.request()を参照してください。

使用法

Page.request()

戻り値

touchscreen()​

v1.9より前に追加 page.touchscreen()

使用法

Page.touchscreen()

戻り値

イベント​

onClose(handler)​

v1.9より前に追加 page.onClose(handler)

ページが閉じられたときに発行されます。

使用法

Page.onClose(handler)

イベントデータ

onConsoleMessage(handler)​

v1.9より前に追加 page.onConsoleMessage(handler)

ページ内の JavaScript が console.log や console.dir などのコンソール API メソッドのいずれかを呼び出したときに発生します。

console.logに渡された引数は、ConsoleMessageイベントハンドラの引数として利用できます。

使用法

page.onConsoleMessage(msg -> {
  for (int i = 0; i < msg.args().size(); ++i)
    System.out.println(i + ": " + msg.args().get(i).jsonValue());
});
page.evaluate("() => console.log('hello', 5, { foo: 'bar' })");

イベントデータ

onCrash(handler)​

v1.9より前に追加 page.onCrash(handler)

ページがクラッシュしたときに発行されます。ブラウザページは、あまりにも多くのメモリを割り当てようとするとクラッシュする可能性があります。ページがクラッシュすると、進行中およびその後の操作は例外をスローします。

クラッシュに対処する最も一般的な方法は、例外をキャッチすることです。

try {
  // Crash might happen during a click.
  page.click("button");
  // Or while waiting for an event.
  page.waitForPopup(() -> {});
} catch (PlaywrightException e) {
  // When the page crashes, exception message contains "crash".
}

使用法

Page.onCrash(handler)

イベントデータ

onDialog(handler)​

v1.9より前に追加 page.onDialog(handler)

alert、prompt、confirm、beforeunloadなどのJavaScriptダイアログが表示されたときに発生します。リスナーはダイアログをDialog.accept()するかDialog.dismiss()するかのいずれかを**必ず**行わなければなりません。そうしないと、ページはダイアログを待機してフリーズし、クリックなどのアクションが完了しなくなります。

使用法

page.onDialog(dialog -> {
  dialog.accept();
});
注

Page.onDialog(handler)またはBrowserContext.onDialog(handler)リスナーが存在しない場合、すべてのダイアログは自動的に閉じられます。

イベントデータ

onDOMContentLoaded(handler)​

追加バージョン: v1.9 page.onDOMContentLoaded(handler)

JavaScript DOMContentLoaded イベントがディスパッチされたときに発行されます。

使用法

Page.onDOMContentLoaded(handler)

イベントデータ

onDownload(handler)​

v1.9より前に追加 page.onDownload(handler)

添付ファイルのダウンロードが開始されたときに発生します。ユーザーは渡されたDownloadインスタンスを介してダウンロードコンテンツに対する基本的なファイル操作にアクセスできます。

使用法

Page.onDownload(handler)

イベントデータ

onFileChooser(handler)​

追加バージョン: v1.9 page.onFileChooser(handler)

<input type=file>をクリックした後など、ファイルチューザーが表示されるときに発生します。Playwrightは、FileChooser.setFiles()を使用して入力ファイルをセットすることで応答でき、その後アップロードできます。

page.onFileChooser(fileChooser -> {
  fileChooser.setFiles(Paths.get("/tmp/myfile.pdf"));
});

使用法

Page.onFileChooser(handler)

イベントデータ

onFrameAttached(handler)​

追加バージョン: v1.9 page.onFrameAttached(handler)

フレームがアタッチされたときに発行されます。

使用法

Page.onFrameAttached(handler)

イベントデータ

onFrameDetached(handler)​

追加バージョン: v1.9 page.onFrameDetached(handler)

フレームがデタッチされたときに発行されます。

使用法

Page.onFrameDetached(handler)

イベントデータ

onFrameNavigated(handler)​

追加バージョン: v1.9 page.onFrameNavigated(handler)

フレームが新しいURLにナビゲートされたときに発行されます。

使用法

Page.onFrameNavigated(handler)

イベントデータ

onLoad(handler)​

v1.9より前に追加 page.onLoad(handler)

JavaScript load イベントがディスパッチされたときに発行されます。

使用法

Page.onLoad(handler)

イベントデータ

onPageError(handler)​

追加バージョン: v1.9 page.onPageError(handler)

ページ内でキャッチされない例外が発生したときに発行されます。

// Log all uncaught errors to the terminal
page.onPageError(exception -> {
  System.out.println("Uncaught exception: " + exception);
});

// Navigate to a page with an exception.
page.navigate("data:text/html,<script>throw new Error('Test')</script>");

使用法

Page.onPageError(handler)

イベントデータ

onPopup(handler)​

v1.9より前に追加 page.onPopup(handler)

ページが新しいタブまたはウィンドウを開いたときに発生します。このイベントはBrowserContext.onPage(handler)に加えて発生しますが、このページに関連するポップアップの場合に限ります。

ページが利用可能になる最も早いタイミングは、初期URLにナビゲートされたときです。たとえば、window.open('http://example.com')でポップアップを開く場合、このイベントは「http://example.com」へのネットワークリクエストが完了し、そのレスポンスがポップアップで読み込みを開始したときに発生します。このネットワークリクエストをルーティング/リッスンしたい場合は、Page上の同様のメソッドの代わりに、それぞれBrowserContext.route()とBrowserContext.onRequest(handler)を使用してください。

Page popup = page.waitForPopup(() -> {
  page.getByText("open the popup").click();
});
System.out.println(popup.evaluate("location.href"));
注

ページが特定の状態になるまで待つには、Page.waitForLoadState()を使用します（ほとんどの場合、必要ありません）。

使用法

Page.onPopup(handler)

イベントデータ

onRequest(handler)​

v1.9より前に追加 page.onRequest(handler)

ページがリクエストを発行したときに発生します。requestオブジェクトは読み取り専用です。リクエストをインターセプトして変更するには、Page.route()またはBrowserContext.route()を参照してください。

使用法

Page.onRequest(handler)

イベントデータ

onRequestFailed(handler)​

追加バージョン: v1.9 page.onRequestFailed(handler)

リクエストがタイムアウトなどで失敗したときに発行されます。

page.onRequestFailed(request -> {
  System.out.println(request.url() + " " + request.failure());
});
注

404や503などのHTTPエラーレスポンスは、HTTPの観点からは依然として成功したレスポンスであるため、リクエストはPage.onRequestFinished(handler)イベントで完了し、Page.onRequestFailed(handler)では完了しません。リクエストは、ネットワークエラーnet::ERR_FAILEDなどにより、クライアントがサーバーからHTTPレスポンスを取得できない場合にのみ失敗と見なされます。

使用法

Page.onRequestFailed(handler)

イベントデータ

onRequestFinished(handler)​

追加バージョン: v1.9 page.onRequestFinished(handler)

レスポンスボディのダウンロード後にリクエストが正常に完了したときに発行されます。成功したレスポンスの場合、イベントのシーケンスは request、response、requestfinished です。

使用法

Page.onRequestFinished(handler)

イベントデータ

onResponse(handler)​

v1.9より前に追加 page.onResponse(handler)

リクエストに対してresponseステータスとヘッダーが受信されたときに発生します。成功した応答の場合、イベントのシーケンスはrequest、response、requestfinishedです。

使用法

Page.onResponse(handler)

イベントデータ

onWebSocket(handler)​

追加バージョン: v1.9 page.onWebSocket(handler)

WebSocketリクエストが送信されたときに発生します。

使用法

Page.onWebSocket(handler)

イベントデータ

onWorker(handler)​

v1.9より前に追加 page.onWorker(handler)

専用の WebWorker がページによって生成されたときに発行されます。

使用法

Page.onWorker(handler)

イベントデータ

非推奨​

check​

v1.9より前に追加 page.check
推奨されません

代わりにロケーターベースのLocator.check()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行して、selectorに一致する要素をチェックします。

  1. selectorに一致する要素を見つけます。見つからない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. 一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはスローします。要素がすでにチェックされている場合、このメソッドはすぐに戻ります。
  3. setForceオプションが設定されていない限り、一致する要素に対して操作可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  4. 必要に応じて要素を表示するためにスクロールします。
  5. 要素の中心をクリックするには Page.mouse() を使用します。
  6. 要素が現在チェックされていることを確認します。そうでない場合、このメソッドはスローします。

すべてのステップを合わせても指定されたsetTimeout時間内に完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロにすると、これを無効にします。

使用法

Page.check(selector);
Page.check(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.CheckOptions (任意)

    • setForce boolean (任意)#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setPosition 位置 (オプション)追加されたバージョン: v1.11#

      要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setTrial boolean (オプション)追加されたバージョン: v1.11#

      設定すると、このメソッドは アクション可能性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備ができるまで待機するのに便利です。

戻り値

click​

v1.9より前に追加 page.click
推奨されません

代わりにロケーターベースのLocator.click()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行して、selectorに一致する要素をクリックします。

  1. selectorに一致する要素を見つけます。見つからない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. setForceオプションが設定されていない限り、一致する要素に対して操作可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  3. 必要に応じて要素を表示するためにスクロールします。
  4. 要素の中心、または指定されたsetPositionでクリックするには、Page.mouse()を使用します。
  5. setNoWaitAfterオプションが設定されていない限り、開始されたナビゲーションが成功または失敗するまで待ちます。

すべてのステップを合わせても指定されたsetTimeout時間内に完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロにすると、これを無効にします。

使用法

Page.click(selector);
Page.click(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.ClickOptions (任意)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (任意)#

      デフォルトは left です。

    • setClickCount int (任意)#

      デフォルトは 1 です。UIEvent.detail を参照してください。

    • setDelay double (任意)#

      mousedown と mouseup の間の待機時間 (ミリ秒単位)。デフォルトは 0 です。

    • setForce boolean (任意)#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (任意)#

      押す修飾キー。操作中にこれらの修飾キーのみが押されていることを保証し、現在の修飾キーを元に戻します。指定しない場合、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows と Linux では "Control" に、macOS では "Meta" に解決されます。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは将来 true になります。

      ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページがロードを開始するのを待機します。このフラグを設定することで、待機をオプトアウトできます。これは、アクセスできないページにナビゲートするなどの例外的な場合にのみ必要です。デフォルトは false です。

    • setPosition Position (任意)#

      要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setTrial boolean (オプション)追加されたバージョン: v1.11#

      設定すると、このメソッドは アクション可能性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備ができるまで待機するのに便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial に関係なく押されます。

戻り値

dblclick​

v1.9より前に追加 page.dblclick
推奨されません

代わりにロケーターベースのLocator.dblclick()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行して、selectorに一致する要素をダブルクリックします。

  1. selectorに一致する要素を見つけます。見つからない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. setForceオプションが設定されていない限り、一致する要素に対して操作可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  3. 必要に応じて要素を表示するためにスクロールします。
  4. 要素の中心、または指定されたsetPositionでダブルクリックするには、Page.mouse()を使用します。

すべてのステップを合わせても指定されたsetTimeout時間内に完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロにすると、これを無効にします。

注

page.dblclick()は、2つのclickイベントと1つのdblclickイベントをディスパッチします。

使用法

Page.dblclick(selector);
Page.dblclick(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.DblclickOptions (任意)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (任意)#

      デフォルトは left です。

    • setDelay double (任意)#

      mousedown と mouseup の間の待機時間 (ミリ秒単位)。デフォルトは 0 です。

    • setForce boolean (任意)#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (任意)#

      押す修飾キー。操作中にこれらの修飾キーのみが押されていることを保証し、現在の修飾キーを元に戻します。指定しない場合、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows と Linux では "Control" に、macOS では "Meta" に解決されます。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setPosition Position (任意)#

      要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setTrial boolean (オプション)追加されたバージョン: v1.11#

      設定すると、このメソッドは アクション可能性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備ができるまで待機するのに便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial に関係なく押されます。

戻り値

dispatchEvent​

v1.9より前に追加 page.dispatchEvent
推奨されません

代わりにロケーターベースのLocator.dispatchEvent()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

以下のスニペットは、要素に対して click イベントをディスパッチします。要素の表示状態にかかわらず、click がディスパッチされます。これは element.click() を呼び出すことと同等です。

使用法

page.dispatchEvent("button#submit", "click");

内部的には、指定されたtypeに基づいてイベントのインスタンスを作成し、eventInitプロパティで初期化し、要素でディスパッチします。イベントはデフォルトでcomposed、cancelable、バブルします。

eventInitはイベント固有であるため、初期プロパティのリストについてはイベントのドキュメントを参照してください。

ライブオブジェクトをイベントに渡したい場合は、JSHandle をプロパティ値として指定することもできます。

// Note you can only create DataTransfer in Chromium and Firefox
JSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
page.dispatchEvent("#source", "dragstart", arg);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • type String#

    DOM イベントタイプ: "click"、"dragstart" など。

  • eventInit EvaluationArgument (任意)#

    オプションのイベント固有の初期化プロパティ。

  • options Page.DispatchEventOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

evalOnSelector​

追加バージョン: v1.9 page.evalOnSelector
推奨されません

このメソッドは、要素が操作可能性チェックに合格するのを待たないため、不安定なテストにつながる可能性があります。Locator.evaluate()、その他のLocatorヘルパーメソッド、またはweb-firstアサーションを使用してください。

このメソッドは、ページ内で指定されたセレクターに一致する要素を見つけ、それを最初の引数としてexpressionに渡します。セレクターに一致する要素がない場合、メソッドはエラーをスローします。expressionの値を返します。

expressionがPromiseを返す場合、Page.evalOnSelector()はPromiseが解決されるのを待ってその値を返します。

使用法

String searchValue = (String) page.evalOnSelector("#search", "el => el.value");
String preloadHref = (String) page.evalOnSelector("link[rel=preload]", "el => el.href");
String html = (String) page.evalOnSelector(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");

引数

  • selector String#

    クエリするセレクター。

  • expression String#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (任意)#

    expressionに渡すオプションの引数。

  • options Page.EvalOnSelectorOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

戻り値

evalOnSelectorAll​

追加バージョン: v1.9 page.evalOnSelectorAll
推奨されません

ほとんどの場合、Locator.evaluateAll()、その他のLocatorヘルパーメソッド、およびウェブファーストのアサーションの方が優れています。

このメソッドは、ページ内で指定されたセレクターに一致するすべての要素を見つけ、一致した要素の配列を最初の引数としてexpressionに渡します。expression呼び出しの結果を返します。

expressionがPromiseを返す場合、Page.evalOnSelectorAll()はPromiseが解決されるのを待ってその値を返します。

使用法

boolean divCounts = (boolean) page.evalOnSelectorAll("div", "(divs, min) => divs.length >= min", 10);

引数

  • selector String#

    クエリするセレクター。

  • expression String#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (任意)#

    expressionに渡すオプションの引数。

戻り値

fill​

v1.9より前に追加 page.fill
推奨されません

代わりにロケーターベースのLocator.fill()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、selectorに一致する要素を待機し、操作可能性チェックを待機し、要素にフォーカスし、入力し、入力後にinputイベントをトリガーします。入力フィールドをクリアするために空の文字列を渡すことができることに注意してください。

ターゲット要素が <input>、<textarea>、または [contenteditable] 要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連付けられた コントロール を持つ <label> 要素内にある場合、代わりにコントロールが入力されます。

きめ細やかなキーボードイベントを送信するには Locator.pressSequentially() を使用します。

使用法

Page.fill(selector, value);
Page.fill(selector, value, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • value String#

    <input>、<textarea> または [contenteditable] 要素に入力する値。

  • options Page.FillOptions (任意)

    • setForce boolean (オプション)追加バージョン: v1.13#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

focus​

v1.9より前に追加 page.focus
推奨されません

代わりにロケーターベースのLocator.focus()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、selectorに一致する要素をフェッチし、それにフォーカスします。selectorに一致する要素がない場合、一致する要素がDOMに表示されるまでメソッドは待機します。

使用法

Page.focus(selector);
Page.focus(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.FocusOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

getAttribute​

v1.9より前に追加 page.getAttribute
推奨されません

代わりにロケーターベースのLocator.getAttribute()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素の属性値を返します。

使用法

Page.getAttribute(selector, name);
Page.getAttribute(selector, name, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • name String#

    値を取得する属性名。

  • options Page.GetAttributeOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

hover​

v1.9より前に追加 page.hover
推奨されません

代わりにロケーターベースのLocator.hover()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行して、selectorに一致する要素にカーソルを合わせます。

  1. selectorに一致する要素を見つけます。見つからない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. setForceオプションが設定されていない限り、一致する要素に対して操作可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  3. 必要に応じて要素を表示するためにスクロールします。
  4. 要素の中心、または指定されたsetPositionにカーソルを合わせるには、Page.mouse()を使用します。

すべてのステップを合わせても指定されたsetTimeout時間内に完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロにすると、これを無効にします。

使用法

Page.hover(selector);
Page.hover(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.HoverOptions (任意)

    • setForce boolean (任意)#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (任意)#

      押す修飾キー。操作中にこれらの修飾キーのみが押されていることを保証し、現在の修飾キーを元に戻します。指定しない場合、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows と Linux では "Control" に、macOS では "Meta" に解決されます。

    • setNoWaitAfter boolean (任意)追加バージョン: v1.28#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setPosition Position (任意)#

      要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setTrial boolean (オプション)追加されたバージョン: v1.11#

      設定すると、このメソッドは アクション可能性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備ができるまで待機するのに便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial に関係なく押されます。

戻り値

innerHTML​

v1.9より前に追加 page.innerHTML
推奨されません

代わりにロケーターベースのLocator.innerHTML()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

element.innerHTML を返します。

使用法

Page.innerHTML(selector);
Page.innerHTML(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.InnerHTMLOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

innerText​

v1.9より前に追加 page.innerText
推奨されません

代わりにロケーターベースのLocator.innerText()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

element.innerText を返します。

使用法

Page.innerText(selector);
Page.innerText(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.InnerTextOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

inputValue​

追加バージョン: v1.13 page.inputValue
推奨されません

代わりにロケーターベースのLocator.inputValue()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

選択した <input>、<textarea>、または <select> 要素の input.value を返します。

非入力要素の場合はスローされます。ただし、要素が関連する コントロールを持つ <label> 要素内にある場合は、コントロールの値を返します。

使用法

Page.inputValue(selector);
Page.inputValue(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.InputValueOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

isChecked​

v1.9より前に追加 page.isChecked
推奨されません

代わりにロケーターベースのLocator.isChecked()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素がチェックされているかどうかを返します。要素がチェックボックスまたはラジオ入力でない場合、スローします。

使用法

Page.isChecked(selector);
Page.isChecked(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.IsCheckedOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

isDisabled​

v1.9より前に追加 page.isDisabled
推奨されません

代わりにロケーターベースのLocator.isDisabled()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素が無効になっているかどうかを返します。有効 の逆です。

使用法

Page.isDisabled(selector);
Page.isDisabled(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.IsDisabledOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

isEditable​

v1.9より前に追加 page.isEditable
推奨されません

代わりにロケーターベースのLocator.isEditable()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素が編集可能かどうかを返します。

使用法

Page.isEditable(selector);
Page.isEditable(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.IsEditableOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

isEnabled​

v1.9より前に追加 page.isEnabled
推奨されません

ロケーターベースのLocator.isEnabled()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素が 有効 であるかどうかを返します。

使用法

Page.isEnabled(selector);
Page.isEnabled(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.IsEnabledOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

isHidden​

v1.9より前に追加 page.isHidden
推奨されません

代わりにロケーターベースのLocator.isHidden()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素が非表示かどうかを返します。visibleの反対です。どの要素にも一致しないselectorは非表示と見なされます。

使用法

Page.isHidden(selector);
Page.isHidden(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.IsHiddenOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      非推奨

      このオプションは無視されます。Page.isHidden()は要素が非表示になるのを待たずにすぐに返します。

戻り値

isVisible​

v1.9より前に追加 page.isVisible
推奨されません

代わりにロケーターベースのLocator.isVisible()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素がvisibleであるかどうかを返します。どの要素にも一致しないselectorは、可視ではないと見なされます。

使用法

Page.isVisible(selector);
Page.isVisible(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.IsVisibleOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      非推奨

      このオプションは無視されます。Page.isVisible()は要素が可視になるのを待たずにすぐに返します。

戻り値

press​

v1.9より前に追加 page.press
推奨されません

代わりにロケーターベースのLocator.press()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素にフォーカスし、その後 Keyboard.down() と Keyboard.up() を使用します。

keyは、意図したkeyboardEvent.key値を指定するか、テキストを生成するための一文字を指定できます。key値のスーパーセットはこちらで見つけることができます。キーの例は次のとおりです。

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUpなど。

以下の修飾ショートカットもサポートされています：Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta。 ControlOrMetaはWindowsおよびLinuxではControlに、macOSではMetaに解決されます。

Shiftを押し続けると、keyに対応するテキストが大文字で入力されます。

keyが一文字の場合、大文字と小文字を区別するため、aとAの値はそれぞれ異なるテキストを生成します。

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

使用法

Page page = browser.newPage();
page.navigate("https://keycode.info");
page.press("body", "A");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("A.png")));
page.press("body", "ArrowLeft");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("ArrowLeft.png" )));
page.press("body", "Shift+O");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("O.png" )));

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • key String#

    押すキーの名前、または ArrowLeft や a などの生成する文字。

  • options Page.PressOptions (任意)

    • setDelay double (任意)#

      keydown と keyup の間の待機時間 (ミリ秒)。デフォルトは 0 です。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは将来 true になります。

      ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページがロードを開始するのを待機します。このフラグを設定することで、待機をオプトアウトできます。これは、アクセスできないページにナビゲートするなどの例外的な場合にのみ必要です。デフォルトは false です。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

querySelector​

追加バージョン: v1.9 page.querySelector
推奨されません

ロケーターベースのPage.locator()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、ページ内で指定されたセレクターに一致する要素を検索します。セレクターに一致する要素がない場合、戻り値は null に解決されます。ページ上の要素を待機するには、 Locator.waitFor() を使用してください。

使用法

Page.querySelector(selector);
Page.querySelector(selector, options);

引数

  • selector String#

    クエリするセレクター。

  • options Page.QuerySelectorOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

戻り値

querySelectorAll​

追加バージョン: v1.9 page.querySelectorAll
推奨されません

ロケーターベースのPage.locator()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、ページ内で指定されたセレクターに一致するすべての要素を検索します。セレクターに一致する要素がない場合、戻り値は [] に解決されます。

使用法

Page.querySelectorAll(selector);

引数

  • selector String#

    クエリするセレクター。

戻り値

selectOption​

v1.9より前に追加 page.selectOption
推奨されません

代わりにロケーターベースのLocator.selectOption()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、セレクターに一致する要素を待ち、アクション可能性のチェックを待ち、指定されたすべてのオプションが <select> 要素に存在するまで待機し、これらのオプションを選択します。

ターゲット要素が<select>要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連するコントロールを持つ<label>要素内にある場合、代わりにそのコントロールが使用されます。

正常に選択されたオプション値の配列を返します。

提供されたすべてのオプションが選択されると、changeおよびinputイベントをトリガーします。

使用法

// Single selection matching the value or label
page.selectOption("select#colors", "blue");
// single selection matching both the value and the label
page.selectOption("select#colors", new SelectOption().setLabel("Blue"));
// multiple selection
page.selectOption("select#colors", new String[] {"red", "green", "blue"});

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • values null | String | ElementHandle | String[] | SelectOption | ElementHandle[] | SelectOption[]#

    • setValue String (任意)

      option.value で一致します。任意。

    • setLabel String (任意)

      option.label で一致します。任意。

    • setIndex int (任意)

      インデックスで一致します。任意。

    選択するオプション。 <select> に multiple 属性がある場合、一致するすべてのオプションが選択され、そうでない場合は、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。文字列値は値とラベルの両方に一致します。すべての指定されたプロパティが一致する場合、オプションは一致すると見なされます。

  • options Page.SelectOptionOptions (任意)

    • setForce boolean (オプション)追加バージョン: v1.13#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

setChecked​

追加されたバージョン: v1.15 page.setChecked
推奨されません

代わりにロケーターベースのLocator.setChecked()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行してセレクターに一致する要素をチェックまたはアンチェックします

  1. セレクターに一致する要素を見つけます。要素がない場合は、一致する要素がDOMにアタッチされるまで待機します。
  2. 一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはエラーをスローします。
  3. 要素がすでに正しいチェック状態である場合、このメソッドはすぐに戻ります。
  4. setForceオプションが設定されていない限り、一致した要素に対してアクション可能性のチェックを待ちます。チェック中に要素がデタッチされた場合、すべてのアクションが再試行されます。
  5. 必要に応じて要素を表示するためにスクロールします。
  6. 要素の中心をクリックするには Page.mouse() を使用します。
  7. 要素がチェックまたはチェック解除されたことを確認します。そうでない場合、このメソッドはエラーをスローします。

すべてのステップが指定されたsetTimeout時間内に完了しない場合、このメソッドはTimeoutErrorをスローします。タイムアウトに0を渡すと、この機能は無効になります。

使用法

Page.setChecked(selector, checked);
Page.setChecked(selector, checked, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • checked boolean#

    チェックボックスをチェックするか、チェックを外すか。

  • options Page.SetCheckedOptions (任意)

    • setForce boolean (任意)#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setPosition Position (任意)#

      要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

    • setStrict boolean (任意)#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setTrial boolean (任意)#

      設定すると、このメソッドは アクション可能性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備ができるまで待機するのに便利です。

戻り値

setInputFiles​

v1.9より前に追加 page.setInputFiles
推奨されません

代わりにロケーターベースのLocator.setInputFiles()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

ファイル入力の値を、これらのファイルパスまたはファイルに設定します。filePaths の一部が相対パスである場合、現在の作業ディレクトリを基準に解決されます。空の配列の場合、選択されたファイルをクリアします。[webkitdirectory] 属性を持つ入力の場合、単一のディレクトリパスのみがサポートされます。

このメソッドは、セレクターが input要素を指していることを期待します。ただし、要素が関連付けられたコントロールを持つ <label> 要素内にある場合は、代わりにコントロールをターゲットとします。

使用法

Page.setInputFiles(selector, files);
Page.setInputFiles(selector, files, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • files Path | Path[] | FilePayload | FilePayload[]#

    • setName String

      ファイル名

    • setMimeType String

      ファイルタイプ

    • setBuffer byte[]

      ファイル内容

  • options Page.SetInputFilesOptions (任意)

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

tap​

v1.9より前に追加 page.tap
推奨されません

代わりにロケーターベースのLocator.tap()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行してセレクターに一致する要素をタップします。

  1. セレクターに一致する要素を見つけます。要素がない場合は、一致する要素がDOMにアタッチされるまで待機します。
  2. setForceオプションが設定されていない限り、一致した要素に対してアクション可能性のチェックを待ちます。チェック中に要素がデタッチされた場合、すべてのアクションが再試行されます。
  3. 必要に応じて要素を表示するためにスクロールします。
  4. Page.touchscreen()を使用して要素の中央、または指定されたsetPositionをタップします。

すべてのステップが指定されたsetTimeout時間内に完了しない場合、このメソッドはTimeoutErrorをスローします。タイムアウトに0を渡すと、この機能は無効になります。

注

Page.tap() メソッドは、ブラウザコンテキストのsetHasTouchオプションが false の場合、例外をスローします。

使用法

Page.tap(selector);
Page.tap(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.TapOptions (任意)

    • setForce boolean (任意)#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (任意)#

      押す修飾キー。操作中にこれらの修飾キーのみが押されていることを保証し、現在の修飾キーを元に戻します。指定しない場合、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows と Linux では "Control" に、macOS では "Meta" に解決されます。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setPosition Position (任意)#

      要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setTrial boolean (オプション)追加されたバージョン: v1.11#

      設定すると、このメソッドは アクション可能性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備ができるまで待機するのに便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial に関係なく押されます。

戻り値

textContent​

v1.9より前に追加 page.textContent
推奨されません

代わりにロケーターベースのLocator.textContent()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

element.textContent を返します。

使用法

Page.textContent(selector);
Page.textContent(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.TextContentOptions (任意)

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

type​

v1.9より前に追加 page.type
非推奨

ほとんどの場合、代わりにLocator.fill()を使用する必要があります。ページに特別なキーボード処理がある場合にのみ、キーを1つずつ押す必要があります。この場合はLocator.pressSequentially()を使用してください。

テキストの各文字に対してkeydown、keypress/input、およびkeyupイベントを送信します。page.typeは、きめ細かなキーボードイベントを送信するために使用できます。フォームフィールドに値を入力するには、Page.fill()を使用します。

Control や ArrowDown のような特殊キーを押すには、Keyboard.press() を使用します。

使用法

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • text String#

    フォーカスされた要素に入力するテキスト。

  • options Page.TypeOptions (任意)

    • setDelay double (任意)#

      キー押下間の待機時間（ミリ秒）。デフォルトは0です。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

uncheck​

v1.9より前に追加 page.uncheck
推奨されません

代わりにロケーターベースのLocator.uncheck()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行してセレクターに一致する要素のチェックを外します。

  1. セレクターに一致する要素を見つけます。要素がない場合は、一致する要素がDOMにアタッチされるまで待機します。
  2. 一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはスローされます。要素がすでにチェック解除されている場合、このメソッドは即座に返します。
  3. setForceオプションが設定されていない限り、一致した要素に対してアクション可能性のチェックを待ちます。チェック中に要素がデタッチされた場合、すべてのアクションが再試行されます。
  4. 必要に応じて要素を表示するためにスクロールします。
  5. 要素の中心をクリックするには Page.mouse() を使用します。
  6. 要素がチェックされていないことを確認します。そうでない場合、このメソッドはエラーをスローします。

すべてのステップが指定されたsetTimeout時間内に完了しない場合、このメソッドはTimeoutErrorをスローします。タイムアウトに0を渡すと、この機能は無効になります。

使用法

Page.uncheck(selector);
Page.uncheck(selector, options);

引数

  • selector String#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • options Page.UncheckOptions (任意)

    • setForce boolean (任意)#

      アクション可能性 チェックをバイパスするかどうか。デフォルトは false です。

    • setNoWaitAfter boolean (任意)#

      非推奨

      このオプションは効果がありません。

      このオプションは効果がありません。

    • setPosition 位置 (オプション)追加されたバージョン: v1.11#

      要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

    • setTrial boolean (オプション)追加されたバージョン: v1.11#

      設定すると、このメソッドは アクション可能性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備ができるまで待機するのに便利です。

戻り値

waitForNavigation​

v1.9より前に追加 page.waitForNavigation
非推奨

このメソッドは本質的に競合が発生しやすいため、代わりにPage.waitForURL()を使用してください。

メインフレームのナビゲーションを待機し、メインリソースのレスポンスを返します。複数のリダイレクトが発生した場合、ナビゲーションは最後のRリダイレクトのレスポンスで解決されます。異なるアンカーへのナビゲーションやHistory APIの使用によるナビゲーションの場合、ナビゲーションはnullで解決されます。

使用法

これは、ページが新しいURLにナビゲートするか、再読み込みされるときに解決されます。ページが間接的にナビゲーションを引き起こすコードを実行する場合に便利です。例えば、クリックターゲットにsetTimeoutからナビゲーションをトリガーするonclickハンドラーがある場合などです。この例を考えてみてください。

// The method returns after navigation has finished
Response response = page.waitForNavigation(() -> {
  // This action triggers the navigation after a timeout.
  page.getByText("Navigate after timeout").click();
});
注

URL を変更するために History API を使用することは、ナビゲーションと見なされます。

引数

  • options Page.WaitForNavigationOptions (任意)

    • setTimeout double (任意)#

      ミリ秒単位の最大操作時間。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値は、BrowserContext.setDefaultNavigationTimeout()、BrowserContext.setDefaultTimeout()、Page.setDefaultNavigationTimeout()、またはPage.setDefaultTimeout()メソッドを使用して変更できます。

    • setUrl String | Pattern | Predicate<String> (任意)#

      ナビゲーションを待機中に一致させる[URL]を受け取るグロブパターン、正規表現パターン、または述語。ワイルドカード文字のない文字列がパラメータの場合、メソッドは文字列と正確に一致するURLへのナビゲーションを待機します。

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (任意)#

      操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

      • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
      • 'load' - loadイベントが発火したときに操作が終了したと見なします。
      • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
      • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

  • callback Runnable追加バージョン: v1.9#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForSelector​

v1.9より前に追加 page.waitForSelector
推奨されません

可視性をアサートするWebアサーションまたはロケーターベースのLocator.waitFor()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

セレクターで指定された要素がsetStateオプションを満たした場合に返ります。hiddenまたはdetachedを待機している場合はnullを返します。

注

Playwrightは、アクションを実行する前に要素が準備できるのを自動的に待機します。LocatorオブジェクトとWebファーストのアサーションを使用すると、コードからセレクター待機が不要になります。

セレクターがsetStateオプション (DOMに現れる/消える、または可視/非可視になる) を満たすのを待ちます。メソッド呼び出し時にセレクターが既に条件を満たしている場合、メソッドはすぐに返ります。setTimeoutミリ秒の間セレクターが条件を満たさない場合、関数は例外をスローします。

使用法

このメソッドはナビゲーションをまたいで動作します

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType chromium = playwright.chromium();
      Browser browser = chromium.launch();
      Page page = browser.newPage();
      for (String currentURL : Arrays.asList("https://google.com", "https://bbc.com")) {
        page.navigate(currentURL);
        ElementHandle element = page.waitForSelector("img");
        System.out.println("Loaded image: " + element.getAttribute("src"));
      }
      browser.close();
    }
  }
}

引数

  • selector String#

    クエリするセレクター。

  • options Page.WaitForSelectorOptions (任意)

    • setState enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN } (任意)#

      デフォルトは'visible'です。以下のいずれかになります。

      • 'attached' - 要素がDOMに存在することを待ちます。
      • 'detached' - 要素がDOMに存在しないことを待ちます。
      • 'visible' - 要素が空でない境界ボックスを持ち、visibility:hiddenがないことを待ちます。コンテンツがない要素やdisplay:noneの要素は空の境界ボックスを持つため、可視とはみなされないことに注意してください。
      • 'hidden' - 要素がDOMからデタッチされているか、空の境界ボックスを持つか、またはvisibility:hiddenを持つことを待ちます。これは'visible'オプションとは逆です。

    • setStrict boolean (オプション)追加されたバージョン: v1.14#

      trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

    • setTimeout double (任意)#

      最大時間 (ミリ秒)。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

waitForTimeout​

v1.9より前に追加 page.waitForTimeout
推奨されません

本番環境でタイムアウトを待機しないでください。時間を待機するテストは本質的に不安定です。自動的に待機するLocatorアクションとWebアサーションを使用してください。

指定されたミリ秒単位のタイムアウトを待機します。

page.waitForTimeout()はデバッグ目的でのみ使用されるべきであることに注意してください。本番環境でタイマーを使用するテストは不安定になる可能性があります。代わりに、ネットワークイベント、セレクターの表示など、他のシグナルを使用してください。

使用法

// wait for 1 second
page.waitForTimeout(1000);

引数

  • timeout double#

    待機するタイムアウト

戻り値