Skip to main content

Selectors

Selectors can be used to install custom selector engines. See Working with selectors for more information.

selectors.register(name, script[, options])​

Added in: v1.8
  • name <string> Name that is used in selectors as a prefix, e.g. {name: 'foo'} enables foo=myselectorbody selectors. May only contain [a-zA-Z0-9_] characters.#
  • script <function|string|Object> Script that evaluates to a selector engine instance. The script is evaluated in the page context.#
    • path? <string> Path to the JavaScript file. If path is a relative path, then it is resolved relative to the current working directory. Optional.
    • content? <string> Raw script content. Optional.
  • options? <Object>
    • contentScript? <boolean> Whether to run this selector engine in isolated JavaScript environment. This environment has access to the same DOM, but not any JavaScript objects from the frame's scripts. Defaults to false. Note that running as a content script is not guaranteed when this engine is used together with other registered engines.#
  • returns: <Promise<void>>#

An example of registering selector engine that queries elements based on a tag name:

const { selectors, firefox } = require('playwright');  // 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');
  // Combine it with other selector engines.
  await page.locator('tag=div >> text="Click me"').click();
  // Can use it in any methods supporting selectors.
  const buttonCount = await page.locator('tag=button').count();

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

selectors.setTestIdAttribute(attributeName)​

Added in: v1.27
  • attributeName <string> Test id attribute name.#
  • returns: <void>#

Defines custom attribute name to be used in page.getByTestId(testId). data-testid is used by default.