FrameLocator

FrameLocator 代表页面上 iframe 的视图。它包含了检索 iframe 并在该 iframe 中定位元素所需的逻辑。FrameLocator 可以通过 Locator.contentFrame()、Page.frameLocator() 或 Locator.frameLocator() 方法创建。

Locator locator = page.locator("#my-frame").contentFrame().getByText("Submit");
locator.click();

严格性

框架定位器是严格的。这意味着如果有多个元素与给定的选择器匹配，对框架定位器的所有操作都将抛出异常。

// 如果 DOM 中有多个框架，则抛出异常：
page.locator(".result-frame").contentFrame().getByRole(AriaRole.BUTTON).click();

// 可行，因为我们明确告诉定位器选择第一个框架：
page.locator(".result-frame").first().contentFrame().getByRole(AriaRole.BUTTON).click();

将定位器转换为框架定位器

如果你有一个指向 iframe 的 Locator 对象，可以使用 Locator.contentFrame() 将其转换为 FrameLocator。

将框架定位器转换为定位器

如果你有一个 FrameLocator 对象，可以使用 FrameLocator.owner() 将其转换为指向同一 iframe 的 Locator。

方法

frameLocator

添加于：v1.17

frameLocator.frameLocator

在处理 iframe 时，你可以创建一个框架定位器，它将进入 iframe 并允许在该 iframe 中选择元素。

用法

FrameLocator.frameLocator(selector);

参数

selector String #

解析 DOM 元素时使用的选择器。

返回值

FrameLocator #

getByAltText

新增于：v1.27

frameLocator.getByAltText

允许通过元素的替代文本（alt text）定位元素。

用法

例如，此方法将通过替代文本 “Playwright logo” 找到图片：

<img alt='Playwright logo'>

page.getByAltText("Playwright logo").click();

参数

text String | Pattern #

用于定位元素的文本。
options FrameLocator.GetByAltTextOptions (可选)
- setExact boolean (可选)#
  
  是否查找完全匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，完全匹配仍会修剪空白字符。

返回值

Locator #

getByLabel

添加于：v1.27

frameLocator.getByLabel

允许通过关联的 <label> 或 aria-labelledby 元素的文本，或通过 aria-label 属性来定位输入元素。

用法

例如，此方法将在以下 DOM 中通过标签 “Username” 和 “Password” 找到输入框：

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">

page.getByLabel("Username").fill("john");
page.getByLabel("Password").fill("secret");

参数

text String | Pattern #

用于定位元素的文本。
options FrameLocator.GetByLabelOptions (可选)
- setExact boolean (可选)#
  
  是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会去除空白字符。

返回值

Locator #

getByPlaceholder

添加于：v1.27

frameLocator.getByPlaceholder

允许通过占位符文本定位输入元素。

使用方法

例如，考虑以下 DOM 结构：

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

你可以通过占位符文本定位到输入框后，填充内容：

page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");

参数

text String | Pattern # 用于定位元素的文本。
options FrameLocator.GetByPlaceholderOptions（可选）
- setExact boolean（可选）# 是否进行精确匹配：区分大小写且匹配整个字符串。默认为 false。通过正则表达式定位时忽略此选项。请注意，精确匹配仍会去除空白字符。

返回值

Locator #

getByRole

新增于：v1.27

frameLocator.getByRole

允许通过 ARIA 角色、ARIA 属性和可访问名称定位元素。

用法

考虑以下 DOM 结构。

<h3>注册</h3>
<label>
  <input type="checkbox" /> 订阅
</label>
<br/>
<button>提交</button>

你可以通过元素的隐式角色来定位每个元素：

assertThat(page
    .getByRole(AriaRole.HEADING,
               new Page.GetByRoleOptions().setName("注册")))
    .isVisible();

page.getByRole(AriaRole.CHECKBOX,
               new Page.GetByRoleOptions().setName("订阅"))
    .check();

page.getByRole(AriaRole.BUTTON,
               new Page.GetByRoleOptions().setName(
                   Pattern.compile("提交", Pattern.CASE_INSENSITIVE)))
    .click();

