跳到正文
本页尚未翻译成中文,以下为英文原文。 查看英文版

Locator ​

Added in: v1.14

Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way to find element(s) on the page at any moment. A locator can be created with the page.locator() method.

Learn more about locators.

Methods ​

locator.all() ​

Added in: v1.29

When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.

INFO

locator.all() does not wait for elements to match the locator, and instead immediately returns whatever is present in the page.

When the list of elements changes dynamically, locator.all() will produce unpredictable and flaky results.

When the list of elements is stable, but loaded dynamically, wait for the full list to finish loading before calling locator.all().

Usage

python
for li in await page.get_by_role('listitem').all():
  await li.click();
python
for li in page.get_by_role('listitem').all():
  li.click();

Returns

  • Array<Locator>

locator.all_inner_texts() ​

Added in: v1.14

Returns an array of node.innerText values for all matching nodes.

:::warning[Asserting text]

If you need to assert text on the page, prefer locator_assertions.to_have_text() with use_inner_text option to avoid flakiness. See assertions guide for more details. :::

Usage

python
texts = await page.get_by_role("link").all_inner_texts()
python
texts = page.get_by_role("link").all_inner_texts()

Returns

  • Array<string>

locator.all_text_contents() ​

Added in: v1.14

Returns an array of node.textContent values for all matching nodes.

:::warning[Asserting text]

If you need to assert text on the page, prefer locator_assertions.to_have_text() to avoid flakiness. See assertions guide for more details. :::

Usage

python
texts = await page.get_by_role("link").all_text_contents()
python
texts = page.get_by_role("link").all_text_contents()

Returns

  • Array<string>

locator.and_() ​

Added in: v1.34

Creates a locator that matches both this locator and the argument locator.

Usage

The following example finds a button with a specific title.

python
button = page.get_by_role("button").and_(page.get_by_title("Subscribe"))
python
button = page.get_by_role("button").and_(page.get_by_title("Subscribe"))

Arguments

  • locator Locator

    Additional locator to match.

Returns

  • Locator

locator.aria_snapshot() ​

Added in: v1.49

Captures the aria snapshot of the given element. Read more about aria snapshots and locator_assertions.to_match_aria_snapshot() for the corresponding assertion.

Usage

python
await page.get_by_role("link").aria_snapshot()
python
page.get_by_role("link").aria_snapshot()

Details

This method captures the aria snapshot of the given element. The snapshot is a string that represents the state of the element and its children. The snapshot can be used to assert the state of the element in the test, or to compare it to state in the future.

The ARIA snapshot is represented using YAML markup language:

  • The keys of the objects are the roles and optional accessible names of the elements.
  • The values are either text content or an array of child elements.
  • Generic static text can be represented with the text key.

Below is the HTML markup and the respective ARIA snapshot:

html
<ul aria-label="Links">
  <li><a href="/zh/">Home</a></li>
  <li><a href="/zh/about">About</a></li>
<ul>
yml
- list "Links":
  - listitem:
    - link "Home"
  - listitem:
    - link "About"

An AI-optimized snapshot, controlled by mode, is different from a default snapshot:

  1. Includes element references [ref=e2]. 2. Does not wait for an element matching the locator, and throws when no elements match. 3. Includes snapshots of <iframe>s inside the target. 4. Can omit names that repeat printed descendants, such as a heading containing a link. Names that identify dialogs, landmarks, groups, tables and table headers are retained.

Arguments

  • options Object (optional)

    • boxes boolean (optional) Added in: v1.60

      When true, appends each element's bounding box as [box=x,y,width,height] to the snapshot. Coordinates are relative to the viewport, in CSS pixels, as returned by Element.getBoundingClientRect(). Defaults to false.

    • depth int (optional) Added in: v1.59

      When specified, limits the depth of the snapshot.

    • mode "ai" | "default" (optional) Added in: v1.59

      When set to "ai", returns a snapshot optimized for AI consumption. Defaults to "default". See details for more information.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

Returns

  • string

locator.blur() ​

Added in: v1.28

Calls blur on the element.

Arguments

locator.bounding_box() ​

Added in: v1.14

This method returns the bounding box of the element matching the locator, or null if the element is not visible. The bounding box is calculated relative to the main frame viewport - which is usually the same as the browser window.

Details

Scrolling affects the returned bounding box, similarly to Element.getBoundingClientRect. That means x and/or y may be negative.

Elements from child frames return the bounding box relative to the main frame, unlike the Element.getBoundingClientRect.

Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following snippet should click the center of the element.

Usage

python
box = await page.get_by_role("button").bounding_box()
await page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)
python
box = page.get_by_role("button").bounding_box()
page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)

Arguments

Returns

  • null | Object

locator.check() ​

Added in: v1.14

Ensure that checkbox or radio element is checked.

Details

Performs the following steps:

  1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
  2. Wait for actionability checks on the element, unless force option is set.
  3. Scroll the element into view if needed.
  4. Use page.mouse to click in the center of the element.
  5. Ensure that the element is now checked. If not, this method throws.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

python
await page.get_by_role("checkbox").check()
python
page.get_by_role("checkbox").check()

Arguments

  • options Object (optional)

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • no_wait_after boolean (optional)

      This option has no effect.

    • position Object (optional)

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

      • x float
      • y float
    • scroll "auto" | "none" (optional) Added in: v1.62

      Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • trial boolean (optional)

      When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

locator.clear() ​

Added in: v1.28

Clear the input field.

Details

This method waits for actionability checks, focuses the element, clears it and triggers an input event after clearing.

If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be cleared instead.

Usage

python
await page.get_by_role("textbox").clear()
python
page.get_by_role("textbox").clear()

Arguments

  • options Object (optional)

locator.click() ​

Added in: v1.14

