其他定位符

引言

注意

查阅主要的定位符指南，了解最常用和推荐的定位符。

除了推荐的定位符，例如 Page.GetByRole() 和 Page.GetByText()，Playwright 还支持本指南中描述的多种其他定位符。

CSS 定位符

注意

我们推荐优先使用用户可见的定位符，如文本或可访问角色，而不是使用绑定到实现细节的 CSS 定位符，因为页面更改时可能会失效。

Playwright 可以通过 CSS 选择器定位元素。

await page.Locator("css=button").ClickAsync();

Playwright 通过两种方式增强了标准的 CSS 选择器

CSS 选择器可以穿透开放的 Shadow DOM。
Playwright 增加了自定义的伪类，例如 :visible、:has-text()、:has()、:is()、:nth-match() 等等。

CSS：按文本匹配

Playwright 包含一些 CSS 伪类，用于根据元素的文本内容进行匹配。

article:has-text("Playwright") - :has-text() 伪类匹配任何内部（可能在其子元素或后代元素中）包含指定文本的元素。匹配不区分大小写，会去除首尾空格并搜索子字符串。

例如，article:has-text("Playwright") 会匹配 <article><div>Playwright</div></article>。

注意，:has-text() 应该与其他 CSS 指定符一起使用，否则它会匹配所有包含指定文本的元素，包括 <body>。
```
// Wrong, will match many elements including <body>
await page.Locator(":has-text(\"Playwright\")").ClickAsync();
// Correct, only matches the <article> element
await page.Locator("article:has-text(\"Playwright\")").ClickAsync();
```
#nav-bar :text("Home") - :text() 伪类匹配包含指定文本的最小元素。匹配不区分大小写，会去除首尾空格并搜索子字符串。

例如，这会在 #nav-bar 元素内部的某个位置找到包含文本“Home”的元素
```
await page.Locator("#nav-bar :text('Home')").ClickAsync();
```
#nav-bar :text-is("Home") - :text-is() 伪类匹配具有确切文本的最小元素。精确匹配区分大小写，会去除首尾空格并搜索完整字符串。

例如，:text-is("Log") 不匹配 <button>Log in</button>，因为 <button> 包含一个文本节点 "Log in"，它不等于 "Log"。但是，:text-is("Log") 匹配 <button> Log <span>in</span></button>，因为 <button> 包含一个文本节点 " Log "。

同样，:text-is("Download") 不会匹配 <button>download</button>，因为它区分大小写。

#nav-bar :text-matches("reg?ex", "i") - :text-matches() 伪类匹配文本内容与类似 JavaScript 正则表达式匹配的最小元素。

例如，:text-matches("Log\s*in", "i") 匹配 <button>Login</button> 和 <button>log IN</button>。

注意

文本匹配总是会规范化空白字符。例如，它会将多个空格变成一个，将换行符变成空格，并忽略前导和尾随的空白字符。

注意

类型为 button 和 submit 的 input 元素通过其 value 进行匹配，而不是通过文本内容。例如，:text("Log in") 匹配 <input type=button value="Log in">。

CSS：仅匹配可见元素

Playwright 在 CSS 选择器中支持 :visible 伪类。例如，css=button 匹配页面上所有按钮，而 css=button:visible 只匹配可见按钮。这对于区分非常相似但可见性不同的元素很有用。

考虑一个有两个按钮的页面，第一个不可见，第二个可见。

<button style='display: none'>Invisible</button>
<button>Visible</button>

这将找到这两个按钮，并抛出严格模式违规错误
```
await page.Locator("button").ClickAsync();
```
这只会找到第二个按钮，因为它是可见的，然后点击它。
```
await page.Locator("button:visible").ClickAsync();
```

CSS：包含其他元素的元素

:has() 伪类是一个实验性的 CSS 伪类。如果作为参数传入的任何选择器相对于给定元素的 :scope 匹配至少一个元素，则返回该元素。

以下代码片段返回内部包含 <div class=promo> 的 <article> 元素的文本内容。

await page.Locator("article:has(div.promo)").TextContentAsync();

CSS：匹配任一条件的元素

逗号分隔的 CSS 选择器列表将匹配列表中任一选择器可以选中的所有元素。

// Clicks a <button> that has either a "Log in" or "Sign in" text.
await page.Locator("button:has-text(\"Log in\"), button:has-text(\"Sign in\")").ClickAsync();

:is() 伪类是一个实验性的 CSS 伪类，对于指定元素的额外条件列表可能很有用。

CSS：基于布局匹配元素

注意

基于布局的匹配可能会产生意想不到的结果。例如，当布局改变一个像素时，可能会匹配到不同的元素。