参数

role 枚举 AriaRole { 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 }#

必需的 ARIA 角色。
options FrameLocator.GetByRoleOptions（可选）
- setChecked [布尔值]（可选）#
  
  通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。
  
  了解更多关于 aria-checked 的信息。
- setDisabled [布尔值]（可选）#
  
  通常由 aria-disabled 或 disabled 设置的属性。
  
  备注
  与大多数其他属性不同，disabled 会通过 DOM 层级继承。了解更多关于 aria-disabled 的信息。
- setExact [布尔值]（可选）新增于：v1.28#
  
  setName 是否完全匹配：区分大小写且为全字符串匹配。默认为 false。当 setName 是正则表达式时，此选项将被忽略。请注意，完全匹配仍会修剪空白字符。
- setExpanded [布尔值]（可选）#
  
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded 的信息。
- setIncludeHidden [布尔值]（可选）#
  
  控制是否匹配隐藏元素的选项。默认情况下，根据 ARIA 定义，角色选择器仅匹配非隐藏元素。
  
  了解更多关于 aria-hidden 的信息。
- setLevel [整数]（可选）#
  
  通常用于 heading、listitem、row、treeitem 角色的数字属性，对于 <h1>-<h6> 元素有默认值。
  
  了解更多关于 aria-level 的信息。
- setName [字符串] | [模式]（可选）#
  
  用于匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 setExact 来控制此行为。
  
  了解更多关于可访问名称的信息。
- setPressed [布尔值]（可选）#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- setSelected [布尔值]（可选）#
  
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected 的信息。

返回值

Locator #

详细信息

角色选择器不会替代可访问性审计和一致性测试，而是提供有关 ARIA 指南的早期反馈。

许多 HTML 元素都有一个隐式的已定义角色，角色选择器可以识别这些角色。你可以在此处找到所有受支持的角色。ARIA 指南不建议通过将 role 和 / 或 aria-* 属性设置为默认值来重复隐式角色和属性。

getByTestId

添加于：v1.27

frameLocator.getByTestId

通过测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

你可以通过其测试 ID 定位该元素：

page.getByTestId("directions").click();

参数

testId String | Pattern #

用于定位元素的 ID。

返回值

Locator #

详细信息

默认情况下，data-testid 属性用作测试 ID。如有必要，可使用 Selectors.setTestIdAttribute() 配置不同的测试 ID 属性。

getByText

添加于：v1.27

frameLocator.getByText

允许定位包含给定文本的元素。

另请参阅 Locator.filter()，它允许通过其他条件（如可访问角色）进行匹配，然后按文本内容进行筛选。

用法

考虑以下 DOM 结构：

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

你可以通过文本子字符串、精确字符串或正则表达式进行定位：

// 匹配 <span>
page.getByText("world");

// 匹配第一个 <div>
page.getByText("Hello world");

// 匹配第二个 <div>
page.getByText("Hello", new Page.GetByTextOptions().setExact(true));

// 匹配两个 <div>
page.getByText(Pattern.compile("Hello"));

// 匹配第二个 <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));

参数

text String | Pattern #

用于定位元素的文本。
options FrameLocator.GetByTextOptions (可选)
- setExact boolean (可选)#
  
  是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会修剪空白字符。

返回值

Locator #

详细信息

即使是精确匹配，按文本匹配也总会对空白字符进行规范化处理。例如，它会将多个空格合并为一个，将换行符转换为空格，并忽略前导和尾随的空白字符。

类型为 button 和 submit 的输入元素是通过其 value 而不是文本内容进行匹配的。例如，通过文本 "登录" 定位会匹配 <input type=button value="登录">。

getByTitle

添加于：v1.27

frameLocator.getByTitle

允许通过元素的 title 属性定位元素。

用法

考虑以下 DOM 结构。

<span title='问题数量'>25 个问题</span>

你可以在通过标题文本定位到问题数量后，对其进行检查：

assertThat(page.getByTitle("问题数量")).hasText("25 个问题");

