mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00

Yury Semikhatsky 639b28db3b

fix: noWaitAfter option for hover (#17856 )

Fixes https://github.com/microsoft/playwright/issues/17833

2022-10-07 12:43:48 -07:00

40 KiB

Raw Blame History

class: Locator

since: 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. Locator can be created with the [method: Page.locator] method.

Learn more about locators.

async method: Locator.allInnerTexts

since: v1.14

returns: <[Array]<[string]>>

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

async method: Locator.allTextContents

since: v1.14

returns: <[Array]<[string]>>

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

async method: Locator.boundingBox

since: v1.14

returns: <[null]|[Object]>
- x <[float]> the x coordinate of the element in pixels.
- y <[float]> the y coordinate of the element in pixels.
- width <[float]> the width of the element in pixels.
- height <[float]> the height of the element in pixels.

This method returns the bounding box of the element, 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.

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.

const box = await element.boundingBox();
await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);

BoundingBox box = element.boundingBox();
page.mouse().click(box.x + box.width / 2, box.y + box.height / 2);

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

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

var box = await element.BoundingBoxAsync();
await page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);

option: Locator.boundingBox.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.check

since: v1.14

This method checks the element by performing the following steps:

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.
Wait for actionability checks on the element, unless [option: force] option is set.
Scroll the element into view if needed.
Use [property: Page.mouse] to click in the center of the element.
Wait for initiated navigations to either succeed or fail, unless [option: noWaitAfter] option is set.
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 [option: timeout], this method throws a [TimeoutError]. Passing zero timeout disables this.

option: Locator.check.position = %%-input-position-%%

since: v1.14

option: Locator.check.force = %%-input-force-%%

since: v1.14

option: Locator.check.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.check.timeout = %%-input-timeout-%%

since: v1.14

option: Locator.check.trial = %%-input-trial-%%

since: v1.14

async method: Locator.click

since: v1.14

This method clicks the element by performing the following steps:

Wait for actionability checks on the element, unless [option: force] option is set.
Scroll the element into view if needed.
Use [property: Page.mouse] to click in the center of the element, or the specified [option: position].
Wait for initiated navigations to either succeed or fail, unless [option: noWaitAfter] 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 [option: timeout], this method throws a [TimeoutError]. Passing zero timeout disables this.

option: Locator.click.button = %%-input-button-%%

since: v1.14

option: Locator.click.clickCount = %%-input-click-count-%%

since: v1.14

option: Locator.click.delay = %%-input-down-up-delay-%%

since: v1.14

option: Locator.click.position = %%-input-position-%%

since: v1.14

option: Locator.click.modifiers = %%-input-modifiers-%%

since: v1.14

option: Locator.click.force = %%-input-force-%%

since: v1.14

option: Locator.click.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.click.timeout = %%-input-timeout-%%

since: v1.14

option: Locator.click.trial = %%-input-trial-%%

since: v1.14

async method: Locator.count

since: v1.14

returns: <[int]>

Returns the number of elements matching given selector.

async method: Locator.dblclick

since: v1.14
langs:
- alias-csharp: DblClickAsync

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

Wait for actionability checks on the element, unless [option: force] option is set.
Scroll the element into view if needed.
Use [property: Page.mouse] to double click in the center of the element, or the specified [option: position].
Wait for initiated navigations to either succeed or fail, unless [option: noWaitAfter] option is set. Note that if the first click of the dblclick() triggers a navigation event, this method will throw.

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 [option: timeout], this method throws a [TimeoutError]. Passing zero timeout disables this.

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

option: Locator.dblclick.button = %%-input-button-%%

since: v1.14

option: Locator.dblclick.delay = %%-input-down-up-delay-%%

since: v1.14

option: Locator.dblclick.position = %%-input-position-%%

since: v1.14

option: Locator.dblclick.modifiers = %%-input-modifiers-%%

since: v1.14

option: Locator.dblclick.force = %%-input-force-%%

since: v1.14

option: Locator.dblclick.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.dblclick.timeout = %%-input-timeout-%%

since: v1.14

option: Locator.dblclick.trial = %%-input-trial-%%

since: v1.14

async method: Locator.dispatchEvent