有时，当目标元素缺乏独特特征时，很难找到一个好的选择器。在这种情况下，使用 Playwright 布局相关的 CSS 伪类可能会有所帮助。可以将它们与常规 CSS 结合使用，以精确定位多个选择中的一个。

例如，input:right-of(:text("Password")) 匹配位于文本“Password”右侧的输入字段——当页面有多个难以区分的输入字段时，这很有用。

请注意，布局相关的伪类是在其他选择器（如 input）之外使用的补充。如果单独使用布局相关的伪类，例如 :right-of(:text("Password"))，很可能不会得到你想要的输入框，而是文本和目标输入框之间的一些空元素。

布局相关的伪类使用 bounding client rect 来计算元素的距离和相对位置。

:right-of(div > button) - 匹配位于与内部选择器匹配的任何元素右侧、任意垂直位置的元素。
:left-of(div > button) - 匹配位于与内部选择器匹配的任何元素左侧、任意垂直位置的元素。
:above(div > button) - 匹配位于与内部选择器匹配的任何元素上方、任意水平位置的元素。
:below(div > button) - 匹配位于与内部选择器匹配的任何元素下方、任意水平位置的元素。
:near(div > button) - 匹配靠近（在 50 CSS 像素范围内）与内部选择器匹配的任何元素的元素。

请注意，匹配结果会按照它们到锚点元素的距离进行排序，因此你可以使用 Locator.First 来选择最近的一个。这仅在你有一系列相似元素（其中最近的显然是正确的一个）的情况下有用。然而，在其他情况下使用 Locator.First 很可能不会按预期工作——它不会定位到你正在寻找的元素，而是恰好是最近的其他元素，比如一个随机的空 <div>，或者一个已滚动出视野且当前不可见的元素。

// Fill an input to the right of "Username".
await page.Locator("input:right-of(:text(\"Username\"))").FillAsync("value");

// Click a button near the promo card.
await page.Locator("button:near(.promo-card)").ClickAsync();

// Click the radio input in the list closest to the "Label 3".
await page.Locator("[type=radio]:left-of(:text(\"Label 3\"))").First.ClickAsync();

所有布局相关的伪类都支持将可选的最大像素距离作为最后一个参数。例如，button:near(:text("Username"), 120) 匹配距离文本为“Username”的元素最多 120 CSS 像素的按钮。

CSS：从查询结果中选择第 n 个匹配项

注意

通常可以通过某些属性或文本内容来区分元素，这对于页面更改更具弹性。

有时页面包含多个相似的元素，很难选择特定的一个。例如

<section> <button>Buy</button> </section>
<article><div> <button>Buy</button> </div></article>
<div><div> <button>Buy</button> </div></div>

在这种情况下，:nth-match(:text("Buy"), 3) 将选择上面代码片段中的第三个按钮。注意索引是从 1 开始的。

// Click the third "Buy" button
await page.Locator(":nth-match(:text('Buy'), 3)").ClickAsync();

使用 Locator.WaitForAsync()，:nth-match() 也可用于等待指定数量的元素出现。

// Wait until all three buttons are visible
await page.Locator(":nth-match(:text('Buy'), 3)").WaitForAsync();

注意

与 :nth-child() 不同，元素不必是同级元素，它们可以在页面上的任何位置。在上面的代码片段中，所有三个按钮都匹配 :text("Buy") 选择器，而 :nth-match() 选择第三个按钮。

第 N 个元素定位符

你可以使用 nth= 定位符并传入一个从零开始的索引来将查询范围缩小到第 n 个匹配项。

// Click first button
await page.Locator("button").Locator("nth=0").ClickAsync();

// Click last button
await page.Locator("button").Locator("nth=-1").ClickAsync();

父元素定位符

当你需要定位某个其他元素的父元素时，大多数情况下应该使用子元素定位符通过 Locator.Filter() 进行筛选。例如，考虑以下 DOM 结构

<li><label>Hello</label></li>
<li><label>World</label></li>

如果你想定位文本为 "Hello" 的 label 的父级 <li>，使用 Locator.Filter() 是最好的方法

var child = page.GetByText("Hello");
var parent = page.GetByRole(AriaRole.Listitem).Filter(new () { Has = child });

或者，如果找不到适合父元素的定位符，可以使用 xpath=..。请注意，此方法不太可靠，因为对 DOM 结构的任何更改都会破坏你的测试。如果可能，优先使用 Locator.Filter()。

var parent = page.GetByText("Hello").Locator("xpath=..");

React 定位符

注意