Click an element.

Details

This method clicks the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to click in the center of the element, or the specified position.
  4. Wait for initiated navigations to either succeed or fail, unless no_wait_after option is set.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

Click a button:

python
await page.get_by_role("button").click()
python
page.get_by_role("button").click()

Shift-right-click at a specific position on a canvas:

python
await page.locator("canvas").click(
    button="right", modifiers=["Shift"], position={"x": 23, "y": 32}
)
python
page.locator("canvas").click(
    button="right", modifiers=["Shift"], position={"x": 23, "y": 32}
)

Arguments

  • options Object (optional)

    • button "left" | "right" | "middle" (optional)

      Defaults to left.

    • click_count int (optional)

      defaults to 1. See [UIEvent.detail].

    • delay float (optional)

      Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (optional)

      Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

    • no_wait_after boolean (optional)

      Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

    • position Object (optional)

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

      • x float
      • y float
    • scroll "auto" | "none" (optional) Added in: v1.62

      Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.

    • steps int (optional) Added in: v1.57

      Defaults to 1. Sends n interpolated mousemove events to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a single mousemove event at the destination location.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • trial boolean (optional)

      When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it. Note that keyboard modifiers will be pressed regardless of trial to allow testing elements which are only visible when those keys are pressed.

locator.content_frame() ​

Added in: v1.43

Returns a FrameLocator object pointing to the same iframe as this locator.

Useful when you have a Locator object obtained somewhere, and later on would like to interact with the content inside the frame.

For a reverse operation, use frame_locator.owner().

Usage

python
locator = page.locator("iframe[name=\"embedded\"]")
# ...
frame_locator = locator.content_frame
await frame_locator.get_by_role("button").click()
python
locator = page.locator("iframe[name=\"embedded\"]")
# ...
frame_locator = locator.content_frame
frame_locator.get_by_role("button").click()

Returns

  • FrameLocator

locator.count() ​

Added in: v1.14

Returns the number of elements matching the locator.

:::warning[Asserting count]

If you need to assert the number of elements on the page, prefer locator_assertions.to_have_count() to avoid flakiness. See assertions guide for more details. :::

Usage

python
count = await page.get_by_role("listitem").count()
python
count = page.get_by_role("listitem").count()

Returns

  • int

locator.dblclick() ​

Added in: v1.14

Double-click an element.

Details

This method double clicks the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to double click in the center of the element, or the specified position.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

INFO

element.dblclick() dispatches two click events and a single dblclick event.

Arguments

  • options Object (optional)

    • button "left" | "right" | "middle" (optional)

      Defaults to left.

    • delay float (optional)

      Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (optional)

      Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

    • no_wait_after boolean (optional)

      This option has no effect.

    • position Object (optional)

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

      • x float
      • y float
    • scroll "auto" | "none" (optional) Added in: v1.62

      Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.

    • steps int (optional) Added in: v1.57

      Defaults to 1. Sends n interpolated mousemove events to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a single mousemove event at the destination location.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • trial boolean (optional)

      When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it. Note that keyboard modifiers will be pressed regardless of trial to allow testing elements which are only visible when those keys are pressed.

locator.describe() ​

Added in: v1.53

Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the same element.

Usage

python
button = page.get_by_test_id("btn-sub").describe("Subscribe button")
await button.click()
python
button = page.get_by_test_id("btn-sub").describe("Subscribe button")
button.click()

Arguments

  • description string

    Locator description.

Returns

  • Locator

locator.description() ​

Added in: v1.57

Returns locator description previously set with locator.describe(). Returns null if no custom description has been set.

Usage

python
button = page.get_by_role("button").describe("Subscribe button")
print(button.description())  # "Subscribe button"

input = page.get_by_role("textbox")
print(input.description())  # None
python
button = page.get_by_role("button").describe("Subscribe button")
print(button.description())  # "Subscribe button"

input = page.get_by_role("textbox")
print(input.description())  # None

Returns

  • null | string

locator.dispatch_event() ​

Added in: v1.14

Programmatically dispatch an event on the matching element.

Usage

python
await locator.dispatch_event("click")
python
locator.dispatch_event("click")

Details

The snippet above dispatches the click event on the element. Regardless of the visibility state of the element, click is dispatched. This is equivalent to calling element.click().

Under the hood, it creates an instance of an event based on the given type, initializes it with event_init properties and dispatches it on the element. Events are composed, cancelable and bubble by default.

Since event_init is event-specific, please refer to the events documentation for the lists of initial properties:

You can also specify JSHandle as the property value if you want live objects to be passed into the event:

python
data_transfer = await page.evaluate_handle("new DataTransfer()")
await locator.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})
python
data_transfer = page.evaluate_handle("new DataTransfer()")
locator.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})

Arguments

  • type string

    DOM event type: "click", "dragstart", etc.

  • event_init EvaluationArgument (optional)

    Optional event-specific initialization properties.

  • options Object (optional)

locator.drag_to() ​

Added in: v1.18

Drag the source element towards the target element and drop it.

Details

This method drags the locator to another target locator or target position. It will first move to the source element, perform a mousedown, then move to the target element or position and perform a mouseup.

Usage

python
source = page.locator("#source")
target = page.locator("#target")

await source.drag_to(target)
# or specify exact positions relative to the top-left corners of the elements:
await source.drag_to(
  target,
  source_position={"x": 34, "y": 7},
  target_position={"x": 10, "y": 20}
)
python
source = page.locator("#source")
target = page.locator("#target")

source.drag_to(target)
# or specify exact positions relative to the top-left corners of the elements:
source.drag_to(
  target,
  source_position={"x": 34, "y": 7},
  target_position={"x": 10, "y": 20}
)

