セレクター

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

---

メソッド

register

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

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

使用例

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

const { selectors, firefox } = require('@playwright/test');  // Or 'chromium' or 'webkit'.

(async () => {
  // Must be a function that evaluates to a selector engine instance.
  const createTagNameEngine = () => ({
    // Returns the first element matching given selector in the root's subtree.
    query(root, selector) {
      return root.querySelector(selector);
    },

    // Returns all elements matching given selector in the root's subtree.
    queryAll(root, selector) {
      return Array.from(root.querySelectorAll(selector));
    }
  });

  // Register the engine. Selectors will be prefixed with "tag=".
  await selectors.register('tag', createTagNameEngine);

  const browser = await firefox.launch();
  const page = await browser.newPage();
  await page.setContent(`<div><button>Click me</button></div>`);

  // Use the selector prefixed with its name.
  const button = page.locator('tag=button');
  // We can combine it with built-in locators.
  await page.locator('tag=div').getByText('Click me').click();
  // Can use it in any methods supporting selectors.
  const buttonCount = await page.locator('tag=button').count();

  await browser.close();
})();

引数

• name string#

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

• script function | string | Object#

  • path string (optional)

    JavaScriptファイルへのパス。path が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。オプション。

  • content string (optional)

    生のスクリプトコンテンツ。オプション。

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

• options Object (optional)

  • contentScript boolean (optional)#

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

戻り値

• Promise<void>#

---

setTestIdAttribute

v1.27で追加 selectors.setTestIdAttribute

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

使用例

selectors.setTestIdAttribute(attributeName);

引数

• attributeName string#

  テストID属性名。