拡張性

カスタムセレクターエンジン

Playwrightは、selectors.register() で登録されたカスタムセレクターエンジンをサポートしています。

セレクターエンジンは以下のプロパティを持つ必要があります

• rootに対してselectorに一致する最初の要素をクエリするためのquery関数。
• rootに対してselectorに一致するすべての要素をクエリするためのqueryAll関数。

デフォルトでは、エンジンはフレームのJavaScriptコンテキストで直接実行され、例えばアプリケーション定義関数を呼び出すことができます。フレーム内のJavaScriptからエンジンを隔離し、DOMへのアクセスを残すには、{contentScript: true}オプションでエンジンを登録します。コンテンツスクリプトエンジンは、グローバルオブジェクトの改ざん、例えばNode.prototypeメソッドの変更などから保護されているため、より安全です。すべての組み込みセレクターエンジンはコンテンツスクリプトとして実行されます。なお、他のカスタムエンジンと併用する場合、コンテンツスクリプトとしての実行は保証されません。

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

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

baseTest.ts

import { test as base } from '@playwright/test';

export { expect } from '@playwright/test';

// 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));
  }
});

export const test = base.extend<{}, { selectorRegistration: void }>({
  // Register selectors once per worker.
  selectorRegistration: [async ({ playwright }, use) => {
    // Register the engine. Selectors will be prefixed with "tag=".
    await playwright.selectors.register('tag', createTagNameEngine);
    await use();
  }, { scope: 'worker', auto: true }],
});

example.spec.ts

import { test, expect } from './baseTest';

test('selector engine test', async ({ page }) => {
  // Now we can use 'tag=' selectors.
  const button = page.locator('tag=button');
  await button.click();

  // We can combine it with built-in locators.
  await page.locator('tag=div').getByText('Click me').click();

  // We can use it in any methods supporting selectors.
  await expect(page.locator('tag=button')).toHaveCount(3);
});