跳至主要内容

FrameLocator

FrameLocator 表示页面上 iframe 的视图。它捕获了检索 iframe 并定位该 iframe 中元素的足够逻辑。FrameLocator 可以使用 Locator.ContentFramePage.FrameLocator()Locator.FrameLocator() 方法创建。

var locator = page.Locator("#my-frame").ContentFrame.GetByText("Submit");
await locator.ClickAsync();

严格性

Frame 定位器是严格的。这意味着如果多个元素匹配给定的选择器,则 Frame 定位器上的所有操作都将抛出异常。

// Throws if there are several frames in DOM:
await page.Locator(".result-frame").ContentFrame.GetByRole(AriaRole.Button).ClickAsync();

// Works because we explicitly tell locator to pick the first frame:
await page.Locator(".result-frame").First.ContentFrame.getByRole(AriaRole.Button).ClickAsync();

将 Locator 转换为 FrameLocator

如果您有一个指向 iframeLocator 对象,则可以使用 Locator.ContentFrame 将其转换为 FrameLocator

将 FrameLocator 转换为 Locator

如果您有一个 FrameLocator 对象,则可以使用 FrameLocator.Owner 将其转换为指向相同 iframeLocator


方法

FrameLocator

新增于:v1.17 frameLocator.FrameLocator

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

用法

FrameLocator.FrameLocator(selector);

参数

  • selector string#

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

返回值


GetByAltText

新增于:v1.27 frameLocator.GetByAltText

允许通过其替代文本定位元素。

用法

例如,此方法将通过替代文本“Playwright logo”查找图像

<img alt='Playwright logo'>
await page.GetByAltText("Playwright logo").ClickAsync();

参数

  • text string | Regex#

    要为其定位元素的文本。

  • options FrameLocatorGetByAltTextOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意,完全匹配仍然会修剪空格。

返回值


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">
await page.GetByLabel("Username").FillAsync("john");
await page.GetByLabel("Password").FillAsync("secret");

参数

  • text string | Regex#

    要为其定位元素的文本。

  • options FrameLocatorGetByLabelOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意,完全匹配仍然会修剪空格。

返回值


GetByPlaceholder

新增于:v1.27 frameLocator.GetByPlaceholder

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

用法

例如,考虑以下 DOM 结构。

<input type="email" placeholder="[email protected]" />

您可以通过占位符文本定位输入后填充输入

await page
.GetByPlaceholder("[email protected]")
.FillAsync("[email protected]");

参数

  • text string | Regex#

    要为其定位元素的文本。

  • options FrameLocatorGetByPlaceholderOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意,完全匹配仍然会修剪空格。

返回值


GetByRole

新增于:v1.27 frameLocator.GetByRole

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

用法

考虑以下 DOM 结构。

<h3>Sign up</h3>
<label>
<input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

您可以通过其隐式角色定位每个元素

await Expect(Page
.GetByRole(AriaRole.Heading, new() { Name = "Sign up" }))
.ToBeVisibleAsync();

await page
.GetByRole(AriaRole.Checkbox, new() { Name = "Subscribe" })
.CheckAsync();

await page
.GetByRole(AriaRole.Button, new() {
NameRegex = new Regex("submit", RegexOptions.IgnoreCase)
})
.ClickAsync();

参数

  • role enum 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 FrameLocatorGetByRoleOptions? (可选)

    • Checked bool? (可选)#

      通常由 aria-checked 或本机 <input type=checkbox> 控件设置的属性。

      详细了解 aria-checked

    • Disabled bool? (可选)#

      通常由 aria-disableddisabled 设置的属性。

      注意

      与大多数其他属性不同,disabled 在 DOM 层次结构中是继承的。详细了解 aria-disabled

    • Exact bool? (可选)新增于:v1.28#

      Name|NameRegex 是否完全匹配:区分大小写且为整个字符串。默认为 false。当 Name|NameRegex 是正则表达式时忽略。请注意,完全匹配仍然会修剪空格。

    • Expanded bool? (可选)#

      通常由 aria-expanded 设置的属性。

      详细了解 aria-expanded

    • IncludeHidden bool? (可选)#

      控制是否匹配隐藏元素的选项。默认情况下,只有非隐藏元素(如 ARIA 定义 所定义)与角色选择器匹配。

      详细了解 aria-hidden

    • Level int? (可选)#

      通常存在于角色 headinglistitemrowtreeitem 中的数字属性,其中包含 <h1>-<h6> 元素的默认值。

      详细了解 aria-level

    • Name|NameRegex string? | Regex? (可选)#

      匹配可访问名称的选项。默认情况下,匹配不区分大小写并搜索子字符串,使用Exact控制此行为。

      详细了解可访问名称

    • Pressed bool? (可选)#

      通常由aria-pressed设置的属性。

      详细了解aria-pressed

    • Selected bool? (可选)#

      通常由aria-selected设置的属性。

      详细了解aria-selected