since: v1.14

The snippet below 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().

await element.dispatchEvent('click');

element.dispatchEvent("click");

await element.dispatch_event("click")

element.dispatch_event("click")

await element.DispatchEventAsync("click");

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

Since [param: eventInit] 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:

// Note you can only create DataTransfer in Chromium and Firefox
const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await element.dispatchEvent('dragstart', { dataTransfer });

// Note you can only create DataTransfer in Chromium and Firefox
JSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
element.dispatchEvent("dragstart", arg);

# note you can only create data_transfer in chromium and firefox
data_transfer = await page.evaluate_handle("new DataTransfer()")
await element.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})

# note you can only create data_transfer in chromium and firefox
data_transfer = page.evaluate_handle("new DataTransfer()")
element.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})

var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await element.DispatchEventAsync("dragstart", new Dictionary<string, object>
{
    { "dataTransfer", dataTransfer }
});

param: Locator.dispatchEvent.type

since: v1.14

type <[string]>

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

param: Locator.dispatchEvent.eventInit

since: v1.14

eventInit ?<[EvaluationArgument]>

Optional event-specific initialization properties.

option: Locator.dispatchEvent.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.dragTo

since: v1.18

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.

const source = page.locator('#source');
const target = page.locator('#target');

await source.dragTo(target);
// or specify exact positions relative to the top-left corners of the elements:
await source.dragTo(target, {
  sourcePosition: { x: 34, y: 7 },
  targetPosition: { x: 10, y: 20 },
});

Locator source = page.locator("#source");
Locator target = page.locator("#target");

source.dragTo(target);
// or specify exact positions relative to the top-left corners of the elements:
source.dragTo(target, new Locator.DragToOptions()
  .setSourcePosition(34, 7).setTargetPosition(10, 20));

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

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

var source = Page.Locator("#source");
var target = Page.Locator("#target");

await source.DragToAsync(target);
// or specify exact positions relative to the top-left corners of the elements:
await source.DragToAsync(target, new()
{
    SourcePosition = new() { X = 34, Y = 7 },
    TargetPosition = new() { X = 10, Y = 20 },
});

param: Locator.dragTo.target

since: v1.18

target <[Locator]>

Locator of the element to drag to.

option: Locator.dragTo.force = %%-input-force-%%

since: v1.18

option: Locator.dragTo.noWaitAfter = %%-input-no-wait-after-%%

since: v1.18

option: Locator.dragTo.timeout = %%-input-timeout-%%

since: v1.18

option: Locator.dragTo.trial = %%-input-trial-%%

since: v1.18

option: Locator.dragTo.sourcePosition = %%-input-source-position-%%

since: v1.18

option: Locator.dragTo.targetPosition = %%-input-target-position-%%

since: v1.18

async method: Locator.elementHandle

since: v1.14

returns: <[ElementHandle]>

Resolves given locator to the first matching DOM element. If no elements matching the query are visible, waits for them up to a given timeout. If multiple elements match the selector, throws.

option: Locator.elementHandle.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.elementHandles

since: v1.14

returns: <[Array]<[ElementHandle]>>

Resolves given locator to all matching DOM elements.

async method: Locator.evaluate

since: v1.14

returns: <[Serializable]>

Returns the return value of [param: expression].

This method passes this handle as the first argument to [param: expression].

If [param: expression] returns a [Promise], then handle.evaluate would wait for the promise to resolve and return its value.

Examples:

const tweets = page.locator('.tweet .retweets');
expect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');

Locator tweets = page.locator(".tweet .retweets");
assertEquals("10 retweets", tweets.evaluate("node => node.innerText"));

tweets = page.locator(".tweet .retweets")
assert await tweets.evaluate("node => node.innerText") == "10 retweets"

tweets = page.locator(".tweet .retweets")
assert tweets.evaluate("node => node.innerText") == "10 retweets"

var tweets = page.Locator(".tweet .retweets");
Assert.AreEqual("10 retweets", await tweets.EvaluateAsync("node => node.innerText"));

param: Locator.evaluate.expression = %%-evaluate-expression-%%

since: v1.14

param: Locator.evaluate.arg

since: v1.14

arg ?<[EvaluationArgument]>