Arguments

  • target Locator

    Locator of the element to drag to.

  • options Object (optional)

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • no_wait_after boolean (optional)

      This option has no effect.

    • scroll "auto" | "none" (optional) Added in: v1.62

      Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.

    • source_position Object (optional)

      Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.

      • x float
      • y float
    • steps int (optional) Added in: v1.57

      Defaults to 1. Sends n interpolated mousemove events to represent travel between the mousedown and mouseup of the drag. When set to 1, emits a single mousemove event at the destination location.

    • target_position Object (optional)

      Drops on the target element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.

      • x float
      • y float
    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • trial boolean (optional)

      When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

locator.drop() ​

Added in: v1.60

Simulate an external drag-and-drop of files or clipboard-like data onto this locator.

Details

Dispatches the native dragenter, dragover, and drop events at the center of the target element with a synthetic [DataTransfer] carrying the provided files and/or data entries. Works cross-browser by constructing the [DataTransfer] in the page context.

If the target element's dragover listener does not call preventDefault(), the target is considered to have rejected the drop: Playwright dispatches dragleave and this method throws.

Usage

Drop a file buffer onto an upload area:

Drop plain text and a URL together:

Arguments

  • payload Object

    Data to drop onto the target. Provide files (file paths or in-memory buffers), data (a mime-type → string map for clipboard-like content such as text/plain, text/html, text/uri-list), or both.

    • files path | Array<path> | Object | Array<Object> (optional)

      • name string

        File name

      • mime_type string

        File type

      • buffer Buffer

        File content

    • data Object<string, string> (optional)

  • options Object (optional)

    • position Object (optional)

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

      • x float
      • y float
    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

locator.element_handle() ​

Added in: v1.14

Discouraged

Always prefer using Locators and web assertions over ElementHandles because latter are inherently racy.

Resolves given locator to the first matching DOM element. If there are no matching elements, waits for one. If multiple elements match the locator, throws.

Arguments

Returns

  • ElementHandle

locator.element_handles() ​

Added in: v1.14

Discouraged

Always prefer using Locators and web assertions over ElementHandles because latter are inherently racy.

Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list.

Returns

  • Array<ElementHandle>

locator.evaluate() ​

Added in: v1.14

Execute JavaScript code in the page, taking the matching element as an argument.

Details

Returns the return value of expression, called with the matching element as a first argument, and arg as a second argument.

If expression returns a [Promise], this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

Usage

Passing argument to expression:

python
result = await page.get_by_testid("myId").evaluate("(element, [x, y]) => element.textContent + ' ' + x * y", [7, 8])
print(result) # prints "myId text 56"
python
result = page.get_by_testid("myId").evaluate("(element, [x, y]) => element.textContent + ' ' + x * y", [7, 8])
print(result) # prints "myId text 56"

Arguments

  • expression string

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)

    Optional argument to pass to expression.

  • options Object (optional)

    • timeout float (optional)

      Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved, evaluation itself is not limited by the timeout. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

Returns

  • Serializable

locator.evaluate_all() ​

Added in: v1.14

Execute JavaScript code in the page, taking all matching elements as an argument.

Details

Returns the return value of expression, called with an array of all matching elements as a first argument, and arg as a second argument.

If expression returns a [Promise], this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

Usage

python
locator = page.locator("div")
more_than_ten = await locator.evaluate_all("(divs, min) => divs.length > min", 10)
python
locator = page.locator("div")
more_than_ten = locator.evaluate_all("(divs, min) => divs.length > min", 10)

Arguments

  • expression string

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)

    Optional argument to pass to expression.

Returns

  • Serializable

locator.evaluate_handle() ​

Added in: v1.14

Execute JavaScript code in the page, taking the matching element as an argument, and return a JSHandle with the result.

Details

Returns the return value of expression as aJSHandle, called with the matching element as a first argument, and arg as a second argument.

The only difference between locator.evaluate() and locator.evaluate_handle() is that locator.evaluate_handle() returns JSHandle.

If expression returns a [Promise], this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

See page.evaluate_handle() for more details.

Arguments

  • expression string

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)

    Optional argument to pass to expression.

  • options Object (optional)

    • timeout float (optional)

      Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved, evaluation itself is not limited by the timeout. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

Returns

  • JSHandle

locator.fill() ​

Added in: v1.14

Set a value to the input field.

Usage

python
await page.get_by_role("textbox").fill("example value")
python
page.get_by_role("textbox").fill("example value")

Details

This method waits for actionability checks, focuses the element, fills it and triggers an input event after filling. Note that you can pass an empty string to clear the input field.

If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be filled instead.

To send fine-grained keyboard events, use locator.press_sequentially().

Arguments

  • value string

    Value to set for the <input>, <textarea> or [contenteditable] element.

  • options Object (optional)

locator.filter() ​

Added in: v1.22

This method narrows existing locator according to the options, for example filters by text. It can be chained to filter multiple times.

Usage

python
row_locator = page.locator("tr")
# ...
await row_locator.filter(has_text="text in column 1").filter(
    has=page.get_by_role("button", name="column 2 button")
).screenshot()
python
row_locator = page.locator("tr")
# ...
row_locator.filter(has_text="text in column 1").filter(
    has=page.get_by_role("button", name="column 2 button")
).screenshot()

Arguments

  • options Object (optional)

    • has Locator (optional)

      Narrows down the results of the method to those which contain elements matching this relative locator. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.

      Inner locator must be relative to the outer locator and is queried starting with the outer locator match, not the document root. For example, you can find content that has div in <article><content><div>Playwright</div></content></article>. However, looking for content that has article div will fail, because the inner locator must be relative and should not use any elements outside the content.

      Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.

    • has_not Locator (optional) Added in: v1.33

      Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that does not have div matches <article><span>Playwright</span></article>.

      Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.

    • has_not_text string | RegExp (optional) Added in: v1.33

      Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring.

    • has_text string | RegExp (optional)

      Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.

    • visible boolean (optional) Added in: v1.51

      Only matches visible or invisible elements. Prefer the locator.visible() shortcut when matching only visible elements.

