com.microsoft.playwright

Interface Selectors

public interface Selectors

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Selectors.RegisterOptions

Method Summary

Modifier and Type	Method and Description
default void	register(String name, Path script) An example of registering selector engine that queries elements based on a tag name:
void	register(String name, Path script, Selectors.RegisterOptions options) An example of registering selector engine that queries elements based on a tag name:
default void	register(String name, String script) An example of registering selector engine that queries elements based on a tag name:
void	register(String name, String script, Selectors.RegisterOptions options) An example of registering selector engine that queries elements based on a tag name:

Method Detail

register

default void register(String name,
                      String script)

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

 // Script that evaluates to a selector engine instance.
 String createTagNameEngine = "{\n" +
   "  // Returns the first element matching given selector in the root's subtree.\n" +
   "  query(root, selector) {\n" +
   "    return root.querySelector(selector);\n" +
   "  },\n" +
   "  // Returns all elements matching given selector in the root's subtree.\n" +
   "  queryAll(root, selector) {\n" +
   "    return Array.from(root.querySelectorAll(selector));\n" +
   "  }\n" +
   "}";
 // Register the engine. Selectors will be prefixed with "tag=".
 playwright.selectors().register("tag", createTagNameEngine);
 Browser browser = playwright.firefox().launch();
 Page page = browser.newPage();
 page.setContent("<div><button>Click me</button></div>");
 // Use the selector prefixed with its name.
 ElementHandle button = page.querySelector("tag=button");
 // Combine it with other selector engines.
 page.click("tag=div >> text=\"Click me\"");
 // Can use it in any methods supporting selectors.
 int buttonCount = (int) page.evalOnSelectorAll("tag=button", "buttons => buttons.length");
 browser.close();
 

Parameters:

name - 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 - Script that evaluates to a selector engine instance.

register

void register(String name,
              String script,
              Selectors.RegisterOptions options)

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

 // Script that evaluates to a selector engine instance.
 String createTagNameEngine = "{\n" +
   "  // Returns the first element matching given selector in the root's subtree.\n" +
   "  query(root, selector) {\n" +
   "    return root.querySelector(selector);\n" +
   "  },\n" +
   "  // Returns all elements matching given selector in the root's subtree.\n" +
   "  queryAll(root, selector) {\n" +
   "    return Array.from(root.querySelectorAll(selector));\n" +
   "  }\n" +
   "}";
 // Register the engine. Selectors will be prefixed with "tag=".
 playwright.selectors().register("tag", createTagNameEngine);
 Browser browser = playwright.firefox().launch();
 Page page = browser.newPage();
 page.setContent("<div><button>Click me</button></div>");
 // Use the selector prefixed with its name.
 ElementHandle button = page.querySelector("tag=button");
 // Combine it with other selector engines.
 page.click("tag=div >> text=\"Click me\"");
 // Can use it in any methods supporting selectors.
 int buttonCount = (int) page.evalOnSelectorAll("tag=button", "buttons => buttons.length");
 browser.close();
 

Parameters:

name - 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 - Script that evaluates to a selector engine instance.

register

default void register(String name,
                      Path script)

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

 // Script that evaluates to a selector engine instance.
 String createTagNameEngine = "{\n" +
   "  // Returns the first element matching given selector in the root's subtree.\n" +
   "  query(root, selector) {\n" +
   "    return root.querySelector(selector);\n" +
   "  },\n" +
   "  // Returns all elements matching given selector in the root's subtree.\n" +
   "  queryAll(root, selector) {\n" +
   "    return Array.from(root.querySelectorAll(selector));\n" +
   "  }\n" +
   "}";
 // Register the engine. Selectors will be prefixed with "tag=".
 playwright.selectors().register("tag", createTagNameEngine);
 Browser browser = playwright.firefox().launch();
 Page page = browser.newPage();
 page.setContent("<div><button>Click me</button></div>");
 // Use the selector prefixed with its name.
 ElementHandle button = page.querySelector("tag=button");
 // Combine it with other selector engines.
 page.click("tag=div >> text=\"Click me\"");
 // Can use it in any methods supporting selectors.
 int buttonCount = (int) page.evalOnSelectorAll("tag=button", "buttons => buttons.length");
 browser.close();
 

Parameters:

name - 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 - Script that evaluates to a selector engine instance.

register

void register(String name,
              Path script,
              Selectors.RegisterOptions options)

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

 // Script that evaluates to a selector engine instance.
 String createTagNameEngine = "{\n" +
   "  // Returns the first element matching given selector in the root's subtree.\n" +
   "  query(root, selector) {\n" +
   "    return root.querySelector(selector);\n" +
   "  },\n" +
   "  // Returns all elements matching given selector in the root's subtree.\n" +
   "  queryAll(root, selector) {\n" +
   "    return Array.from(root.querySelectorAll(selector));\n" +
   "  }\n" +
   "}";
 // Register the engine. Selectors will be prefixed with "tag=".
 playwright.selectors().register("tag", createTagNameEngine);
 Browser browser = playwright.firefox().launch();
 Page page = browser.newPage();
 page.setContent("<div><button>Click me</button></div>");
 // Use the selector prefixed with its name.
 ElementHandle button = page.querySelector("tag=button");
 // Combine it with other selector engines.
 page.click("tag=div >> text=\"Click me\"");
 // Can use it in any methods supporting selectors.
 int buttonCount = (int) page.evalOnSelectorAll("tag=button", "buttons => buttons.length");
 browser.close();
 

Parameters:

name - 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 - Script that evaluates to a selector engine instance.