Optional argument to pass to [param: expression].

option: Locator.evaluate.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.evaluateAll

since: v1.14

returns: <[Serializable]>

The method finds all elements matching the specified locator and passes an array of matched elements as a first argument to [param: expression]. Returns the result of [param: expression] invocation.

If [param: expression] returns a [Promise], then [method: Locator.evaluateAll] would wait for the promise to resolve and return its value.

Examples:

const elements = page.locator('div');
const divCounts = await elements.evaluateAll((divs, min) => divs.length >= min, 10);

Locator elements = page.locator("div");
boolean divCounts = (boolean) elements.evaluateAll("(divs, min) => divs.length >= min", 10);

elements = page.locator("div")
div_counts = await elements("(divs, min) => divs.length >= min", 10)

elements = page.locator("div")
div_counts = elements("(divs, min) => divs.length >= min", 10)

var elements = page.Locator("div");
var divsCount = await elements.EvaluateAll<bool>("(divs, min) => divs.length >= min", 10);

param: Locator.evaluateAll.expression = %%-evaluate-expression-%%

since: v1.14

param: Locator.evaluateAll.arg

since: v1.14

arg ?<[EvaluationArgument]>

Optional argument to pass to [param: expression].

async method: Locator.evaluateHandle

since: v1.14

returns: <[JSHandle]>

Returns the return value of [param: expression] as a [JSHandle].

This method passes this handle as the first argument to [param: expression].

The only difference between [method: Locator.evaluate] and [method: Locator.evaluateHandle] is that [method: Locator.evaluateHandle] returns [JSHandle].

If the function passed to the [method: Locator.evaluateHandle] returns a [Promise], then [method: Locator.evaluateHandle] would wait for the promise to resolve and return its value.

See [method: Page.evaluateHandle] for more details.

param: Locator.evaluateHandle.expression = %%-evaluate-expression-%%

since: v1.14

param: Locator.evaluateHandle.arg

since: v1.14

arg ?<[EvaluationArgument]>

Optional argument to pass to [param: expression].

option: Locator.evaluateHandle.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.fill

since: v1.14

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 [method: Locator.type].

param: Locator.fill.value

since: v1.14

value <[string]>

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

option: Locator.fill.force = %%-input-force-%%

since: v1.14

option: Locator.fill.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.fill.timeout = %%-input-timeout-%%

since: v1.14

method: Locator.filter

since: v1.22

returns: <[Locator]>

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

const rowLocator = page.locator('tr');
// ...
await rowLocator
    .filter({ hasText: 'text in column 1' })
    .filter({ has: page.getByRole('button', { name: 'column 2 button' }) })
    .screenshot();

Locator rowLocator = page.locator("tr");
// ...
rowLocator
    .filter(new Locator.FilterOptions().setHasText("text in column 1"))
    .filter(new Locator.FilterOptions().setHas(
        page.getByRole("button", new Page.GetByRoleOptions().setName("column 2 button"))
    ))
    .screenshot();

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()

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()

var rowLocator = page.Locator("tr");
// ...
await rowLocator
    .Filter(new LocatorFilterOptions { HasText = "text in column 1" })
    .Filter(new LocatorFilterOptions {
        Has = page.GetByRole("button", new() { Name = "column 2 button" } )
    })
    .ScreenshotAsync();

option: Locator.filter.-inline- = %%-locator-options-list-v1.14-%%

since: v1.22

method: Locator.first

since: v1.14

returns: <[Locator]>

Returns locator to the first matching element.

async method: Locator.focus

since: v1.14

Calls focus on the element.

option: Locator.focus.timeout = %%-input-timeout-%%

since: v1.14

method: Locator.frameLocator

since: v1.17

returns: <[FrameLocator]>

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

const locator = page.frameLocator('iframe').getByText('Submit');
await locator.click();

Locator locator = page.frameLocator("iframe").getByText("Submit");
locator.click();

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

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

var locator = page.FrameLocator("iframe").GetByText("Submit");
await locator.ClickAsync();

param: Locator.frameLocator.selector = %%-find-selector-%%

since: v1.17

async method: Locator.getAttribute

since: v1.14