Returns

  • Locator

locator.first() ​

Added in: v1.14

Returns locator to the first matching element.

Returns

  • Locator

locator.focus() ​

Added in: v1.14

Calls focus on the matching element.

Arguments

locator.frame_locator() ​

Added in: v1.17

When working with iframes, you can create a frame locator that will enter the iframe and allow locating elements in that iframe:

Usage

python
locator = page.frame_locator("iframe").get_by_text("Submit")
await locator.click()
python
locator = page.frame_locator("iframe").get_by_text("Submit")
locator.click()

Arguments

  • selector string

    A selector to use when resolving DOM element.

Returns

  • FrameLocator

locator.get_attribute() ​

Added in: v1.14

Returns the matching element's attribute value.

:::warning[Asserting attributes]

If you need to assert an element's attribute, prefer locator_assertions.to_have_attribute() to avoid flakiness. See assertions guide for more details. :::

Arguments

Returns

  • null | string

locator.get_by_alt_text() ​

Added in: v1.27

Allows locating elements by their alt text.

Usage

For example, this method will find the image by alt text "Playwright logo":

html
<img alt='Playwright logo'>
python
await page.get_by_alt_text("Playwright logo").click()
python
page.get_by_alt_text("Playwright logo").click()

Arguments

  • text string | RegExp

    Text to locate the element for.

  • options Object (optional)

    • exact boolean (optional)

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

  • Locator

locator.get_by_label() ​

Added in: v1.27

Allows locating input elements by the text of the associated <label> or aria-labelledby element, or by the aria-label attribute.

Associated <label> elements are also supported for form-associated custom elements.

Usage

For example, this method will find inputs by label "Username" and "Password" in the following DOM:

html
<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
python
await page.get_by_label("Username").fill("john")
await page.get_by_label("Password").fill("secret")
python
page.get_by_label("Username").fill("john")
page.get_by_label("Password").fill("secret")

Arguments

  • text string | RegExp

    Text to locate the element for.

  • options Object (optional)

    • exact boolean (optional)

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

  • Locator

locator.get_by_placeholder() ​

Added in: v1.27

Allows locating input elements by the placeholder text.

Usage

For example, consider the following DOM structure.

html
<input type="email" placeholder="name@example.com" />

You can fill the input after locating it by the placeholder text:

python
await page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")
python
page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")

Arguments

  • text string | RegExp

    Text to locate the element for.

  • options Object (optional)

    • exact boolean (optional)

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

  • Locator

locator.get_by_role() ​

Added in: v1.27

Allows locating elements by their ARIA role, ARIA attributes and accessible name.

Usage

Consider the following DOM structure.

html
<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

You can locate each element by its implicit role:

python
await expect(page.get_by_role("heading", name="Sign up")).to_be_visible()

await page.get_by_role("checkbox", name="Subscribe").check()

await page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()
python
expect(page.get_by_role("heading", name="Sign up")).to_be_visible()

page.get_by_role("checkbox", name="Subscribe").check()

page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()

Details

Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.

Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

Arguments

  • role "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"

    Required aria role.

  • options Object (optional)

    • checked boolean (optional)

      An attribute that is usually set by aria-checked or native <input type=checkbox> controls.

      Learn more about aria-checked.

    • description string | RegExp (optional) Added in: v1.60

      Option to match the accessible description. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.

      Learn more about accessible description.

    • disabled boolean (optional)

      An attribute that is usually set by aria-disabled or disabled.

      INFO

      Unlike most other attributes, disabled is inherited through the DOM hierarchy. Learn more about aria-disabled.

    • exact boolean (optional) Added in: v1.28

      Whether name and description are matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when the value is a regular expression. Note that exact match still trims whitespace.

    • expanded boolean (optional)

      An attribute that is usually set by aria-expanded.

      Learn more about aria-expanded.

    • include_hidden boolean (optional)

      Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.

      Learn more about aria-hidden.

    • level int (optional)

      A number attribute that is usually present for roles heading, listitem, row, treeitem, with default values for <h1>-<h6> elements.

      Learn more about aria-level.

    • name string | RegExp (optional)

      Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.

      Learn more about accessible name.

    • pressed boolean (optional)

      An attribute that is usually set by aria-pressed.

      Learn more about aria-pressed.

    • selected boolean (optional)

      An attribute that is usually set by aria-selected.

      Learn more about aria-selected.

Returns

  • Locator

locator.get_by_test_id() ​

Added in: v1.27

Locate element by the test id.

Usage

Consider the following DOM structure.

html
<button data-testid="directions">Itinéraire</button>

You can locate the element by its test id:

python
await page.get_by_test_id("directions").click()
python
page.get_by_test_id("directions").click()

Details

By default, the data-testid attribute is used as a test id. Use selectors.set_test_id_attribute() to configure a different test id attribute if necessary.

Arguments

  • test_id string | RegExp

    Id to locate the element by.

Returns

  • Locator

locator.get_by_text() ​

Added in: v1.27

Allows locating elements that contain given text.

See also locator.filter() that allows to match by another criteria, like an accessible role, and then filter by the text content.

Usage

Consider the following DOM structure:

html
<div>Hello <span>world</span></div>
<div>Hello</div>

You can locate by text substring, exact string, or a regular expression:

python
# Matches <span>
page.get_by_text("world")

# Matches first <div>
page.get_by_text("Hello world")

# Matches second <div>
page.get_by_text("Hello", exact=True)

# Matches both <div>s
page.get_by_text(re.compile("Hello"))