React 定位符是实验性的，并带有 _ 前缀。其功能将来可能会发生变化。

React 定位符允许根据组件名称和属性值查找元素。其语法与 CSS 属性选择器非常相似，并支持所有 CSS 属性选择器运算符。

在 React 定位符中，组件名称使用 驼峰命名法 (CamelCase) 进行转写。

await page.Locator("_react=BookItem").ClickAsync();

更多示例

按组件匹配：_react=BookItem
按组件和精确属性值匹配，区分大小写：_react=BookItem[author = "Steven King"]
仅按属性值匹配，不区分大小写：_react=[author = "steven king" i]
按组件和真值属性值匹配：_react=MyButton[enabled]
按组件和布尔值匹配：_react=MyButton[enabled = false]
按属性值子串匹配：_react=[author *= "King"]
按组件和多个属性匹配：_react=BookItem[author *= "king" i][year = 1990]
按嵌套属性值匹配：_react=[some.nested.value = 12]
按组件和属性值前缀匹配：_react=BookItem[author ^= "Steven"]
按组件和属性值后缀匹配：_react=BookItem[author $= "Steven"]
按组件和 key 匹配：_react=BookItem[key = '2']
按属性值正则表达式匹配：_react=[author = /Steven(\\s+King)?/i]

要在树中查找 React 元素名称，请使用 React DevTools。

注意

React 定位符支持 React 15 及以上版本。

注意

React 定位符以及 React DevTools 仅适用于未压缩（unminified）的应用构建版本。

Vue 定位符

注意

Vue 定位符是实验性的，并带有 _ 前缀。其功能将来可能会发生变化。

Vue 定位符允许根据组件名称和属性值查找元素。其语法与 CSS 属性选择器非常相似，并支持所有 CSS 属性选择器运算符。

在 Vue 定位符中，组件名称使用 烤串命名法 (kebab-case) 进行转写。

await page.Locator("_vue=book-item").ClickAsync();

更多示例

按组件匹配：_vue=book-item
按组件和精确属性值匹配，区分大小写：_vue=book-item[author = "Steven King"]
仅按属性值匹配，不区分大小写：_vue=[author = "steven king" i]
按组件和真值属性值匹配：_vue=my-button[enabled]
按组件和布尔值匹配：_vue=my-button[enabled = false]
按属性值子串匹配：_vue=[author *= "King"]
按组件和多个属性匹配：_vue=book-item[author *= "king" i][year = 1990]
按嵌套属性值匹配：_vue=[some.nested.value = 12]
按组件和属性值前缀匹配：_vue=book-item[author ^= "Steven"]
按组件和属性值后缀匹配：_vue=book-item[author $= "Steven"]
按属性值正则表达式匹配：_vue=[author = /Steven(\\s+King)?/i]

要在树中查找 Vue 元素名称，请使用 Vue DevTools。

注意

Vue 定位符支持 Vue2 及以上版本。

注意

Vue 定位符以及 React DevTools 仅适用于未压缩（unminified）的应用构建版本。

XPath 定位符

警告

我们推荐优先使用用户可见的定位符，如文本或可访问角色，而不是使用绑定到实现细节的 XPath，因为页面更改时很容易失效。

XPath 定位符相当于调用 Document.evaluate。

await page.Locator("xpath=//button").ClickAsync();

注意

任何以 // 或 .. 开头的选择器字符串都被假定为 xpath 选择器。例如，Playwright 将 '//html/body' 转换为 'xpath=//html/body'。

注意

XPath 不穿透 Shadow Roots。

XPath 合并

在 XPath 中可以使用管道运算符 (|) 来指定多个选择器。它将匹配该列表中任一选择器可以选中的所有元素。

// Waits for either confirmation dialog or load spinner.
await page.Locator("//span[contains(@class, 'spinner__loading')]|//div[@id='confirmation']").WaitForAsync();

标签到表单控件的重定向

警告

我们推荐通过标签文本定位，而不是依赖标签到控件的重定向。

Playwright 中的目标输入操作会自动区分标签和控件，因此你可以定位标签来对其关联的控件执行操作。

例如，考虑以下 DOM 结构：<label for="password">Password:</label><input id="password" type="password">。你可以使用 Page.GetByText() 通过其“Password”文本定位标签。但是，以下操作将在 input 上执行，而不是在标签上执行

Locator.ClickAsync() 将点击标签并自动聚焦输入字段；
Locator.FillAsync() 将填充输入字段；
Locator.InputValueAsync() 将返回输入字段的值；
Locator.SelectTextAsync() 将选中输入字段中的文本；
Locator.SetInputFilesAsync() 将为 type=file 的输入字段设置文件；
Locator.SelectOptionAsync() 将从 select 框中选择一个选项。