参数

text String | Pattern # 用于定位元素的文本。
options FrameLocator.GetByTitleOptions（可选）
- setExact boolean（可选）# 是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时忽略此选项。请注意，精确匹配仍会修剪空白字符。

返回值

Locator #

locator

添加于：v1.17

frameLocator.locator

该方法在定位器的子树中查找与指定选择器匹配的元素。它还接受过滤选项，类似于 Locator.filter() 方法。

详细了解定位器。

用法

FrameLocator.locator(selectorOrLocator);
FrameLocator.locator(selectorOrLocator, options);

参数

selectorOrLocator String | Locator #

解析 DOM 元素时使用的选择器或定位器。
options FrameLocator.LocatorOptions（可选）
- setHas Locator（可选）#
  
  将方法的结果范围缩小到包含与该相对定位器匹配的元素的结果。例如，有 text=Playwright 的 article 与 <article><div>Playwright</div></article> 匹配。
  
  内部定位器 必须相对于 外部定位器，并且从外部定位器匹配的位置开始查询，而不是从文档根开始。例如，在 <article><content><div>Playwright</div></content></article> 中，可以找到有 div 的 content。但是，查找有 article div 的 content 会失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator。
- setHasNot Locator（可选）新增于：v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器是相对于外部定位器进行查询的。例如，没有 div 的 article 与 <article><span>Playwright</span></article> 匹配。
  
  请注意，外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator。
- setHasNotText String | Pattern（可选）新增于：v1.33#
  
  匹配在内部（可能在子元素或后代元素中）某个位置不包含指定文本的元素。当传入 [字符串] 时，匹配不区分大小写，并搜索子字符串。
- setHasText String | Pattern（可选）#
  
  匹配在内部（可能在子元素或后代元素中）某个位置包含指定文本的元素。当传入 [字符串] 时，匹配不区分大小写，并搜索子字符串。例如，"Playwright" 与 <article><div>Playwright</div></article> 匹配。

返回值

Locator #

owner

添加于：v1.43

frameLocator.owner

返回一个 Locator 对象，该对象指向与此框架定位器相同的 iframe。

当你在某个地方获取到一个 FrameLocator 对象，之后想要与 iframe 元素进行交互时，此方法很有用。

如需进行反向操作，请使用 Locator.contentFrame()。

用法

FrameLocator frameLocator = page.locator("iframe[name=\"embedded\"]").contentFrame();
// ...
Locator locator = frameLocator.owner();
assertThat(locator).isVisible();

返回值

Locator #

已弃用

first

添加于：v1.17

frameLocator.first

已弃用

请改用 Locator.first() ，然后再使用 Locator.contentFrame()。

返回指向第一个匹配框架的定位器。

用法

FrameLocator.first();

返回值

FrameLocator #

last

添加于：v1.17

frameLocator.last

已弃用

请改用 Locator.last() ，然后再使用 Locator.contentFrame()。

返回定位到最后一个匹配框架的定位器。

用法

FrameLocator.last();

返回值

FrameLocator #

nth

添加于：v1.17

frameLocator.nth

已弃用

请改用 Locator.nth() ，然后再使用 Locator.contentFrame()。

返回定位到第 n 个匹配框架的定位器。索引从 0 开始，nth(0) 选择第一个框架。

用法

FrameLocator.nth(index);

参数

index int #

返回值

FrameLocator #

方法​

frameLocator​

参数​

返回值​

getByAltText​

用法​

参数​

返回值​

getByLabel​

getByPlaceholder​

使用方法​

参数​

返回值​

getByRole​

getByTestId​

getByText​

详细信息​

getByTitle​

用法​

参数​

返回值​

locator​

owner​

已弃用​

first​

last​

nth​

方法

frameLocator

参数

返回值

getByAltText

用法

参数

返回值

getByLabel

getByPlaceholder

使用方法

参数

返回值

getByRole

getByTestId

getByText

详细信息

getByTitle

用法

参数

返回值

locator

owner

已弃用

first

last

nth