主要コンテンツにスキップ

Selectors

セレクターはカスタムセレクターエンジンをインストールするために使用できます。詳細については、拡張性を参照してください。

メソッド​

register​

v1.9より前に追加 selectors.register

セレクターはページを作成する前に登録する必要があります。

使用法

タグ名に基づいて要素をクエリするセレクターエンジンの登録例

// Script that evaluates to a selector engine instance. The script is evaluated in the page context.
String createTagNameEngine = "{\n" +
  "  // Returns the first element matching given selector in the root's subtree.\n" +
  "  query(root, selector) {\n" +
  "    return root.querySelector(selector);\n" +
  "  },\n" +
  "  // Returns all elements matching given selector in the root's subtree.\n" +
  "  queryAll(root, selector) {\n" +
  "    return Array.from(root.querySelectorAll(selector));\n" +
  "  }\n" +
  "}";
// Register the engine. Selectors will be prefixed with "tag=".
playwright.selectors().register("tag", createTagNameEngine);
Browser browser = playwright.firefox().launch();
Page page = browser.newPage();
page.setContent("<div><button>Click me</button></div>");
// Use the selector prefixed with its name.
Locator button = page.locator("tag=button");
// Combine it with built-in locators.
page.locator("tag=div").getByText("Click me").click();
// Can use it in any methods supporting selectors.
int buttonCount = (int) page.locator("tag=button").count();
browser.close();

引数

  • name String#

    セレクターでプレフィックスとして使用される名前 (例: {name: 'foo'} とすると foo=myselectorbody セレクターが有効になります)。`[a-zA-Z0-9_]` の文字のみを含めることができます。

  • script String | Path#

    セレクターエンジンのインスタンスとして評価されるスクリプトです。このスクリプトはページコンテキストで評価されます。

  • options Selectors.RegisterOptions (オプション)

    • setContentScript boolean (オプション)#

      このセレクターエンジンを分離されたJavaScript環境で実行するかどうかを指定します。この環境は同じDOMにアクセスできますが、フレームのスクリプトからのJavaScriptオブジェクトにはアクセスできません。デフォルトはfalseです。このエンジンが他の登録済みエンジンと一緒に使用される場合、コンテンツスクリプトとして実行されることは保証されないことに注意してください。

戻り値

setTestIdAttribute​

追加バージョン: v1.27 selectors.setTestIdAttribute

Page.getByTestId() で使用するカスタム属性名を定義します。デフォルトではdata-testidが使用されます。

使用法

Selectors.setTestIdAttribute(attributeName);

引数

  • attributeName String#

    テストID属性名。