扩展性

自定义选择器引擎

Playwright 支持自定义选择器引擎,可以通过 selectors.register() 注册。

选择器引擎应具备以下属性:

  • query:查询相对于根元素的第一个匹配选择器的元素。

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