English · Node.js
Appearance
English · Node.js
Appearance
FrameLocator represents a view to the iframe on the page. It captures the logic sufficient to retrieve the iframe and locate elements in that iframe. FrameLocator can be created with either locator.contentFrame(), page.frameLocator() or locator.frameLocator() method.
const locator = page.locator('#my-frame').contentFrame().getByText('Submit');
await locator.click();Strictness
Frame locators are strict. This means that all operations on frame locators will throw if more than one element matches a given selector.
// Throws if there are several frames in DOM:
await page.locator('.result-frame').contentFrame().getByRole('button').click();
// Works because we explicitly tell locator to pick the first frame:
await page.locator('.result-frame').contentFrame().first().getByRole('button').click();Any frame
Calling page.frameLocator() or frame.frameLocator() without a selector creates a frame locator that starts the search in any frame of the subtree - so that you don't need to locate the iframe first.
// Finds the button in any frame on the page:
await page.frameLocator().getByRole('button').click();
// Finds the iframe with id "my-frame" anywhere on the page, and clicks the button inside it:
await page.frameLocator().locator('#my-frame').contentFrame().getByRole('button').click();Only the start of the search is affected - the rest of the locator is resolved inside a single frame, just like any other locator. Following the strictness rules above, an error is thrown when elements are matched in multiple frames.
Such a frame locator does not point to a particular iframe, so frameLocator.owner(), frameLocator.first(), frameLocator.last() and frameLocator.nth() are not supported on it.
Converting Locator to FrameLocator
If you have a Locator object pointing to an iframe it can be converted to FrameLocator using locator.contentFrame().
Converting FrameLocator to Locator
If you have a FrameLocator object it can be converted to Locator pointing to the same iframe using frameLocator.owner().
When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in that iframe.
Arguments
Returns
FrameLocatorAllows locating elements by their alt text.
Usage
For example, this method will find the image by alt text "Playwright logo":
<img alt='Playwright logo'>await page.getByAltText('Playwright logo').click();Arguments
Text to locate the element for.
Returns
LocatorAllows locating input elements by the text of the associated <label> or aria-labelledby element, or by the aria-label attribute.
Associated <label> elements are also supported for form-associated custom elements.
Usage
For example, this method will find inputs by label "Username" and "Password" in the following DOM:
<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">await page.getByLabel('Username').fill('john');
await page.getByLabel('Password').fill('secret');Arguments
Text to locate the element for.
Returns
LocatorAllows 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');Arguments
Text to locate the element for.
Returns
LocatorAllows 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.
Arguments
role "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"
Required aria role.
An attribute that is usually set by aria-checked or native <input type=checkbox> controls.
Learn more about aria-checked.
description string | RegExp (optional) Added in: v1.60
Option to match the accessible description. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.
Learn more about accessible description.
An attribute that is usually set by aria-disabled or disabled.
INFO
Unlike most other attributes, disabled is inherited through the DOM hierarchy. Learn more about aria-disabled.
exact boolean (optional) Added in: v1.28
Whether name and description are matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when the value is a regular expression. Note that exact match still trims whitespace.
An attribute that is usually set by aria-expanded.
Learn more about aria-expanded.
includeHidden boolean (optional)
Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.
Learn more about aria-hidden.
A number attribute that is usually present for roles heading, listitem, row, treeitem, with default values for <h1>-<h6> elements.
Learn more about aria-level.
name string | RegExp (optional)
Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.
Learn more about accessible name.
An attribute that is usually set by aria-pressed.
Learn more about aria-pressed.
An attribute that is usually set by aria-selected.
Learn more about aria-selected.
Returns
LocatorLocate 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() to configure a different test id attribute if necessary.
// Set custom test id attribute from @playwright/test config:
import { defineConfig } from '@playwright/test';
export default defineConfig({
use: {
testIdAttribute: 'data-pw'
},
});Arguments
Returns
LocatorAllows locating elements that contain given text.
See also locator.filter() that allows to match by another criteria, like an accessible role, and then filter by the text content.
Usage
Consider the following DOM structure:
<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>s
page.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">.
Arguments
Text to locate the element for.
Returns
LocatorAllows 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');Arguments
Text to locate the element for.
Returns
LocatorThe method finds an element matching the specified selector in the locator's subtree. It also accepts filter options, similar to locator.filter() method.
Arguments
selectorOrLocator string | Locator
A selector or locator to use when resolving DOM element.
Narrows down the results of the method to those which contain elements matching this relative locator. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.
Inner locator must be relative to the outer locator and is queried starting with the outer locator match, not the document root. For example, you can find content that has div in <article><content><div>Playwright</div></content></article>. However, looking for content that has article div will fail, because the inner locator must be relative and should not use any elements outside the content.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNot Locator (optional) Added in: v1.33
Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that does not have div matches <article><span>Playwright</span></article>.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.
hasNotText string | RegExp (optional) Added in: v1.33
Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring.
hasText string | RegExp (optional)
Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.
Returns
LocatorReturns a Locator object pointing to the same iframe as this frame locator.
Useful when you have a FrameLocator object obtained somewhere, and later on would like to interact with the iframe element.
For a reverse operation, use locator.contentFrame().
Usage
const frameLocator = page.locator('iframe[name="embedded"]').contentFrame();
// ...
const locator = frameLocator.owner();
await expect(locator).toBeVisible();Returns
LocatorDeprecated
Use locator.first() followed by locator.contentFrame() instead.
Returns locator to the first matching frame.
Returns
FrameLocatorDeprecated
Use locator.last() followed by locator.contentFrame() instead.
Returns locator to the last matching frame.
Returns
FrameLocatorDeprecated
Use locator.nth() followed by locator.contentFrame() instead.
Returns locator to the n-th matching frame. It's zero based, nth(0) selects the first frame.
Arguments
Returns
FrameLocator