返回值

详情

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

许多 html 元素具有角色选择器识别的隐式定义的角色。您可以在此处找到所有支持的角色。ARIA 指南不建议通过设置role和/或aria-*属性为默认值来复制隐式角色和属性。


GetByTestId

新增于:v1.27 frameLocator.GetByTestId

根据测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

您可以根据其测试 ID 定位元素

await page.GetByTestId("directions").ClickAsync();

参数

返回值

详情

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


GetByText

新增于:v1.27 frameLocator.GetByText

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

另请参阅Locator.Filter(),它允许根据其他条件(如可访问角色)进行匹配,然后根据文本内容进行筛选。

用法

考虑以下 DOM 结构

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

您可以按文本子字符串、精确字符串或正则表达式进行定位

// Matches <span>
page.GetByText("world");

// Matches first <div>
page.GetByText("Hello world");

// Matches second <div>
page.GetByText("Hello", new() { Exact = true });

// Matches both <div>s
page.GetByText(new Regex("Hello"));

// Matches second <div>
page.GetByText(new Regex("^hello$", RegexOptions.IgnoreCase));

参数

  • text string | Regex#

    要为其定位元素的文本。

  • options FrameLocatorGetByTextOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意,完全匹配仍然会修剪空格。

返回值

详情

即使进行精确匹配,按文本匹配也会始终规范化空格。例如,它将多个空格转换为一个空格,将换行符转换为空格,并忽略前导和尾随空格。

类型为buttonsubmit的输入元素通过其value而不是文本内容进行匹配。例如,按文本"Log in"定位匹配<input type=button value="Log in">


GetByTitle

新增于:v1.27 frameLocator.GetByTitle

允许根据元素的 title 属性进行定位。

用法

考虑以下 DOM 结构。

<span title='Issues count'>25 issues</span>

您可以根据标题文本定位后检查问题计数

await Expect(Page.GetByTitle("Issues count")).toHaveText("25 issues");

参数

  • text string | Regex#

    要为其定位元素的文本。

  • options FrameLocatorGetByTitleOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写且为整个字符串。默认为 false。通过正则表达式定位时忽略。请注意,完全匹配仍然会修剪空格。

返回值


Locator

新增于:v1.17 frameLocator.Locator

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

详细了解定位器.

用法

FrameLocator.Locator(selectorOrLocator, options);

参数

  • selectorOrLocator string | Locator#

    解析 DOM 元素时要使用的选择器或定位器。

  • options FrameLocatorLocatorOptions? (可选)

    • Has Locator? (可选)#

      将该方法的结果缩小到包含匹配此相对定位器的元素的那些元素。例如,包含text=Playwrightarticle匹配<article><div>Playwright</div></article>

      内部定位器必须相对于外部定位器,并且从外部定位器匹配开始查询,而不是文档根。例如,您可以在<article><content><div>Playwright</div></content></article>中找到包含divcontent。但是,查找包含article divcontent将失败,因为内部定位器必须是相对的,并且不应使用content之外的任何元素。

      请注意,外部和内部定位器必须属于同一个框架。内部定位器不得包含FrameLocator

    • HasNot Locator? (可选)新增于:v1.33#

      匹配不包含匹配内部定位器的元素的元素。内部定位器针对外部定位器进行查询。例如,不包含divarticle匹配<article><span>Playwright</span></article>

      请注意,外部和内部定位器必须属于同一个框架。内部定位器不得包含FrameLocator

    • HasNotText|HasNotTextRegex string? | Regex? (可选)新增于:v1.33#

      匹配内部(可能在子元素或后代元素中)某处不包含指定文本的元素。当传递string时,匹配不区分大小写并搜索子字符串。

    • HasText|HasTextRegex string? | Regex? (可选)#

      匹配内部(可能在子元素或后代元素中)某处包含指定文本的元素。当传递string时,匹配不区分大小写并搜索子字符串。例如,"Playwright"匹配<article><div>Playwright</div></article>

返回值


Owner

新增于:v1.43 frameLocator.Owner

返回一个指向与该框架定位器相同的iframeLocator对象。

当您在某处获取了FrameLocator对象,并且稍后希望与iframe元素交互时,这很有用。

对于反向操作,请使用Locator.ContentFrame

用法

var frameLocator = Page.Locator("iframe[name=\"embedded\"]").ContentFrame;
// ...
var locator = frameLocator.Owner;
await Expect(locator).ToBeVisibleAsync();

返回值


已弃用

First

新增于:v1.17 frameLocator.First
已弃用

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

用法

FrameLocator.First

返回值


Last

新增于:v1.17 frameLocator.Last
已弃用

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

用法

FrameLocator.Last

返回值


Nth

新增于:v1.17 frameLocator.Nth
已弃用

返回指向第 n 个匹配框架的定位器。它是从 0 开始的,nth(0)选择第一个框架。

用法

FrameLocator.Nth(index);

参数

返回值