Locator
Namespace: Glutinum.Playwright Parent: Glutinum.Playwright.global
type Locator
abstract member all : Promise<ResizeArray<Locator>>
abstract member allInnerTexts : Promise<ResizeArray<string>>
abstract member allTextContents : Promise<ResizeArray<string>>
abstract member and : locator : Locator -> Locator
abstract member and_ : locator : Locator -> Locator
abstract member ariaSnapshot : options : options option -> Promise<string>
abstract member blur : options : options option -> Promise<unit>
abstract member boundingBox : options : options option -> Promise<boundingBox option>
abstract member check : options : options option -> Promise<unit>
abstract member clear : options : options option -> Promise<unit>
abstract member click : options : options option -> Promise<unit>
abstract member contentFrame : FrameLocator
abstract member count : Promise<float>
abstract member dblclick : options : options option -> Promise<unit>
abstract member describe : description : string -> Locator
abstract member description : string option
abstract member dispatchEvent : type : string -> eventInit : EvaluationArgument option -> options : options option -> Promise<unit>
abstract member dragTo : target : Locator -> options : options option -> Promise<unit>
abstract member elementHandles : Promise<ResizeArray<ElementHandle>>
abstract member fill : value : string -> options : options option -> Promise<unit>
abstract member filter : options : options option -> Locator
abstract member first : Locator
abstract member focus : options : options option -> Promise<unit>
abstract member frameLocator : selector : string -> FrameLocator
abstract member getAttribute : name : string -> options : options option -> Promise<string option>
abstract member getByAltText : text : U2<string, RegExp> -> options : options option -> Locator
abstract member getByLabel : text : U2<string, RegExp> -> options : options option -> Locator
abstract member getByPlaceholder : text : U2<string, RegExp> -> options : options option -> Locator
abstract member getByRole : role : role -> options : options option -> Locator
abstract member getByTestId : testId : U2<string, RegExp> -> Locator
abstract member getByText : text : U2<string, RegExp> -> options : options option -> Locator
abstract member getByTitle : text : U2<string, RegExp> -> options : options option -> Locator
abstract member highlight : Promise<unit>
abstract member hover : options : options option -> Promise<unit>
abstract member innerHTML : options : options option -> Promise<string>
abstract member innerText : options : options option -> Promise<string>
abstract member inputValue : options : options option -> Promise<string>
abstract member isChecked : options : options option -> Promise<bool>
abstract member isDisabled : options : options option -> Promise<bool>
abstract member isEditable : options : options option -> Promise<bool>
abstract member isEnabled : options : options option -> Promise<bool>
abstract member isHidden : options : options option -> Promise<bool>
abstract member isVisible : options : options option -> Promise<bool>
abstract member last : Locator
abstract member locator : selectorOrLocator : Locator -> options : options option -> Locator
abstract member locator : selectorOrLocator : string -> options : options option -> Locator
abstract member normalize : Promise<Locator>
abstract member nth : index : float -> Locator
abstract member or : locator : Locator -> Locator
abstract member page : Page
abstract member press : key : string -> options : options option -> Promise<unit>
abstract member pressSequentially : text : string -> options : options option -> Promise<unit>
abstract member screenshot : options : LocatorScreenshotOptions option -> Promise<Buffer>
abstract member scrollIntoViewIfNeeded : options : options option -> Promise<unit>
abstract member selectOption : values : string -> options : options option -> Promise<ResizeArray<string>>
abstract member selectOption : values : U6<string, obj, ReadonlyArray<string>, Case4, ReadonlyArray<ElementHandle>, ReadonlyArray<Case6>> option -> options : options option -> Promise<ResizeArray<string>>
abstract member selectOption : values : obj -> options : options option -> Promise<ResizeArray<string>>
abstract member selectText : options : options option -> Promise<unit>
abstract member setChecked : checked : bool -> options : options option -> Promise<unit>
abstract member setInputFiles : files : U4<string, ReadonlyArray<string>, Case3, ReadonlyArray<Case4>> -> options : options option -> Promise<unit>
abstract member tap : options : options option -> Promise<unit>
abstract member textContent : options : options option -> Promise<string option>
abstract member toString : string
abstract member type : text : string -> options : options option -> Promise<unit>
abstract member uncheck : options : options option -> Promise<unit>
abstract member waitFor : options : options option -> Promise<unit>
Methods
When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.
NOTE 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
for (const li of await page.getByRole('listitem').all()) await li.click();Returns an array of node.innerText values for all matching nodes.
NOTE If you need to assert text on the page, prefer
expect(locator).toHaveText(expected[, options])
with
useInnerText
option to avoid flakiness. See assertions guide for more details.
Usage
const texts = await page.getByRole('link').allInnerTexts();Returns an array of node.textContent values for all matching nodes.
NOTE If you need to assert text on the page, prefer expect(locator).toHaveText(expected[, options]) to avoid flakiness. See assertions guide for more details.
Usage
const texts = await page.getByRole('link').allTextContents();Creates a locator that matches both this locator and the argument locator.
Usage
The following example finds a button with a specific title.
const button = page.getByRole('button').and(page.getByTitle('Subscribe'));locator : Locator
Additional locator to match.
Creates a locator that matches both this locator and the argument locator.
Usage
The following example finds a button with a specific title.
const button = page.getByRole('button').and(page.getByTitle('Subscribe'));locator : Locator
Additional locator to match.
Captures the aria snapshot of the given element. Read more about aria snapshots and expect(locator).toMatchAriaSnapshot(expected[, options]) for the corresponding assertion.
Usage
await page.getByRole('link').ariaSnapshot();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
textkey.
Below is the HTML markup and the respective ARIA snapshot:
<ul aria-label="Links"> <li><a href="/">Home</a></li> <li><a href="/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:
- 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.
options : options option
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
const box = await page.getByRole('button').boundingBox();await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);options : options option
Ensure that checkbox or radio element is checked.
Details
Performs 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
forceoption is set. - Scroll the element into view if needed.
- Use page.mouse to click in the center of the element.
- 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
await page.getByRole('checkbox').check();options : options option
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
await page.getByRole('textbox').clear();options : options option
Click an element.
Details
This method clicks the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use page.mouse to click in the center of the
element, or the specified
position. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption 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:
await page.getByRole('button').click();Shift-right-click at a specific position on a canvas:
await page.locator('canvas').click({ button: 'right', modifiers: ['Shift'], position: { x: 23, y: 32 },});options : options option
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 frameLocator.owner().
Usage
const locator = page.locator('iframe[name="embedded"]');// ...const frameLocator = locator.contentFrame();await frameLocator.getByRole('button').click();Returns the number of elements matching the locator.
NOTE If you need to assert the number of elements on the page, prefer expect(locator).toHaveCount(count[, options]) to avoid flakiness. See assertions guide for more details.
Usage
const count = await page.getByRole('listitem').count();Double-click an element.
Details
This method double clicks the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- 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.
NOTE element.dblclick() dispatches two click events and a single dblclick event.
options : options option
Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the same element.
Usage
const button = page.getByTestId('btn-sub').describe('Subscribe button');await button.click();description : string
Locator description.
Returns locator description previously set with
locator.describe(description). Returns null if
no custom description has been set. Prefer
locator.toString() for a human-readable
representation, as it uses the description when available.
Usage
const button = page.getByRole('button').describe('Subscribe button');console.log(button.description()); // "Subscribe button"
const input = page.getByRole('textbox');console.log(input.description()); // nulldispatchEvent
type : string -> eventInit : EvaluationArgument option -> options : options option -> Promise<unit>Programmatically dispatch an event on the matching element.
Usage
await locator.dispatchEvent('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
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:
- DeviceMotionEvent
- DeviceOrientationEvent
- DragEvent
- Event
- FocusEvent
- KeyboardEvent
- MouseEvent
- PointerEvent
- TouchEvent
- WheelEvent
You can also specify JSHandle as the property value if you want live objects to be passed into the event:
const dataTransfer = await page.evaluateHandle(() => new DataTransfer());await locator.dispatchEvent('dragstart', { dataTransfer });Parameters
type : string
eventInit : EvaluationArgument option
Optional event-specific initialization properties.
options : options option
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
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 },});target : Locator
Locator of the element to drag to.
options : options option
NOTE 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.
Set a value to the input field.
Usage
await page.getByRole('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.pressSequentially(text[, options]).
Parametersvalue : string
Value to set for the <input>, <textarea> or [contenteditable] element.
options : options option
This method narrows existing locator according to the options, for example filters by text. It can be chained to filter multiple times.
Usage
const rowLocator = page.locator('tr');// ...await rowLocator .filter({ hasText: 'text in column 1' }) .filter({ has: page.getByRole('button', { name: 'column 2 button' }) }) .screenshot();options : options option
Returns locator to the first matching element.
When working with iframes, you can create a frame locator that will enter the iframe and allow locating elements in that iframe:
Usage
const locator = page.frameLocator('iframe').getByText('Submit');await locator.click();selector : string
A selector to use when resolving DOM element.
Returns the matching element’s attribute value.
NOTE If you need to assert an element’s attribute, prefer expect(locator).toHaveAttribute(name, value[, options]) to avoid flakiness. See assertions guide for more details.
Parametersname : string
Attribute name to get the value for.
options : options option
Allows locating elements by their alt text.
Usage
For example, this method will find the image by alt text “Playwright logo”:
<img alt='Playwright logo'>``````jsawait page.getByAltText('Playwright logo').click();text : U2<string, RegExp>
Text to locate the element for.
options : options option
Allows locating input elements by the text of the associated <label> or aria-labelledby element, or by the
aria-label attribute.
Usage
For example, this method will find inputs by label “Username” and “Password” in the following DOM:
<input aria-label="Username"><label for="password-input">Password:</label><input id="password-input">``````jsawait page.getByLabel('Username').fill('john');await page.getByLabel('Password').fill('secret');text : U2<string, RegExp>
Text to locate the element for.
options : options option
Allows locating input elements by the placeholder text.
Usage
For example, consider the following DOM structure.
<input type="email" placeholder="name@example.com" />You can fill the input after locating it by the placeholder text:
await page .getByPlaceholder('name@example.com') .fill('playwright@microsoft.com');text : U2<string, RegExp>
Text to locate the element for.
options : options option
Allows locating elements by their ARIA role, ARIA attributes and accessible name.
Usage
Consider the following DOM structure.
<h3>Sign up</h3><label> <input type="checkbox" /> Subscribe</label><br/><button>Submit</button>You can locate each element by its implicit role:
await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();
await page.getByRole('checkbox', { name: 'Subscribe' }).check();
await page.getByRole('button', { name: /submit/i }).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.
role : role
Required aria role.
options : options option
Locate element by the test id.
Usage
Consider the following DOM structure.
<button data-testid="directions">Itinéraire</button>You can locate the element by its test id:
await page.getByTestId('directions').click();Details
By default, the data-testid attribute is used as a test id. Use
selectors.setTestIdAttribute(attributeName)
to configure a different test id attribute if necessary.
// Set custom test id attribute from
<strong>Parameters</strong><div class="fs-parameter__signature"><span class="fsharp-doc-typevar">testId</span> <span class="fsharp-doc-kw">:</span> <span class="fsharp-doc-type"><a href="/api/fable-core-u2">U2</a></span><span class="fsharp-doc-kw"><</span>string<span class="fsharp-doc-kw">,</span> RegExp<span class="fsharp-doc-kw">></span></div>
<div class='fs-parameter__documentation'>
Id to locate the element by.
</div></DocEntry>
<DocEntry name="getByText"><div class="fsharp-doc-sig" slot="signature"><span class="fsharp-doc-kw">abstract</span> <span class="fsharp-doc-kw">member</span> getByText <span class="fsharp-doc-kw">:</span> <span class="fsharp-doc-typevar">text</span> <span class="fsharp-doc-kw">:</span> <span class="fsharp-doc-type"><a href="/api/fable-core-u2">U2</a></span><span class="fsharp-doc-kw"><</span>string<span class="fsharp-doc-kw">,</span> RegExp<span class="fsharp-doc-kw">></span> <span class="fsharp-doc-kw">-></span> <span class="fsharp-doc-typevar">options</span> <span class="fsharp-doc-kw">:</span> <span class="fsharp-doc-type"><a href="/api/glutinum-playwright-locatormodule-getbytext-options">options</a></span> option <span class="fsharp-doc-kw">-></span> <span class="fsharp-doc-type"><a href="/api/glutinum-playwright-locator">Locator</a></span></div>
Allows locating elements that contain given text.
See also [locator.filter([options])](https://playwright.dev/docs/api/class-locator#locator-filter) that allows tomatch 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:
// Matches <span>page.getByText('world');
// Matches first <div>page.getByText('Hello world');
// Matches second <div>page.getByText('Hello', { exact: true });
// Matches both <div>spage.getByText(/Hello/);
// Matches second <div>page.getByText(/^hello$/i);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">.
text : U2<string, RegExp>
Text to locate the element for.
options : options option
Allows locating elements by their title attribute.
Usage
Consider the following DOM structure.
<span title='Issues count'>25 issues</span>You can check the issues count after locating it by the title text:
await expect(page.getByTitle('Issues count')).toHaveText('25 issues');text : U2<string, RegExp>
Text to locate the element for.
options : options option
Highlight the corresponding element(s) on the screen. Useful for debugging, don’t commit the code that uses locator.highlight().
Hover over the matching element.
Usage
await page.getByRole('link').hover();Details
This method hovers over the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- 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.
options : options option
Returns the element.innerHTML.
options : options option
Returns the element.innerText.
NOTE If you need to assert text on the page, prefer
expect(locator).toHaveText(expected[, options])
with
useInnerText
option to avoid flakiness. See assertions guide for more details.
options : options option
Returns the value for the matching <input> or <textarea> or <select> element.
NOTE If you need to assert input value, prefer expect(locator).toHaveValue(value[, options]) to avoid flakiness. See assertions guide for more details.
Usage
const value = await page.getByRole('textbox').inputValue();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.
options : options option
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
NOTE If you need to assert that checkbox is checked, prefer expect(locator).toBeChecked([options]) to avoid flakiness. See assertions guide for more details.
Usage
const checked = await page.getByRole('checkbox').isChecked();options : options option
Returns whether the element is disabled, the opposite of enabled.
NOTE If you need to assert that an element is disabled, prefer expect(locator).toBeDisabled([options]) to avoid flakiness. See assertions guide for more details.
Usage
const disabled = await page.getByRole('button').isDisabled();options : options option
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.
NOTE If you need to assert that an element is editable, prefer expect(locator).toBeEditable([options]) to avoid flakiness. See assertions guide for more details.
Usage
const editable = await page.getByRole('textbox').isEditable();options : options option
Returns whether the element is enabled.
NOTE If you need to assert that an element is enabled, prefer expect(locator).toBeEnabled([options]) to avoid flakiness. See assertions guide for more details.
Usage
const enabled = await page.getByRole('button').isEnabled();options : options option
Returns whether the element is hidden, the opposite of visible.
NOTE If you need to assert that element is hidden, prefer expect(locator).toBeHidden([options]) to avoid flakiness. See assertions guide for more details.
Usage
const hidden = await page.getByRole('button').isHidden();options : options option
Returns whether the element is visible.
NOTE If you need to assert that element is visible, prefer expect(locator).toBeVisible([options]) to avoid flakiness. See assertions guide for more details.
Usage
const visible = await page.getByRole('button').isVisible();options : options option
Returns locator to the last matching element.
Usage
const banana = await page.getByRole('listitem').last();The method finds an element matching the specified selector in the locator’s subtree. It also accepts filter options, similar to locator.filter([options]) method.
ParametersselectorOrLocator : string
A selector or locator to use when resolving DOM element.
options : options option
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.
Returns locator to the n-th matching element. It’s zero based, nth(0) selects the first element.
Usage
const banana = await page.getByRole('listitem').nth(2);index : float
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.
NOTE 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.
const newEmail = page.getByRole('button', { name: 'New' });const dialog = page.getByText('Confirm security settings');await expect(newEmail.or(dialog).first()).toBeVisible();if (await dialog.isVisible()) await page.getByRole('button', { name: 'Dismiss' }).click();await newEmail.click();locator : Locator
Alternative locator to match.
A page this locator belongs to.
Focuses the matching element and presses a combination of the keys.
Usage
await page.getByRole('textbox').press('Backspace');Details
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,
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.
key : string
Name of the key to press or a character to generate, such as ArrowLeft or a.
options : options option
NOTE In most cases, you should use locator.fill(value[, options]) 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(key[, options]).
Usage
await locator.pressSequentially('Hello'); // Types instantlyawait locator.pressSequentially('World', { delay: 100 }); // Types slower, like a userAn example of typing into a text field and then submitting the form:
const locator = page.getByLabel('Password');await locator.pressSequentially('my password');await locator.press('Enter');text : string
String of characters to sequentially press into a focused element.
options : options option
Take a screenshot of the element matching the locator.
Usage
await page.getByRole('link').screenshot();Disable animations and save screenshot to a file:
await page.getByRole('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.
Parametersoptions : LocatorScreenshotOptions option
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.
Parametersoptions : options option
selectOption
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
<select multiple> <option value="red">Red</option> <option value="green">Green</option> <option value="blue">Blue</option></select>``````js// single selection matching the value or labelelement.selectOption('blue');
// single selection matching the labelelement.selectOption({ label: 'Blue' });
// multiple selection for red, green and blue optionselement.selectOption(['red', 'green', 'blue']);values : obj
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 matching both values and
labels. Option is considered matching if all specified properties match.
options : options option
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.
options : options option
Set the state of a checkbox or a radio element.
Usage
await page.getByRole('checkbox').setChecked(true);Details
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
forceoption is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use page.mouse to click in the center of the element.
- 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.
checked : bool
Whether to check or uncheck the checkbox.
options : options option
setInputFiles
Upload file or multiple files into <input type=file>. For inputs with a [webkitdirectory] attribute, only a
single directory path is supported.
Usage
// Select one fileawait page.getByLabel('Upload file').setInputFiles(path.join(__dirname, 'myfile.pdf'));
// Select multiple filesawait page.getByLabel('Upload files').setInputFiles([ path.join(__dirname, 'file1.txt'), path.join(__dirname, 'file2.txt'),]);
// Select a directoryawait page.getByLabel('Upload directory').setInputFiles(path.join(__dirname, 'mydir'));
// Remove all the selected filesawait page.getByLabel('Upload file').setInputFiles([]);
// Upload buffer from memoryawait page.getByLabel('Upload file').setInputFiles({ name: 'file.txt', mimeType: 'text/plain', buffer: Buffer.from('this is 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.
files : U4<string, ReadonlyArray<string>, Case3, ReadonlyArray<Case4>>
options : options option
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:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- 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.
NOTE element.tap() requires that the hasTouch option of the browser context be set to true.
options : options option
Returns the node.textContent.
NOTE If you need to assert text on the page, prefer expect(locator).toHaveText(expected[, options]) to avoid flakiness. See assertions guide for more details.
Parametersoptions : options option
Returns a human-readable representation of the locator, using the locator.description() if one exists; otherwise, it generates a string based on the locator’s selector.
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]).
Usage
Parameterstext : string
A text to type into a focused element.
options : options option
Ensure that checkbox or radio element is unchecked.
Usage
await page.getByRole('checkbox').uncheck();Details
This method unchecks 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
forceoption is set. - Scroll the element into view if needed.
- Use page.mouse to click in the center of the element.
- 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.
options : options option
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
const orderSent = page.locator('#order-sent');await orderSent.waitFor();options : options option