# Matches second <div>
page.get_by_text(re.compile("^hello$", re.IGNORECASE))
python
# Matches <span>
page.get_by_text("world")

# Matches first <div>
page.get_by_text("Hello world")

# Matches second <div>
page.get_by_text("Hello", exact=True)

# Matches both <div>s
page.get_by_text(re.compile("Hello"))

# Matches second <div>
page.get_by_text(re.compile("^hello$", re.IGNORECASE))

Details

Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.

Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text "Log in" matches <input type=button value="Log in">.

Arguments

  • text string | RegExp

    Text to locate the element for.

  • options Object (optional)

    • exact boolean (optional)

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

  • Locator

locator.get_by_title() ​

Added in: v1.27

Allows locating elements by their title attribute.

Usage

Consider the following DOM structure.

html
<span title='Issues count'>25 issues</span>

You can check the issues count after locating it by the title text:

python
await expect(page.get_by_title("Issues count")).to_have_text("25 issues")
python
expect(page.get_by_title("Issues count")).to_have_text("25 issues")

Arguments

  • text string | RegExp

    Text to locate the element for.

  • options Object (optional)

    • exact boolean (optional)

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

  • Locator

locator.hide_highlight() ​

Added in: v1.60

Hides the element highlight previously added by locator.highlight().

locator.highlight() ​

Added in: v1.20

Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses locator.highlight().

Arguments

  • options Object (optional)

    • style string (optional) Added in: v1.60

      Additional inline CSS applied to the highlight overlay, e.g. "outline: 2px dashed red".

Returns

  • Disposable

locator.hover() ​

Added in: v1.14

Hover over the matching element.

Usage

python
await page.get_by_role("link").hover()
python
page.get_by_role("link").hover()

Details

This method hovers over the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to hover over the center of the element, or the specified position.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Arguments

  • options Object (optional)

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (optional)

      Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

    • no_wait_after boolean (optional) Added in: v1.28

      This option has no effect.

    • position Object (optional)

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

      • x float
      • y float
    • scroll "auto" | "none" (optional) Added in: v1.62

      Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • trial boolean (optional)

      When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it. Note that keyboard modifiers will be pressed regardless of trial to allow testing elements which are only visible when those keys are pressed.

locator.inner_html() ​

Added in: v1.14

Returns the element.innerHTML.

Arguments

Returns

  • string

locator.inner_text() ​

Added in: v1.14

Returns the element.innerText.

:::warning[Asserting text]

If you need to assert text on the page, prefer locator_assertions.to_have_text() with use_inner_text option to avoid flakiness. See assertions guide for more details. :::

Arguments

Returns

  • string

locator.input_value() ​

Added in: v1.14

Returns the value for the matching <input> or <textarea> or <select> element.

:::warning[Asserting value]

If you need to assert input value, prefer locator_assertions.to_have_value() to avoid flakiness. See assertions guide for more details. :::

Usage

python
value = await page.get_by_role("textbox").input_value()
python
value = page.get_by_role("textbox").input_value()

Details

Throws elements that are not an input, textarea or a select. However, if the element is inside the <label> element that has an associated control, returns the value of the control.

Arguments

Returns

  • string

locator.is_checked() ​

Added in: v1.14

Returns whether the element is checked. Throws if the element is not a checkbox or radio input.

:::warning[Asserting checked state]

If you need to assert that checkbox is checked, prefer locator_assertions.to_be_checked() to avoid flakiness. See assertions guide for more details. :::

Usage

python
checked = await page.get_by_role("checkbox").is_checked()
python
checked = page.get_by_role("checkbox").is_checked()

Arguments

Returns

  • boolean

locator.is_disabled() ​

Added in: v1.14

Returns whether the element is disabled, the opposite of enabled.

:::warning[Asserting disabled state]

If you need to assert that an element is disabled, prefer locator_assertions.to_be_disabled() to avoid flakiness. See assertions guide for more details. :::

Usage

python
disabled = await page.get_by_role("button").is_disabled()
python
disabled = page.get_by_role("button").is_disabled()

Arguments

Returns

  • boolean

locator.is_editable() ​

Added in: v1.14

Returns whether the element is editable. If the target element is not an <input>, <textarea>, <select>, [contenteditable] and does not have a role allowing [aria-readonly], this method throws an error.

:::warning[Asserting editable state]

If you need to assert that an element is editable, prefer locator_assertions.to_be_editable() to avoid flakiness. See assertions guide for more details. :::

Usage

python
editable = await page.get_by_role("textbox").is_editable()
python
editable = page.get_by_role("textbox").is_editable()

Arguments

Returns

  • boolean

locator.is_enabled() ​

Added in: v1.14

Returns whether the element is enabled.

:::warning[Asserting enabled state]

If you need to assert that an element is enabled, prefer locator_assertions.to_be_enabled() to avoid flakiness. See assertions guide for more details. :::

Usage

python
enabled = await page.get_by_role("button").is_enabled()
python
enabled = page.get_by_role("button").is_enabled()

Arguments

Returns

  • boolean

locator.is_hidden() ​

Added in: v1.14

Returns whether the element is hidden, the opposite of visible.

:::warning[Asserting visibility]

If you need to assert that element is hidden, prefer locator_assertions.to_be_hidden() to avoid flakiness. See assertions guide for more details. :::

Usage

python
hidden = await page.get_by_role("button").is_hidden()
python
hidden = page.get_by_role("button").is_hidden()

Arguments

  • options Object (optional)

    • timeout float (optional)

Returns

  • boolean

locator.is_visible() ​

Added in: v1.14

Returns whether the element is visible.

:::warning[Asserting visibility]

If you need to assert that element is visible, prefer locator_assertions.to_be_visible() to avoid flakiness. See assertions guide for more details. :::