returns: <[null]|[string]>

Returns element attribute value.

param: Locator.getAttribute.name

since: v1.14

name <[string]>

Attribute name to get the value for.

option: Locator.getAttribute.timeout = %%-input-timeout-%%

since: v1.14

method: Locator.getByAltText

since: v1.27

returns: <[Locator]>

%%-template-locator-get-by-alt-text-%%

param: Locator.getByAltText.text = %%-locator-get-by-text-text-%%

option: Locator.getByAltText.exact = %%-locator-get-by-text-exact-%%

method: Locator.getByLabel

since: v1.27

returns: <[Locator]>

%%-template-locator-get-by-label-text-%%

param: Locator.getByLabel.text = %%-locator-get-by-text-text-%%

option: Locator.getByLabel.exact = %%-locator-get-by-text-exact-%%

method: Locator.getByPlaceholder

since: v1.27

returns: <[Locator]>

%%-template-locator-get-by-placeholder-text-%%

param: Locator.getByPlaceholder.text = %%-locator-get-by-text-text-%%

option: Locator.getByPlaceholder.exact = %%-locator-get-by-text-exact-%%

method: Locator.getByRole

since: v1.27

returns: <[Locator]>

%%-template-locator-get-by-role-%%

param: Locator.getByRole.role = %%-locator-get-by-role-role-%%

option: Locator.getByRole.-inline- = %%-locator-get-by-role-option-list-v1.27-%%

since: v1.27

method: Locator.getByTestId

since: v1.27

returns: <[Locator]>

%%-template-locator-get-by-test-id-%%

param: Locator.getByTestId.testId = %%-locator-get-by-test-id-test-id-%%

since: v1.27

method: Locator.getByText

since: v1.27

returns: <[Locator]>

%%-template-locator-get-by-text-%%

param: Locator.getByText.text = %%-locator-get-by-text-text-%%

option: Locator.getByText.exact = %%-locator-get-by-text-exact-%%

method: Locator.getByTitle

since: v1.27

returns: <[Locator]>

%%-template-locator-get-by-title-%%

param: Locator.getByTitle.text = %%-locator-get-by-text-text-%%

option: Locator.getByTitle.exact = %%-locator-get-by-text-exact-%%

async method: Locator.highlight

since: v1.20

Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses [method: Locator.highlight].

async method: Locator.hover

since: v1.14

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

Wait for actionability checks on the element, unless [option: force] option is set.
Scroll the element into view if needed.
Use [property: Page.mouse] to hover over the center of the element, or the specified [option: position].
Wait for initiated navigations to either succeed or fail, unless noWaitAfter 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 [option: timeout], this method throws a [TimeoutError]. Passing zero timeout disables this.

option: Locator.hover.position = %%-input-position-%%

since: v1.14

option: Locator.hover.modifiers = %%-input-modifiers-%%

since: v1.14

option: Locator.hover.force = %%-input-force-%%

since: v1.14

option: Locator.hover.timeout = %%-input-timeout-%%

since: v1.14

option: Locator.hover.trial = %%-input-trial-%%

since: v1.14

option: Locator.hover.noWaitAfter = %%-input-no-wait-after-%%

since: v1.28

async method: Locator.innerHTML

since: v1.14

returns: <[string]>

Returns the element.innerHTML.

option: Locator.innerHTML.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.innerText

since: v1.14

returns: <[string]>

Returns the element.innerText.

option: Locator.innerText.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.inputValue

since: v1.14

returns: <[string]>

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

Throws for non-input elements. However, if the element is inside the <label> element that has an associated control, returns the value of the control.

option: Locator.inputValue.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.isChecked

since: v1.14

returns: <[boolean]>

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

option: Locator.isChecked.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.isDisabled

since: v1.14

returns: <[boolean]>

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

option: Locator.isDisabled.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.isEditable

since: v1.14

returns: <[boolean]>

Returns whether the element is editable.

option: Locator.isEditable.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.isEnabled

since: v1.14

returns: <[boolean]>

Returns whether the element is enabled.

option: Locator.isEnabled.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.isHidden

since: v1.14

returns: <[boolean]>

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

option: Locator.isHidden.timeout

since: v1.14