// Fill the input by targeting the label.
await page.GetByText("Password").FillAsync("secret");

然而，其他方法将定位标签本身，例如 Expect(Locator).ToHaveTextAsync() 将断言标签的文本内容，而不是输入字段的文本内容。

// Fill the input by targeting the label.
await Expect(Page.Locator("label")).ToHaveTextAsync("Password");

旧版文本定位符

警告

我们推荐使用现代的文本定位符。

旧版文本定位符匹配包含传入文本的元素。

await page.Locator("text=Log in").ClickAsync();

旧版文本定位符有几种变体

text=Log in - 默认匹配不区分大小写，会去除首尾空格并搜索子字符串。例如，text=Log 匹配 <button>Log in</button>。
```
await page.Locator("text=Log in").ClickAsync();
```
text="Log in" - 文本内容可以用单引号或双引号括起来，以搜索去除首尾空格后内容完全匹配的文本节点。

例如，text="Log" 不匹配 <button>Log in</button>，因为 <button> 包含一个文本节点 "Log in"，它不等于 "Log"。但是，text="Log" 匹配 <button> Log <span>in</span></button>，因为 <button> 包含一个文本节点 " Log "。这种精确模式意味着区分大小写，因此 text="Download" 不会匹配 <button>download</button>。

带引号的内容遵循通常的转义规则，例如，在双引号字符串中使用 \" 来转义双引号：text="foo\"bar"。
```
await page.Locator("text='Log in'").ClickAsync();
```
/Log\s*in/i - 内容可以是包含在 / 符号中的类似 JavaScript 正则表达式。例如，text=/Log\s*in/i 匹配 <button>Login</button> 和 <button>log IN</button>。
```
await page.Locator("text=/Log\\s*in/i").ClickAsync();
```

注意

以引号（" 或 '）开头和结尾的字符串选择器被视为旧版文本定位符。例如，"Log in" 在内部会被转换为 text="Log in"。

注意

匹配总是会规范化空白字符。例如，它会将多个空格变成一个，将换行符变成空格，并忽略前导和尾随的空白字符。

注意

类型为 button 和 submit 的 input 元素通过其 value 进行匹配，而不是通过文本内容。例如，text=Log in 匹配 <input type=button value="Log in">。

id, data-testid, data-test-id, data-test 选择器

警告

我们推荐通过 test id 定位。

Playwright 支持使用特定属性选择元素的简写方式。目前，仅支持以下属性

id
data-testid
data-test-id
data-test

// Fill an input with the id "username"
await page.Locator("id=username").FillAsync("value");

// Click an element with data-test-id "submit"
await page.Locator("data-test-id=submit").ClickAsync();

注意

属性选择器不是 CSS 选择器，因此不支持任何 CSS 特定的内容，例如 :enabled。如需更多功能，请使用适当的 css 选择器，例如 css=[data-test="login"]:enabled。

链式选择器

警告

我们推荐使用链式定位符。

定义为 engine=body 或简写形式的选择器可以使用 >> 符号组合，例如 selector1 >> selector2 >> selectors3。当选择器被链式组合时，下一个选择器将相对于前一个选择器的结果进行查询。

例如，

css=article >> css=.bar > .baz >> css=span[attr=value]

等同于

document
    .querySelector('article')
    .querySelector('.bar > .baz')
    .querySelector('span[attr=value]');

如果选择器需要在主体中包含 >>，则应在字符串内部进行转义，以免与链式分隔符混淆，例如 text="some >> text"。

中间匹配项

警告

我们推荐使用按另一个定位符进行筛选来定位包含其他元素的元素。

默认情况下，链式选择器解析到最后一个选择器查询到的元素。选择器可以加前缀 * 来捕获由中间选择器查询到的元素。

例如，css=article >> text=Hello 捕获文本为 Hello 的元素，而 *css=article >> text=Hello (注意 *) 捕获包含文本为 Hello 的元素的 article 元素。

引言​

CSS 定位符​

CSS：按文本匹配​

CSS：仅匹配可见元素​

CSS：包含其他元素的元素​

CSS：匹配任一条件的元素​

CSS：基于布局匹配元素​

CSS：从查询结果中选择第 n 个匹配项​

第 N 个元素定位符​

父元素定位符​

React 定位符​

Vue 定位符​

XPath 定位符​

XPath 合并​

标签到表单控件的重定向​

旧版文本定位符​

id, data-testid, data-test-id, data-test 选择器​

链式选择器​

中间匹配项​

引言