Usage

python
visible = await page.get_by_role("button").is_visible()
python
visible = page.get_by_role("button").is_visible()

Arguments

  • options Object (optional)

    • timeout float (optional)

Returns

  • boolean

locator.last() ​

Added in: v1.14

Returns locator to the last matching element.

Usage

python
banana = await page.get_by_role("listitem").last
python
banana = page.get_by_role("listitem").last

Returns

  • Locator

locator.locator() ​

Added in: v1.14

The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options, similar to locator.filter() method.

Learn more about locators.

Arguments

  • selector_or_locator string | Locator

    A selector or locator to use when resolving DOM element.

  • options Object (optional)

    • has Locator (optional)

      Narrows down the results of the method to those which contain elements matching this relative locator. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.

      Inner locator must be relative to the outer locator and is queried starting with the outer locator match, not the document root. For example, you can find content that has div in <article><content><div>Playwright</div></content></article>. However, looking for content that has article div will fail, because the inner locator must be relative and should not use any elements outside the content.

      Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.

    • has_not Locator (optional) Added in: v1.33

      Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that does not have div matches <article><span>Playwright</span></article>.

      Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.

    • has_not_text string | RegExp (optional) Added in: v1.33

      Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring.

    • has_text string | RegExp (optional)

      Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.

Returns

  • Locator

locator.normalize() ​

Added in: v1.59

Returns a new locator that uses best practices for referencing the matched element, prioritizing test ids, aria roles, and other user-facing attributes over CSS selectors. This is useful for converting implementation-detail selectors into more resilient, human-readable locators.

Usage

An agent can pick an element by its ref from an page.aria_snapshot() taken in the "ai" mode. Refs only work for the latest snapshot. Normalize the ref locator and convert it to a string to get resilient locator code in your language, the same way codegen does.

Consider the following aria snapshot.

yaml
- button "Submit" [ref=e2]

You can turn the ref into locator code:

python
normalized = await page.get_by_ref("e2").normalize()
print(str(normalized))
# get_by_role("button", name="Submit")
python
normalized = page.get_by_ref("e2").normalize()
print(str(normalized))
# get_by_role("button", name="Submit")

Returns

  • Locator

locator.nth() ​

Added in: v1.14

Returns locator to the n-th matching element. It's zero based, nth(0) selects the first element.

Usage

python
banana = await page.get_by_role("listitem").nth(2)
python
banana = page.get_by_role("listitem").nth(2)

Arguments

  • index int

Returns

  • Locator

locator.or_() ​

Added in: v1.33

Creates a locator matching all elements that match one or both of the two locators.

Note that when both locators match something, the resulting locator will have multiple matches, potentially causing a locator strictness violation.

Usage

Consider a scenario where you'd like to click on a "New email" button, but sometimes a security settings dialog shows up instead. In this case, you can wait for either a "New email" button, or a dialog and act accordingly.

INFO

If both "New email" button and security dialog appear on screen, the "or" locator will match both of them, possibly throwing the "strict mode violation" error. In this case, you can use locator.first() to only match one of them.

python
new_email = page.get_by_role("button", name="New")
dialog = page.get_by_text("Confirm security settings")
await expect(new_email.or_(dialog).first).to_be_visible()
if (await dialog.is_visible()):
  await page.get_by_role("button", name="Dismiss").click()
await new_email.click()
python
new_email = page.get_by_role("button", name="New")
dialog = page.get_by_text("Confirm security settings")
expect(new_email.or_(dialog).first).to_be_visible()
if (dialog.is_visible()):
  page.get_by_role("button", name="Dismiss").click()
new_email.click()

Arguments

  • locator Locator

    Alternative locator to match.

Returns

  • Locator

locator.page() ​

Added in: v1.19

A page this locator belongs to.

Returns

  • Page

locator.press() ​

Added in: v1.14

Focuses the matching element and presses a combination of the keys.

Usage

python
await page.get_by_role("textbox").press("Backspace")
python
page.get_by_role("textbox").press("Backspace")

Details

Focuses the element, and then uses keyboard.down() and keyboard.up().

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta. ControlOrMeta resolves to Control on Windows and Linux and to Meta on macOS.

Holding down Shift will type the text that corresponds to the key in the upper case.

If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

Shortcuts such as key: "Control+o", key: "Control++ or key: "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

Arguments

  • key string

    Name of the key to press or a character to generate, such as ArrowLeft or a.

  • options Object (optional)

    • delay float (optional)

      Time to wait between keydown and keyup in milliseconds. Defaults to 0.

    • no_wait_after boolean (optional)

      Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

locator.press_sequentially() ​

Added in: v1.38

TIP

In most cases, you should use locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page.

Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.

To press a special key, like Control or ArrowDown, use locator.press().

Usage

python
await locator.press_sequentially("hello") # types instantly
await locator.press_sequentially("world", delay=100) # types slower, like a user
python
locator.press_sequentially("hello") # types instantly
locator.press_sequentially("world", delay=100) # types slower, like a user

An example of typing into a text field and then submitting the form:

python
locator = page.get_by_label("Password")
await locator.press_sequentially("my password")
await locator.press("Enter")
python
locator = page.get_by_label("Password")
locator.press_sequentially("my password")
locator.press("Enter")

Arguments

  • text string

    String of characters to sequentially press into a focused element.

  • options Object (optional)

    • delay float (optional)

      Time to wait between key presses in milliseconds. Defaults to 0.

    • no_wait_after boolean (optional)

      This option has no effect.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

locator.screenshot() ​

Added in: v1.14

Take a screenshot of the element matching the locator.

Usage

python
await page.get_by_role("link").screenshot()
python
page.get_by_role("link").screenshot()

Disable animations and save screenshot to a file:

