拡張性

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

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

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

• query 関数: root を基準にして selector に一致する最初の要素をクエリします。
• queryAll 関数: root を基準にして selector に一致するすべての要素をクエリします。

デフォルトでは、エンジンはフレームの 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);
});