timeout <[float]>

DEPRECATED This option is ignored. [method: Locator.isHidden] does not wait for the element to become hidden and returns immediately.

async method: Locator.isVisible

since: v1.14

returns: <[boolean]>

Returns whether the element is visible.

option: Locator.isVisible.timeout

since: v1.14

timeout <[float]>

DEPRECATED This option is ignored. [method: Locator.isVisible] does not wait for the element to become visible and returns immediately.

method: Locator.last

since: v1.14

returns: <[Locator]>

Returns locator to the last matching element.

method: Locator.locator

since: v1.14

returns: <[Locator]>

%%-template-locator-locator-%%

param: Locator.locator.selector = %%-find-selector-%%

since: v1.14

option: Locator.locator.-inline- = %%-locator-options-list-v1.14-%%

since: v1.14

method: Locator.nth

since: v1.14

returns: <[Locator]>

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

param: Locator.nth.index

since: v1.14

index <[int]>

method: Locator.page

since: v1.19

returns: <[Page]>

A page this locator belongs to.

async method: Locator.press

since: v1.14

Focuses the element, and then uses [method: Keyboard.down] and [method: Keyboard.up].

[param: key] can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the [param: 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.

Holding down Shift will type the text that corresponds to the [param: key] in the upper case.

If [param: 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" 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.

param: Locator.press.key

since: v1.14

key <[string]>

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

option: Locator.press.delay

since: v1.14

delay <[float]>

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

option: Locator.press.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.press.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.screenshot

since: v1.14

returns: <[Buffer]>

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.

option: Locator.screenshot.-inline- = %%-screenshot-options-common-list-v1.8-%%

since: v1.14

async method: Locator.scrollIntoViewIfNeeded

since: 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.

option: Locator.scrollIntoViewIfNeeded.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.selectOption

since: v1.14

returns: <[Array]<[string]>>

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.

// single selection matching the value
element.selectOption('blue');

// single selection matching the label
element.selectOption({ label: 'Blue' });

// multiple selection
element.selectOption(['red', 'green', 'blue']);

// single selection matching the value
element.selectOption("blue");
// single selection matching the label
element.selectOption(new SelectOption().setLabel("Blue"));
// multiple selection
element.selectOption(new String[] {"red", "green", "blue"});

# single selection matching the value
await element.select_option("blue")
# single selection matching the label
await element.select_option(label="blue")
# multiple selection
await element.select_option(value=["red", "green", "blue"])

# single selection matching the value
element.select_option("blue")
# single selection matching both the label
element.select_option(label="blue")
# multiple selection
element.select_option(value=["red", "green", "blue"])

// single selection matching the value
await element.SelectOptionAsync(new[] { "blue" });
// single selection matching the label
await element.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection
await element.SelectOptionAsync(new[] { "red", "green", "blue" });
// multiple selection for blue, red and second option
await element.SelectOptionAsync(new[] {
    new SelectOptionValue() { Label = "blue" },
    new SelectOptionValue() { Index = 2 },
    new SelectOptionValue() { Value = "red" }});

param: Locator.selectOption.values = %%-select-options-values-%%

since: v1.14

option: Locator.selectOption.force = %%-input-force-%%

since: v1.14

option: Locator.selectOption.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.selectOption.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.selectText

since: 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.

option: Locator.selectText.force = %%-input-force-%%

since: v1.14

option: Locator.selectText.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.setChecked

since: v1.15

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

Ensure that matched element is a checkbox or a radio input. If not, this method throws.
If the element already has the right checked state, this method returns immediately.
Wait for actionability checks on the matched element, unless [option: force] option is set. If the element is detached during the checks, the whole action is retried.
Scroll the element into view if needed.
Use [property: Page.mouse] to click in the center of the element.
Wait for initiated navigations to either succeed or fail, unless [option: noWaitAfter] option is set.
Ensure that the element is now checked or unchecked. If not, this method throws.

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

param: Locator.setChecked.checked = %%-input-checked-%%

since: v1.15

option: Locator.setChecked.force = %%-input-force-%%

since: v1.15

option: Locator.setChecked.noWaitAfter = %%-input-no-wait-after-%%

since: v1.15

option: Locator.setChecked.position = %%-input-position-%%

since: v1.15

option: Locator.setChecked.timeout = %%-input-timeout-%%

since: v1.15

option: Locator.setChecked.trial = %%-input-trial-%%

since: v1.15

async method: Locator.setInputFiles

since: v1.14

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.

param: Locator.setInputFiles.files = %%-input-files-%%

since: v1.14

option: Locator.setInputFiles.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.setInputFiles.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.tap

since: v1.14

This method taps the element by performing the following steps:

Wait for actionability checks on the element, unless [option: force] option is set.
Scroll the element into view if needed.
Use [property: Page.touchscreen] to tap the center of the element, or the specified [option: position].
Wait for initiated navigations to either succeed or fail, unless [option: noWaitAfter] 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 [option: timeout], this method throws a [TimeoutError]. Passing zero timeout disables this.

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

option: Locator.tap.position = %%-input-position-%%

since: v1.14

option: Locator.tap.modifiers = %%-input-modifiers-%%

since: v1.14

option: Locator.tap.force = %%-input-force-%%

since: v1.14

option: Locator.tap.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.tap.timeout = %%-input-timeout-%%

since: v1.14

option: Locator.tap.trial = %%-input-trial-%%

since: v1.14

async method: Locator.textContent

since: v1.14

returns: <[null]|[string]>

Returns the node.textContent.

option: Locator.textContent.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.type

since: v1.14

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 [method: Locator.press].

await element.type('Hello'); // Types instantly
await element.type('World', {delay: 100}); // Types slower, like a user

element.type("Hello"); // Types instantly
element.type("World", new Locator.TypeOptions().setDelay(100)); // Types slower, like a user

await element.type("hello") # types instantly
await element.type("world", delay=100) # types slower, like a user

element.type("hello") # types instantly
element.type("world", delay=100) # types slower, like a user

await element.TypeAsync("Hello"); // Types instantly
await element.TypeAsync("World", new() { Delay = 100 }); // Types slower, like a user

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

const element = page.getByLabel('Password');
await element.type('my password');
await element.press('Enter');

Locator element = page.getByLabel("Password");
element.type("my password");
element.press("Enter");

element = page.get_by_label("Password")
await element.type("my password")
await element.press("Enter")

element = page.get_by_label("Password")
element.type("my password")
element.press("Enter")

var element = page.GetByLabel("Password");
await element.TypeAsync("my password");
await element.PressAsync("Enter");

param: Locator.type.text

since: v1.14

text <[string]>

A text to type into a focused element.

option: Locator.type.delay

since: v1.14

delay <[float]>

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

option: Locator.type.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.type.timeout = %%-input-timeout-%%

since: v1.14

async method: Locator.uncheck

since: v1.14

This method checks the element by performing the following steps:

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.
Wait for actionability checks on the element, unless [option: force] option is set.
Scroll the element into view if needed.
Use [property: Page.mouse] to click in the center of the element.
Wait for initiated navigations to either succeed or fail, unless [option: noWaitAfter] option is set.
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 [option: timeout], this method throws a [TimeoutError]. Passing zero timeout disables this.

option: Locator.uncheck.position = %%-input-position-%%

since: v1.14

option: Locator.uncheck.force = %%-input-force-%%

since: v1.14

option: Locator.uncheck.noWaitAfter = %%-input-no-wait-after-%%

since: v1.14

option: Locator.uncheck.timeout = %%-input-timeout-%%

since: v1.14

option: Locator.uncheck.trial = %%-input-trial-%%

since: v1.14

async method: Locator.waitFor

since: v1.16

Returns when element specified by locator satisfies the [option: state] option.

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

const orderSent = page.locator('#order-sent');
await orderSent.waitFor();

Locator orderSent = page.locator("#order-sent");
orderSent.waitFor();

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

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

var orderSent = page.Locator("#order-sent");
orderSent.WaitForAsync();

option: Locator.waitFor.state = %%-wait-for-selector-state-%%

since: v1.16

option: Locator.waitFor.timeout = %%-input-timeout-%%

since: v1.16

40 KiB Raw Blame History

class: Locator

async method: Locator.allInnerTexts

async method: Locator.allTextContents

async method: Locator.boundingBox

option: Locator.boundingBox.timeout = %%-input-timeout-%%

async method: Locator.check

option: Locator.check.position = %%-input-position-%%

option: Locator.check.force = %%-input-force-%%

option: Locator.check.noWaitAfter = %%-input-no-wait-after-%%

option: Locator.check.timeout = %%-input-timeout-%%

option: Locator.check.trial = %%-input-trial-%%

async method: Locator.click

option: Locator.click.button = %%-input-button-%%

option: Locator.click.clickCount = %%-input-click-count-%%

option: Locator.click.delay = %%-input-down-up-delay-%%

option: Locator.click.position = %%-input-position-%%

option: Locator.click.modifiers = %%-input-modifiers-%%

option: Locator.click.force = %%-input-force-%%

option: Locator.click.noWaitAfter = %%-input-no-wait-after-%%

option: Locator.click.timeout = %%-input-timeout-%%

option: Locator.click.trial = %%-input-trial-%%

async method: Locator.count

async method: Locator.dblclick

option: Locator.dblclick.button = %%-input-button-%%

option: Locator.dblclick.delay = %%-input-down-up-delay-%%

option: Locator.dblclick.position = %%-input-position-%%

option: Locator.dblclick.modifiers = %%-input-modifiers-%%

option: Locator.dblclick.force = %%-input-force-%%

option: Locator.dblclick.noWaitAfter = %%-input-no-wait-after-%%

option: Locator.dblclick.timeout = %%-input-timeout-%%

option: Locator.dblclick.trial = %%-input-trial-%%

async method: Locator.dispatchEvent

param: Locator.dispatchEvent.type

param: Locator.dispatchEvent.eventInit

option: Locator.dispatchEvent.timeout = %%-input-timeout-%%

async method: Locator.dragTo

param: Locator.dragTo.target

option: Locator.dragTo.force = %%-input-force-%%

option: Locator.dragTo.noWaitAfter = %%-input-no-wait-after-%%

option: Locator.dragTo.timeout = %%-input-timeout-%%

option: Locator.dragTo.trial = %%-input-trial-%%

option: Locator.dragTo.sourcePosition = %%-input-source-position-%%

option: Locator.dragTo.targetPosition = %%-input-target-position-%%

async method: Locator.elementHandle

option: Locator.elementHandle.timeout = %%-input-timeout-%%

async method: Locator.elementHandles

async method: Locator.evaluate

param: Locator.evaluate.expression = %%-evaluate-expression-%%

param: Locator.evaluate.arg

option: Locator.evaluate.timeout = %%-input-timeout-%%

async method: Locator.evaluateAll

param: Locator.evaluateAll.expression = %%-evaluate-expression-%%

param: Locator.evaluateAll.arg

async method: Locator.evaluateHandle

param: Locator.evaluateHandle.expression = %%-evaluate-expression-%%

param: Locator.evaluateHandle.arg

option: Locator.evaluateHandle.timeout = %%-input-timeout-%%

async method: Locator.fill

param: Locator.fill.value

option: Locator.fill.force = %%-input-force-%%

option: Locator.fill.noWaitAfter = %%-input-no-wait-after-%%

option: Locator.fill.timeout = %%-input-timeout-%%

method: Locator.filter

option: Locator.filter.-inline- = %%-locator-options-list-v1.14-%%

method: Locator.first

async method: Locator.focus

option: Locator.focus.timeout = %%-input-timeout-%%

method: Locator.frameLocator

param: Locator.frameLocator.selector = %%-find-selector-%%

async method: Locator.getAttribute

param: Locator.getAttribute.name

option: Locator.getAttribute.timeout = %%-input-timeout-%%

method: Locator.getByAltText

param: Locator.getByAltText.text = %%-locator-get-by-text-text-%%

option: Locator.getByAltText.exact = %%-locator-get-by-text-exact-%%

method: Locator.getByLabel

param: Locator.getByLabel.text = %%-locator-get-by-text-text-%%

option: Locator.getByLabel.exact = %%-locator-get-by-text-exact-%%

method: Locator.getByPlaceholder

40 KiB

Raw Blame History