python
await page.get_by_role("link").screenshot(animations="disabled", path="link.png")
python
page.get_by_role("link").screenshot(animations="disabled", path="link.png")

Details

This method captures a screenshot of the page, clipped to the size and position of a particular element matching the locator. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable container, only the currently scrolled content will be visible on the screenshot.

This method waits for the actionability checks, then scrolls element into view before taking a screenshot. If the element is detached from DOM, the method throws an error.

Returns the buffer with the captured screenshot.

Arguments

  • options Object (optional)

    • animations "disabled" | "allow" (optional)

      When set to "disabled", stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:

      • finite animations are fast-forwarded to completion, so they'll fire transitionend event.
      • infinite animations are canceled to initial state, and then played over after the screenshot.

      Defaults to "allow" that leaves animations untouched.

    • caret "hide" | "initial" (optional)

      When set to "hide", screenshot will hide text caret. When set to "initial", text caret behavior will not be changed. Defaults to "hide".

    • mask Array<Locator> (optional)

      Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box #FF00FF (customized by mask_color) that completely covers its bounding box. The mask is also applied to invisible elements, see Matching only visible elements to disable that.

    • mask_color string (optional) Added in: v1.35

      Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink #FF00FF.

    • omit_background boolean (optional)

      Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.

    • path path (optional)

      The file path to save the image to. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be saved to the disk.

    • quality int (optional)

      The quality of the image, between 0-100. Not applicable to png images. For jpeg the default is 80. For webp, a quality of 100 (the default) produces a lossless image, while lower values use lossy compression.

    • scale "css" | "device" (optional)

      When set to "css", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using "device" option will produce a single pixel per each device pixel, so screenshots of high-dpi devices will be twice as large or even larger.

      Defaults to "device".

    • style string (optional) Added in: v1.41

      Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces the Shadow DOM and applies to the inner frames.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • type "png" | "jpeg" | "webp" (optional)

      Specify screenshot type, defaults to png.

Returns

  • Buffer

locator.scroll_into_view_if_needed() ​

Added in: v1.14

This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver's ratio.

See scrolling for alternative ways to scroll.

Arguments

locator.select_option() ​

Added in: v1.14

Selects option or options in <select>.

Details

This method waits for actionability checks, waits until all specified options are present in the <select> element and selects these options.

If the target element is not a <select> element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be used instead.

Returns the array of option values that have been successfully selected.

Triggers a change and input event once all the provided options have been selected.

Usage

html
<select multiple>
  <option value="red">Red</option>
  <option value="green">Green</option>
  <option value="blue">Blue</option>
</select>
python
# single selection matching the value or label
await element.select_option("blue")
# single selection matching the label
await element.select_option(label="blue")
# multiple selection for blue, red and second option
await element.select_option(value=["red", "green", "blue"])
python
# single selection matching the value or label
element.select_option("blue")
# single selection matching the label
element.select_option(label="blue")
# multiple selection for blue, red and second option
element.select_option(value=["red", "green", "blue"])

Arguments

  • options Object (optional)

    • element ElementHandle | Array<ElementHandle> (optional)

      Option elements to select. Optional.

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • index int | Array<int> (optional)

      Options to select by index. Optional.

    • label string | Array<string> (optional)

      Options to select by label. If the <select> has the multiple attribute, all given options are selected, otherwise only the first option matching one of the passed options is selected. Optional.

    • no_wait_after boolean (optional)

      This option has no effect.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

  • value string | Array<string> (optional)

    Options to select by value. If the <select> has the multiple attribute, all given options are selected, otherwise only the first option matching one of the passed options is selected. Optional.

Returns

  • Array<string>

locator.select_text() ​

Added in: v1.14

This method waits for actionability checks, then focuses the element and selects all its text content.

If the element is inside the <label> element that has an associated control, focuses and selects text in the control instead.

Arguments

locator.set_checked() ​

Added in: v1.15

Set the state of a checkbox or a radio element.

Usage

python
await page.get_by_role("checkbox").set_checked(True)
python
page.get_by_role("checkbox").set_checked(True)

Details

This method checks or unchecks an element by performing the following steps:

  1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
  2. If the element already has the right checked state, this method returns immediately.
  3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  4. Scroll the element into view if needed.
  5. Use page.mouse to click in the center of the element.
  6. Ensure that the element is now checked or unchecked. If not, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Arguments

  • checked boolean

    Whether to check or uncheck the checkbox.

  • options Object (optional)

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • no_wait_after boolean (optional)

      This option has no effect.

    • position Object (optional)

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

      • x float
      • y float
    • scroll "auto" | "none" (optional) Added in: v1.62

      Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • trial boolean (optional)

      When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

locator.set_input_files() ​

Added in: v1.14

Upload file or multiple files into <input type=file>. For inputs with a [webkitdirectory] attribute, only a single directory path is supported.

Usage

python
# Select one file
await page.get_by_label("Upload file").set_input_files('myfile.pdf')

# Select multiple files
await page.get_by_label("Upload files").set_input_files(['file1.txt', 'file2.txt'])

# Select a directory
await page.get_by_label("Upload directory").set_input_files('mydir')

# Remove all the selected files
await page.get_by_label("Upload file").set_input_files([])

# Upload buffer from memory
await page.get_by_label("Upload file").set_input_files(
    files=[
        {"name": "test.txt", "mimeType": "text/plain", "buffer": b"this is a test"}
    ],
)
python
# Select one file
page.get_by_label("Upload file").set_input_files('myfile.pdf')

# Select multiple files
page.get_by_label("Upload files").set_input_files(['file1.txt', 'file2.txt'])

# Select a directory
page.get_by_label("Upload directory").set_input_files('mydir')

# Remove all the selected files
page.get_by_label("Upload file").set_input_files([])

