Skip to main content
Version: 1.16

Locator

Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any given moment. Locator can be created with the Page.locator(selector) method.

Locator locator = page.locator("text=Submit");locator.click();

The difference between the Locator and ElementHandle is that the latter points to a particular element, while Locator captures the logic of how to retrieve that element.

In the example below, handle points to a particular DOM element on page. If that element changes text or is used by React to render an entirely different component, handle is still pointing to that very DOM element. This can lead to unexpected behaviors.

ElementHandle handle = page.querySelector("text=Submit");handle.hover();handle.click();

With the locator, every time the element is used, up-to-date DOM element is located in the page using the selector. So in the snippet below, underlying DOM element is going to be located twice.

Locator locator = page.locator("text=Submit");locator.hover();locator.click();

Strictness

Locators are strict. This means that all operations on locators that imply some target DOM element will throw if more than one element matches given selector.

// Throws if there are several buttons in DOM:page.locator("button").click();
// Works because we explicitly tell locator to pick the first element:page.locator("button").first().click();
// Works because count knows what to do with multiple matches:page.locator("button").count();

Locator.allInnerTexts()#

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

Locator.allTextContents()#

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

Locator.boundingBox([options])#

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 bonding 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.

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

Locator.check([options])#

  • options <Locator.CheckOptions>
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setNoWaitAfter <boolean> 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.#
    • setPosition <Position> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
    • setTrial <boolean> 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.#
  • returns: <void>#

This method checks 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 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. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  6. 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.

Locator.click([options])#

  • options <Locator.ClickOptions>
    • setButton <enum MouseButton { LEFT, RIGHT, MIDDLE }> Defaults to left.#
    • setClickCount <int> defaults to 1. See UIEvent.detail.#
    • setDelay <double> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.#
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setModifiers <List<enum KeyboardModifier { ALT, CONTROL, META, SHIFT }>> 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.#
    • setNoWaitAfter <boolean> 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.#
    • setPosition <Position> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
    • setTrial <boolean> 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.#
  • returns: <void>#

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

Locator.count()#

Returns the number of elements matching given selector.

Locator.dblclick([options])#

  • options <Locator.DblclickOptions>
    • setButton <enum MouseButton { LEFT, RIGHT, MIDDLE }> Defaults to left.#
    • setDelay <double> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.#
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setModifiers <List<enum KeyboardModifier { ALT, CONTROL, META, SHIFT }>> 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.#
    • setNoWaitAfter <boolean> 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.#
    • setPosition <Position> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
    • setTrial <boolean> 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.#
  • returns: <void>#

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.
  4. Wait for initiated navigations to either succeed or fail, unless 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 timeout, this method throws a TimeoutError. Passing zero timeout disables this.

note

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

Locator.dispatchEvent(type[, eventInit, options])#

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

element.dispatchEvent("click");

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

Since 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 FirefoxJSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()");Map<String, Object> arg = new HashMap<>();arg.put("dataTransfer", dataTransfer);element.dispatchEvent("dragstart", arg);

Locator.elementHandle([options])#

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.

Locator.elementHandles()#

Resolves given locator to all matching DOM elements.

Locator.evaluate(expression[, arg, options])#

Returns the return value of expression.

This method passes this handle as the first argument to expression.

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

Examples:

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

Locator.evaluateAll(expression[, arg])#

  • expression <String> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.#
  • arg <EvaluationArgument> Optional argument to pass to expression.#
  • returns: <Object>#

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

If expression returns a Promise, then Locator.evaluateAll(expression[, arg]) would wait for the promise to resolve and return its value.

Examples:

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

Locator.evaluateHandle(expression[, arg, options])#

Returns the return value of expression as a JSHandle.

This method passes this handle as the first argument to expression.

The only difference between Locator.evaluate(expression[, arg, options]) and Locator.evaluateHandle(expression[, arg, options]) is that Locator.evaluateHandle(expression[, arg, options]) returns JSHandle.

If the function passed to the Locator.evaluateHandle(expression[, arg, options]) returns a Promise, then Locator.evaluateHandle(expression[, arg, options]) would wait for the promise to resolve and return its value.

See Page.evaluateHandle(expression[, arg]) for more details.

Locator.fill(value[, options])#

  • value <String> Value to set for the <input>, <textarea> or [contenteditable] element.#
  • options <Locator.FillOptions>
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setNoWaitAfter <boolean> 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.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
  • returns: <void>#

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.type(text[, options]).

Locator.first()#

Returns locator to the first matching element.

Locator.focus([options])#

Calls focus on the element.

Locator.getAttribute(name[, options])#

Returns element attribute value.