# Upload buffer from memory
page.get_by_label("Upload file").set_input_files(
    files=[
        {"name": "test.txt", "mimeType": "text/plain", "buffer": b"this is a test"}
    ],
)

Details

Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

This method expects Locator to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.

Arguments

  • files path | Array<path> | Object | Array<Object>

    • name string

      File name

    • mime_type string

      File type

    • buffer Buffer

      File content

  • options Object (optional)

locator.tap() ​

Added in: v1.14

Perform a tap gesture on the element matching the locator. For examples of emulating other gestures by manually dispatching touch events, see the emulating legacy touch events page.

Details

This method taps the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.touchscreen to tap the center of the element, or the specified position.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

INFO

element.tap() requires that the hasTouch option of the browser context be set to true.

Arguments

  • options Object (optional)

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (optional)

      Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

    • no_wait_after boolean (optional)

      This option has no effect.

    • position Object (optional)

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

      • x float
      • y float
    • scroll "auto" | "none" (optional) Added in: v1.62

      Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • trial boolean (optional)

      When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it. Note that keyboard modifiers will be pressed regardless of trial to allow testing elements which are only visible when those keys are pressed.

locator.text_content() ​

Added in: v1.14

Returns the node.textContent.

:::warning[Asserting text]

If you need to assert text on the page, prefer locator_assertions.to_have_text() to avoid flakiness. See assertions guide for more details. :::

Arguments

Returns

  • null | string

locator.uncheck() ​

Added in: v1.14

Ensure that checkbox or radio element is unchecked.

Usage

python
await page.get_by_role("checkbox").uncheck()
python
page.get_by_role("checkbox").uncheck()

Details

This method unchecks the element by performing the following steps:

  1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
  2. Wait for actionability checks on the element, unless force option is set.
  3. Scroll the element into view if needed.
  4. Use page.mouse to click in the center of the element.
  5. Ensure that the element is now unchecked. If not, this method throws.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Arguments

  • options Object (optional)

    • force boolean (optional)

      Whether to bypass the actionability checks. Defaults to false.

    • no_wait_after boolean (optional)

      This option has no effect.

    • position Object (optional)

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

      • x float
      • y float
    • scroll "auto" | "none" (optional) Added in: v1.62

      Controls whether Playwright scrolls the element into view before performing the action. Defaults to "auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to "none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

    • trial boolean (optional)

      When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

locator.visible() ​

Added in: v1.63

Returns a locator that matches only visible elements, ignoring the invisible ones. This is the recommended way to distinguish elements by visibility, as opposed to the :visible CSS pseudo-class.

Note that visibility is checked every time the locator is used, and not at the moment of the locator.visible() call.

Usage

Consider a page with two buttons, the first invisible and the second visible.

html
<button style='display: none'>Invisible</button>
<button>Visible</button>

This will only find the second button, because it is visible, and then click it.

python
await page.locator("button").visible.click()
python
page.locator("button").visible.click()

To match invisible elements instead, use locator.filter() with the visible option set to false.

Returns

  • Locator

locator.wait_for() ​

Added in: v1.16

Returns when element specified by locator satisfies the state option.

If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to timeout milliseconds until the condition is met.

Usage

python
order_sent = page.locator("#order-sent")
await order_sent.wait_for()
python
order_sent = page.locator("#order-sent")
order_sent.wait_for()

Arguments

  • options Object (optional)

    • state "attached" | "detached" | "visible" | "hidden" (optional)

      Defaults to 'visible'. Can be either:

      • 'attached' - wait for element to be present in DOM.
      • 'detached' - wait for element to not be present in DOM.
      • 'visible' - wait for element to have non-empty bounding box and no visibility:hidden. Note that element without any content or with display:none has an empty bounding box and is not considered visible.
      • 'hidden' - wait for element to be either detached from DOM, or have an empty bounding box or visibility:hidden. This is opposite to the 'visible' option.
    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

locator.wait_for_function() ​

Added in: v1.62

Returns when expression returns a truthy value, called with the matching element as a first argument, and arg as a second argument.

This is a generic way to wait for an element to reach a custom condition without asserting it. The locator is re-resolved on each retry, so it tolerates the element being re-rendered while waiting.

If expression returns a [Promise], this method will wait for the promise to resolve before checking its value.

If expression throws or rejects, this method throws.

Usage

Wait for an attribute to appear:

Passing argument to expression:

Arguments

  • expression string

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • options Object (optional)

locator.within() ​

Added in: v1.64

Returns a locator that matches this locator's elements inside each element matched by locator.

Note that relative locators, such as locator.nth() or locator.first(), are resolved separately inside each matched parent. In the example below, page.getByRole('cell').nth(2) picks the third cell of every row, not the third cell in the whole table.

Usage

python
third_column = page.get_by_role("cell").nth(2).within(page.get_by_role("row"))
await expect(third_column).to_have_text(["Apple", "Banana", "Cherry"])
python
third_column = page.get_by_role("cell").nth(2).within(page.get_by_role("row"))
expect(third_column).to_have_text(["Apple", "Banana", "Cherry"])

Arguments

  • locator Locator

    Locator matching the parent elements to search within.

Returns

  • Locator

Deprecated ​

locator.type() ​

Added in: v1.14

Deprecated

In most cases, you should use locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use locator.press_sequentially().

Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.

To press a special key, like Control or ArrowDown, use locator.press().

Usage

Arguments

  • text string

    A text to type into a focused element.

  • options Object (optional)

    • delay float (optional)

      Time to wait between key presses in milliseconds. Defaults to 0.

    • no_wait_after boolean (optional)

      This option has no effect.

    • timeout float (optional)

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browser_context.set_default_timeout() or page.set_default_timeout() methods.

基于 Apache 2.0 许可证发布。