Locator.hover([options])#

  • options <Locator.HoverOptions>
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setModifiers <List<enum KeyboardModifier { ALT, CONTROL, META, SHIFT }>> 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.#
    • setPosition <Position> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
    • setTrial <boolean> 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.#
  • returns: <void>#

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.
  4. 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 timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Locator.innerHTML([options])#

Returns the element.innerHTML.

Locator.innerText([options])#

Returns the element.innerText.

Locator.inputValue([options])#

Returns input.value for <input> or <textarea> or <select> element. Throws for non-input elements.

Locator.isChecked([options])#

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

Locator.isDisabled([options])#

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

Locator.isEditable([options])#

Returns whether the element is editable.

Locator.isEnabled([options])#

Returns whether the element is enabled.

Locator.isHidden([options])#

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

Locator.isVisible([options])#

Returns whether the element is visible.

Locator.last()#

Returns locator to the last matching element.

Locator.locator(selector)#

The method finds an element matching the specified selector in the Locator's subtree. See Working with selectors for more details.

Locator.nth(index)#

Returns locator to the n-th matching element.

Locator.press(key[, options])#

  • key <String> Name of the key to press or a character to generate, such as ArrowLeft or a.#
  • options <Locator.PressOptions>
    • setDelay <double> Time to wait between keydown and keyup in milliseconds. Defaults to 0.#
    • setNoWaitAfter <boolean> 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.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
  • returns: <void>#

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

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.

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" 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.

Locator.screenshot([options])#

  • options <Locator.ScreenshotOptions>
    • setOmitBackground <boolean> Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.#
    • setPath <Path> 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.#
    • setQuality <int> The quality of the image, between 0-100. Not applicable to png images.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
    • setType <enum ScreenshotType { PNG, JPEG }> Specify screenshot type, defaults to png.#
  • returns: <byte[]>#

Returns the buffer with the captured 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.

Locator.scrollIntoViewIfNeeded([options])#

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

Locator.selectOption(values[, options])#

  • values <null|String|ElementHandle|List<String>|SelectOption|List<ElementHandle>|List<SelectOption>> Options to select. If the <select> has the multiple attribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are equivalent to {value:'string'}. Option is considered matching if all specified properties match.#
    • setValue <String> Matches by option.value. Optional.
    • setLabel <String> Matches by option.label. Optional.
    • setIndex <int> Matches by the index. Optional.
  • options <Locator.SelectOptionOptions>
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setNoWaitAfter <boolean> 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.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
  • returns: <List<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 valueelement.selectOption("blue");// single selection matching the labelelement.selectOption(new SelectOption().setLabel("Blue"));// multiple selectionelement.selectOption(new String[] {"red", "green", "blue"});

Locator.selectText([options])#

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

Locator.setChecked(checked[, options])#

  • checked <boolean> Whether to check or uncheck the checkbox.#
  • options <Locator.SetCheckedOptions>
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setNoWaitAfter <boolean> 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.#
    • setPosition <Position> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
    • setTrial <boolean> 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.#
  • returns: <void>#

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. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  7. 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.

Locator.setInputFiles(files[, options])#

  • files <Path|List<Path>|FilePayload|List<FilePayload>>#
  • options <Locator.SetInputFilesOptions>
    • setNoWaitAfter <boolean> 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.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
  • returns: <void>#

This method expects element to point to an input element.

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 the current working directory. For empty array, clears the selected files.

Locator.tap([options])#

  • options <Locator.TapOptions>
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setModifiers <List<enum KeyboardModifier { ALT, CONTROL, META, SHIFT }>> 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.#
    • setNoWaitAfter <boolean> 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.#
    • setPosition <Position> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
    • setTrial <boolean> 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.#
  • returns: <void>#

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.
  4. 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 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.

Locator.textContent([options])#

Returns the node.textContent.

Locator.type(text[, options])#

  • text <String> A text to type into a focused element.#
  • options <Locator.TypeOptions>
    • setDelay <double> Time to wait between key presses in milliseconds. Defaults to 0.#
    • setNoWaitAfter <boolean> 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.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
  • returns: <void>#

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(key[, options]).

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

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

Locator element = page.locator("input");element.type("some text");element.press("Enter");

Locator.uncheck([options])#

  • options <Locator.UncheckOptions>
    • setForce <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • setNoWaitAfter <boolean> 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.#
    • setPosition <Position> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
    • setTrial <boolean> 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.#
  • returns: <void>#

This method checks 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. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  6. 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.

Locator.waitFor([options])#

  • options <Locator.WaitForOptions>
    • setState <enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN }> 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.
    • setTimeout <double> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout) or Page.setDefaultTimeout(timeout) methods.#
  • returns: <void>#

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.

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