LocatorAssertions

LocatorAssertions 类提供了断言方法，可用于对测试中的 Locator 状态进行断言。

¥The LocatorAssertions class provides assertion methods that can be used to make assertions about the Locator state in the tests.

using Microsoft.Playwright;
using Microsoft.Playwright.MSTest;

namespace PlaywrightTests;

[TestClass]
public class ExampleTests : PageTest
{
    [TestMethod]
    public async Task StatusBecomesSubmitted()
    {
        // ...
        await Page.GetByRole(AriaRole.Button, new() { Name = "Sign In" }).ClickAsync();
        await Expect(Page.Locator(".status")).ToHaveTextAsync("Submitted");
    }
}

方法

¥Methods

ToBeAttachedAsync

Added in: v1.33

locatorAssertions.ToBeAttachedAsync

确保 Locator 指向 connected 指向 Document 或 ShadowRoot 的元素。

¥Ensures that Locator points to an element that is connected to a Document or a ShadowRoot.

用法

¥Usage

await Expect(Page.GetByText("Hidden text")).ToBeAttachedAsync();

参数

¥Arguments

options LocatorAssertionsToBeAttachedOptions?（可选）

¥options LocatorAssertionsToBeAttachedOptions? (optional)
- Attached bool? (optional)#
- Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeCheckedAsync

Added in: v1.20

locatorAssertions.ToBeCheckedAsync

确保 Locator 指向已检查的输入。

¥Ensures the Locator points to a checked input.

用法

¥Usage

var locator = Page.GetByLabel("Subscribe to newsletter");
await Expect(locator).ToBeCheckedAsync();

参数

¥Arguments

options LocatorAssertionsToBeCheckedOptions?（可选）

¥options LocatorAssertionsToBeCheckedOptions? (optional)
- Checked bool? (optional) Added in: v1.18#

提供要断言的状态。默认检查输入的断言。当不确定设置为 true 时，不能使用此选项。

¥Provides state to assert for. Asserts for input to be checked by default. This option can't be used when Indeterminate is set to true.

Indeterminate bool? (optional) Added in: v1.50#

断言元素处于不确定（混合）状态。仅支持复选框和单选按钮。当提供已选中时，此选项不能为真。

¥Asserts that the element is in the indeterminate (mixed) state. Only supported for checkboxes and radio buttons. This option can't be true when Checked is provided.

Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeDisabledAsync

Added in: v1.20

locatorAssertions.ToBeDisabledAsync

确保 Locator 指向禁用的元素。如果元素具有 "disabled" 属性或通过 'aria-disabled' 禁用，则该元素将被禁用。请注意，只有 HTML button、input、select、textarea、option、optgroup 等原生控制元素可以通过设置 "disabled" 属性来禁用。其他元素上的 "disabled" 属性将被浏览器忽略。

¥Ensures the Locator points to a disabled element. Element is disabled if it has "disabled" attribute or is disabled via 'aria-disabled'. Note that only native control elements such as HTML button, input, select, textarea, option, optgroup can be disabled by setting "disabled" attribute. "disabled" attribute on other elements is ignored by the browser.

用法

¥Usage

var locator = Page.Locator("button.submit");
await Expect(locator).ToBeDisabledAsync();

参数

¥Arguments

options LocatorAssertionsToBeDisabledOptions?（可选）

¥options LocatorAssertionsToBeDisabledOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeEditableAsync

Added in: v1.20

locatorAssertions.ToBeEditableAsync

确保 Locator 指向可编辑元素。

¥Ensures the Locator points to an editable element.

用法

¥Usage

var locator = Page.GetByRole(AriaRole.Textbox);
await Expect(locator).ToBeEditableAsync();

参数

¥Arguments

options LocatorAssertionsToBeEditableOptions?（可选）

¥options LocatorAssertionsToBeEditableOptions? (optional)
- Editable bool? (optional) Added in: v1.26#
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeEmptyAsync

Added in: v1.20

locatorAssertions.ToBeEmptyAsync

确保 Locator 指向空的可编辑元素或没有文本的 DOM 节点。

¥Ensures the Locator points to an empty editable element or to a DOM node that has no text.

用法

¥Usage

var locator = Page.Locator("div.warning");
await Expect(locator).ToBeEmptyAsync();

参数

¥Arguments

options LocatorAssertionsToBeEmptyOptions?（可选）

¥options LocatorAssertionsToBeEmptyOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeEnabledAsync

Added in: v1.20

locatorAssertions.ToBeEnabledAsync

确保 Locator 指向启用的元素。

¥Ensures the Locator points to an enabled element.

用法

¥Usage

var locator = Page.Locator("button.submit");
await Expect(locator).ToBeEnabledAsync();

参数

¥Arguments

options LocatorAssertionsToBeEnabledOptions?（可选）

¥options LocatorAssertionsToBeEnabledOptions? (optional)
- Enabled bool? (optional) Added in: v1.26#
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeFocusedAsync

Added in: v1.20

locatorAssertions.ToBeFocusedAsync

确保 Locator 指向焦点 DOM 节点。

¥Ensures the Locator points to a focused DOM node.

用法

¥Usage

var locator = Page.GetByRole(AriaRole.Textbox);
await Expect(locator).ToBeFocusedAsync();

参数

¥Arguments

options LocatorAssertionsToBeFocusedOptions?（可选）

¥options LocatorAssertionsToBeFocusedOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeHiddenAsync

Added in: v1.20

locatorAssertions.ToBeHiddenAsync

确保 Locator 不解析为任何 DOM 节点，或者解析为 non-visible 节点。

¥Ensures that Locator either does not resolve to any DOM node, or resolves to a non-visible one.

用法

¥Usage

var locator = Page.Locator(".my-element");
await Expect(locator).ToBeHiddenAsync();

参数

¥Arguments

options LocatorAssertionsToBeHiddenOptions?（可选）

¥options LocatorAssertionsToBeHiddenOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeInViewportAsync

Added in: v1.31

locatorAssertions.ToBeInViewportAsync

根据交集监视器 API，确保 Locator 指向与视口相交的元素。

¥Ensures the Locator points to an element that intersects viewport, according to the intersection observer API.

用法

¥Usage

var locator = Page.GetByRole(AriaRole.Button);
// Make sure at least some part of element intersects viewport.
await Expect(locator).ToBeInViewportAsync();
// Make sure element is fully outside of viewport.
await Expect(locator).Not.ToBeInViewportAsync();
// Make sure that at least half of the element intersects viewport.
await Expect(locator).ToBeInViewportAsync(new() { Ratio = 0.5 });

参数

¥Arguments

options LocatorAssertionsToBeInViewportOptions?（可选）

¥options LocatorAssertionsToBeInViewportOptions? (optional)
- Ratio [float]? (optional)#

元素与相交视口的最小比率。如果等于 0，则元素应以任意正比率与视口相交。默认为 0。

¥The minimal ratio of the element to intersect viewport. If equals to 0, then element should intersect viewport at any positive ratio. Defaults to 0.

Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToBeVisibleAsync

Added in: v1.20

locatorAssertions.ToBeVisibleAsync

确保 Locator 指向附加的 visible DOM 节点。

¥Ensures that Locator points to an attached and visible DOM node.

要检查列表中至少有一个元素可见，请使用 Locator.First。

¥To check that at least one element from the list is visible, use Locator.First.

用法

¥Usage

// A specific element is visible.
await Expect(Page.GetByText("Welcome")).ToBeVisibleAsync();

// At least one item in the list is visible.
await Expect(Page.GetByTestId("todo-item").First).ToBeVisibleAsync();

// At least one of the two elements is visible, possibly both.
await Expect(
  Page.GetByRole(AriaRole.Button, new() { Name = "Sign in" })
    .Or(Page.GetByRole(AriaRole.Button, new() { Name = "Sign up" }))
    .First
).ToBeVisibleAsync();

参数

¥Arguments

options LocatorAssertionsToBeVisibleOptions?（可选）

¥options LocatorAssertionsToBeVisibleOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

Visible bool? (optional) Added in: v1.26#

¥Returns

void #

ToContainClassAsync

Added in: v1.52

locatorAssertions.ToContainClassAsync

确保 Locator 指向具有给定 CSS 类的元素。所有来自断言值的类（以空格分隔）必须以任意顺序出现在 Element.classList 中。

¥Ensures the Locator points to an element with given CSS classes. All classes from the asserted value, separated by spaces, must be present in the Element.classList in any order.

用法

¥Usage

<div class='middle selected row' id='component'></div>

var locator = Page.Locator("#component");
await Expect(locator).ToContainClassAsync("middle selected row");
await Expect(locator).ToContainClassAsync("selected");
await Expect(locator).ToContainClassAsync("row middle");

传递数组时，该方法会断言所定位的元素列表与相应的预期类列表匹配。每个元素的 class 属性都会与数组中对应的类进行匹配：

¥When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class lists. Each element's class attribute is matched against the corresponding class in the array:

<div class='list'></div>
  <div class='component inactive'></div>
  <div class='component active'></div>
  <div class='component inactive'></div>
</div>

var locator = Page.Locator("list > .component");
await Expect(locator).ToContainClassAsync(new string[]{"inactive", "active", "inactive"});

参数

¥Arguments

expected string | IEnumerable<string>#

包含预期类名的字符串（以空格分隔），或用于断言多个元素的此类字符串列表。

¥A string containing expected class names, separated by spaces, or a list of such strings to assert multiple elements.

options LocatorAssertionsToContainClassOptions?（可选）

¥options LocatorAssertionsToContainClassOptions? (optional)
- Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToContainTextAsync

Added in: v1.20

locatorAssertions.ToContainTextAsync

确保 Locator 指向包含给定文本的元素。计算元素的文本内容时将考虑所有嵌套元素。你也可以使用正则表达式作为值。

¥Ensures the Locator points to an element that contains the given text. All nested elements will be considered when computing the text content of the element. You can use regular expressions for the value as well.

用法

¥Usage

var locator = Page.Locator(".title");
await Expect(locator).ToContainTextAsync("substring");
await Expect(locator).ToContainTextAsync(new Regex("\\d messages"));

如果你传递一个数组作为期望值，则期望为：

¥If you pass an array as an expected value, the expectations are:

定位器解析为元素列表。

¥Locator resolves to a list of elements.
该列表子集中的元素分别包含预期数组中的文本。

¥Elements from a subset of this list contain text from the expected array, respectively.
匹配的元素子集与预期数组具有相同的顺序。

¥The matching subset of elements has the same order as the expected array.
预期数组中的每个文本值都与列表中的某个元素匹配。

¥Each text value from the expected array is matched by some element from the list.

例如，考虑以下列表：

¥For example, consider the following list:

<ul>
  <li>Item Text 1</li>
  <li>Item Text 2</li>
  <li>Item Text 3</li>
</ul>

让我们看看如何使用断言：

¥Let's see how we can use the assertion:

// ✓ Contains the right items in the right order
await Expect(Page.Locator("ul > li")).ToContainTextAsync(new string[] {"Text 1", "Text 3", "Text 4"});

// ✖ Wrong order
await Expect(Page.Locator("ul > li")).ToContainTextAsync(new string[] {"Text 3", "Text 2"});

// ✖ No item contains this text
await Expect(Page.Locator("ul > li")).ToContainTextAsync(new string[] {"Some 33"});

// ✖ Locator points to the outer list element, not to the list items
await Expect(Page.Locator("ul")).ToContainTextAsync(new string[] {"Text 3"});

参数

¥Arguments

expected string | Regex | IEnumerable<string> | IEnumerable<Regex> Added in: v1.18#

预期的子字符串或正则表达式或这些的列表。

¥Expected substring or RegExp or a list of those.

options LocatorAssertionsToContainTextOptions?（可选）

¥options LocatorAssertionsToContainTextOptions? (optional)
- IgnoreCase bool? (optional) Added in: v1.23#

是否进行不区分大小写的匹配。如果指定，IgnoreCase 选项优先于相应的正则表达式标志。

¥Whether to perform case-insensitive match. IgnoreCase option takes precedence over the corresponding regular expression flag if specified.

Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

UseInnerText bool? (optional) Added in: v1.18#

检索 DOM 节点文本时是否使用 element.innerText 而不是 element.textContent。

¥Whether to use element.innerText instead of element.textContent when retrieving DOM node text.

¥Returns

void #

细节

¥Details

当 expected 参数是字符串时，Playwright 将在匹配之前规范实际文本和预期字符串中的空格和换行符。使用正则表达式时，实际文本将按原样进行匹配。

¥When expected parameter is a string, Playwright will normalize whitespaces and line breaks both in the actual text and in the expected string before matching. When regular expression is used, the actual text is matched as is.

ToHaveAccessibleDescriptionAsync

Added in: v1.44

locatorAssertions.ToHaveAccessibleDescriptionAsync

确保 Locator 指向具有给定可访问描述的元素。

¥Ensures the Locator points to an element with a given accessible description.

用法

¥Usage

var locator = Page.GetByTestId("save-button");
await Expect(locator).ToHaveAccessibleDescriptionAsync("Save results to disk");

参数

¥Arguments

description string | Regex #

预期可访问描述。

¥Expected accessible description.

options LocatorAssertionsToHaveAccessibleDescriptionOptions?（可选）

¥options LocatorAssertionsToHaveAccessibleDescriptionOptions? (optional)
- IgnoreCase bool? (optional)#

是否进行不区分大小写的匹配。如果指定，IgnoreCase 选项优先于相应的正则表达式标志。

¥Whether to perform case-insensitive match. IgnoreCase option takes precedence over the corresponding regular expression flag if specified.

Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveAccessibleErrorMessageAsync

Added in: v1.50

locatorAssertions.ToHaveAccessibleErrorMessageAsync

确保 Locator 指向具有给定咏叹调错误消息的元素。

¥Ensures the Locator points to an element with a given aria errormessage.

用法

¥Usage

var locator = Page.GetByTestId("username-input");
await Expect(locator).ToHaveAccessibleErrorMessageAsync("Username is required.");

参数

¥Arguments

errorMessage string | Regex #

预期可访问的错误消息。

¥Expected accessible error message.

options LocatorAssertionsToHaveAccessibleErrorMessageOptions?（可选）

¥options LocatorAssertionsToHaveAccessibleErrorMessageOptions? (optional)
- IgnoreCase bool? (optional)#

是否进行不区分大小写的匹配。如果指定，IgnoreCase 选项优先于相应的正则表达式标志。

¥Whether to perform case-insensitive match. IgnoreCase option takes precedence over the corresponding regular expression flag if specified.

Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveAccessibleNameAsync

Added in: v1.44

locatorAssertions.ToHaveAccessibleNameAsync

确保 Locator 指向具有给定可访问的名称的元素。

¥Ensures the Locator points to an element with a given accessible name.

用法

¥Usage

var locator = Page.GetByTestId("save-button");
await Expect(locator).ToHaveAccessibleNameAsync("Save to disk");

参数

¥Arguments

name string | Regex #

预期可访问名称。

¥Expected accessible name.

options LocatorAssertionsToHaveAccessibleNameOptions?（可选）

¥options LocatorAssertionsToHaveAccessibleNameOptions? (optional)
- IgnoreCase bool? (optional)#

是否进行不区分大小写的匹配。如果指定，IgnoreCase 选项优先于相应的正则表达式标志。

¥Whether to perform case-insensitive match. IgnoreCase option takes precedence over the corresponding regular expression flag if specified.

Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveAttributeAsync

Added in: v1.20

locatorAssertions.ToHaveAttributeAsync

确保 Locator 指向具有给定属性的元素。

¥Ensures the Locator points to an element with given attribute.

用法

¥Usage

var locator = Page.Locator("input");
await Expect(locator).ToHaveAttributeAsync("type", "text");

参数

¥Arguments

name string Added in: v1.18#

属性名称。

¥Attribute name.

value string | Regex Added in: v1.18#

期望的属性值。

¥Expected attribute value.

options LocatorAssertionsToHaveAttributeOptions?（可选）

¥options LocatorAssertionsToHaveAttributeOptions? (optional)
- IgnoreCase bool? (optional) Added in: v1.40#

是否进行不区分大小写的匹配。如果指定，IgnoreCase 选项优先于相应的正则表达式标志。

¥Whether to perform case-insensitive match. IgnoreCase option takes precedence over the corresponding regular expression flag if specified.

Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveClassAsync

Added in: v1.20

locatorAssertions.ToHaveClassAsync

确保 Locator 指向具有给定 CSS 类的元素。当提供字符串时，它必须与元素的 class 属性完全匹配。要匹配单个类，请使用 Expect(Locator).ToContainClassAsync()。

¥Ensures the Locator points to an element with given CSS classes. When a string is provided, it must fully match the element's class attribute. To match individual classes use Expect(Locator).ToContainClassAsync().

用法

¥Usage

<div class='middle selected row' id='component'></div>

var locator = Page.Locator("#component");
await Expect(locator).ToHaveClassAsync("middle selected row");
await Expect(locator).ToHaveClassAsync(new Regex("(^|\\s)selected(\\s|$)"));

当传递数组时，该方法断言所定位的元素列表与相应的预期类值列表匹配。每个元素的类属性都与数组中相应的字符串或正则表达式匹配：

¥When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class values. Each element's class attribute is matched against the corresponding string or regular expression in the array:

var locator = Page.Locator("list > .component");
await Expect(locator).ToHaveClassAsync(new string[]{"component", "component selected", "component"});

参数

¥Arguments

expected string | Regex | IEnumerable<string> | IEnumerable<Regex> Added in: v1.18#

预期的类或 RegExp 或这些的列表。

¥Expected class or RegExp or a list of those.

options LocatorAssertionsToHaveClassOptions?（可选）

¥options LocatorAssertionsToHaveClassOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveCountAsync

Added in: v1.20

locatorAssertions.ToHaveCountAsync

确保 Locator 解析为确切数量的 DOM 节点。

¥Ensures the Locator resolves to an exact number of DOM nodes.

用法

¥Usage

var locator = Page.Locator("list > .component");
await Expect(locator).ToHaveCountAsync(3);

参数

¥Arguments

count int Added in: v1.18#

预期计数。

¥Expected count.

options LocatorAssertionsToHaveCountOptions?（可选）

¥options LocatorAssertionsToHaveCountOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveCSSAsync

Added in: v1.20

locatorAssertions.ToHaveCSSAsync

确保 Locator 解析为具有给定计算 CSS 样式的元素。

¥Ensures the Locator resolves to an element with the given computed CSS style.

用法

¥Usage

var locator = Page.GetByRole(AriaRole.Button);
await Expect(locator).ToHaveCSSAsync("display", "flex");

参数

¥Arguments

name string Added in: v1.18#

CSS 属性名称。

¥CSS property name.

value string | Regex Added in: v1.18#

CSS 属性值。

¥CSS property value.

options LocatorAssertionsToHaveCSSOptions?（可选）

¥options LocatorAssertionsToHaveCSSOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveIdAsync

Added in: v1.20

locatorAssertions.ToHaveIdAsync

确保 Locator 指向具有给定 DOM 节点 ID 的元素。

¥Ensures the Locator points to an element with the given DOM Node ID.

用法

¥Usage

var locator = Page.GetByRole(AriaRole.Textbox);
await Expect(locator).ToHaveIdAsync("lastname");

参数

¥Arguments

id string | Regex Added in: v1.18#

元素 ID。

¥Element id.

options LocatorAssertionsToHaveIdOptions?（可选）

¥options LocatorAssertionsToHaveIdOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveJSPropertyAsync

Added in: v1.20

locatorAssertions.ToHaveJSPropertyAsync

确保 Locator 指向具有给定 JavaScript 属性的元素。请注意，此属性可以是原始类型，也可以是普通的可序列化 JavaScript 对象。

¥Ensures the Locator points to an element with given JavaScript property. Note that this property can be of a primitive type as well as a plain serializable JavaScript object.

用法

¥Usage

var locator = Page.Locator(".component");
await Expect(locator).ToHaveJSPropertyAsync("loaded", true);

参数

¥Arguments

name string Added in: v1.18#

属性名称。

¥Property name.

value [object] Added in: v1.18#

属性值

¥Property value.

options LocatorAssertionsToHaveJSPropertyOptions?（可选）

¥options LocatorAssertionsToHaveJSPropertyOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveRoleAsync

Added in: v1.44

locatorAssertions.ToHaveRoleAsync

确保 Locator 指向具有给定 ARIA 角色的元素。

¥Ensures the Locator points to an element with a given ARIA role.

请注意，角色匹配为字符串，忽略 ARIA 角色层次结构。例如，在具有子类角色 "switch" 的元素上断言超类角色 "checkbox" 将失败。

¥Note that role is matched as a string, disregarding the ARIA role hierarchy. For example, asserting a superclass role "checkbox" on an element with a subclass role "switch" will fail.

用法

¥Usage

var locator = Page.GetByTestId("save-button");
await Expect(locator).ToHaveRoleAsync(AriaRole.Button);

参数

¥Arguments

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 }#

所需的咏叹调角色。

¥Required aria role.
options LocatorAssertionsToHaveRoleOptions?（可选）

¥options LocatorAssertionsToHaveRoleOptions? (optional)
- Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveTextAsync

Added in: v1.20

locatorAssertions.ToHaveTextAsync

确保 Locator 指向具有给定文本的元素。计算元素的文本内容时将考虑所有嵌套元素。你也可以使用正则表达式作为值。

¥Ensures the Locator points to an element with the given text. All nested elements will be considered when computing the text content of the element. You can use regular expressions for the value as well.

用法

¥Usage

var locator = Page.Locator(".title");
await Expect(locator).ToHaveTextAsync(new Regex("Welcome, Test User"));
await Expect(locator).ToHaveTextAsync(new Regex("Welcome, .*"));

如果你传递一个数组作为期望值，则期望为：

¥If you pass an array as an expected value, the expectations are:

定位器解析为元素列表。

¥Locator resolves to a list of elements.
元素的数量等于数组中期望值的数量。

¥The number of elements equals the number of expected values in the array.
列表中的元素具有按顺序一一匹配预期数组值的文本。

¥Elements from the list have text matching expected array values, one by one, in order.

例如，考虑以下列表：

¥For example, consider the following list:

<ul>
  <li>Text 1</li>
  <li>Text 2</li>
  <li>Text 3</li>
</ul>

让我们看看如何使用断言：

¥Let's see how we can use the assertion:

// ✓ Has the right items in the right order
await Expect(Page.Locator("ul > li")).ToHaveTextAsync(new string[] {"Text 1", "Text 2", "Text 3"});

// ✖ Wrong order
await Expect(Page.Locator("ul > li")).ToHaveTextAsync(new string[] {"Text 3", "Text 2", "Text 1"});

// ✖ Last item does not match
await Expect(Page.Locator("ul > li")).ToHaveTextAsync(new string[] {"Text 1", "Text 2", "Text"});

// ✖ Locator points to the outer list element, not to the list items
await Expect(Page.Locator("ul")).ToHaveTextAsync(new string[] {"Text 1", "Text 2", "Text 3"});

参数

¥Arguments

expected string | Regex | IEnumerable<string> | IEnumerable<Regex> Added in: v1.18#

预期的字符串或正则表达式或它们的列表。

¥Expected string or RegExp or a list of those.

options LocatorAssertionsToHaveTextOptions?（可选）

¥options LocatorAssertionsToHaveTextOptions? (optional)
- IgnoreCase bool? (optional) Added in: v1.23#

是否进行不区分大小写的匹配。如果指定，IgnoreCase 选项优先于相应的正则表达式标志。

¥Whether to perform case-insensitive match. IgnoreCase option takes precedence over the corresponding regular expression flag if specified.

Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

UseInnerText bool? (optional) Added in: v1.18#

检索 DOM 节点文本时是否使用 element.innerText 而不是 element.textContent。

¥Whether to use element.innerText instead of element.textContent when retrieving DOM node text.

¥Returns

void #

细节

¥Details

当 expected 参数是字符串时，Playwright 将在匹配之前规范实际文本和预期字符串中的空格和换行符。使用正则表达式时，实际文本将按原样进行匹配。

ToHaveValueAsync

Added in: v1.20

locatorAssertions.ToHaveValueAsync

确保 Locator 指向具有给定输入值的元素。你也可以使用正则表达式作为值。

¥Ensures the Locator points to an element with the given input value. You can use regular expressions for the value as well.

用法

¥Usage

var locator = Page.Locator("input[type=number]");
await Expect(locator).ToHaveValueAsync(new Regex("[0-9]"));

参数

¥Arguments

value string | Regex Added in: v1.18#

期望值。

¥Expected value.

options LocatorAssertionsToHaveValueOptions?（可选）

¥options LocatorAssertionsToHaveValueOptions? (optional)
- Timeout [float]? (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToHaveValuesAsync

Added in: v1.23

locatorAssertions.ToHaveValuesAsync

确保 Locator 指向多选/组合框（即具有 multiple 属性的 select）并且选择指定的值。

¥Ensures the Locator points to multi-select/combobox (i.e. a select with the multiple attribute) and the specified values are selected.

用法

¥Usage

例如，给定以下元素：

¥For example, given the following element:

<select id="favorite-colors" multiple>
  <option value="R">Red</option>
  <option value="G">Green</option>
  <option value="B">Blue</option>
</select>

var locator = Page.Locator("id=favorite-colors");
await locator.SelectOptionAsync(new string[] { "R", "G" });
await Expect(locator).ToHaveValuesAsync(new Regex[] { new Regex("R"), new Regex("G") });

参数

¥Arguments

values IEnumerable<string> | IEnumerable<Regex>#

当前选择的预期选项。

¥Expected options currently selected.

options LocatorAssertionsToHaveValuesOptions?（可选）

¥options LocatorAssertionsToHaveValuesOptions? (optional)
- Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

ToMatchAriaSnapshotAsync

Added in: v1.49

locatorAssertions.ToMatchAriaSnapshotAsync

断言目标元素与给定的可访问性快照匹配。

¥Asserts that the target element matches the given accessibility snapshot.

用法

¥Usage

await page.GotoAsync("https://demo.playwright.dev/todomvc/");
await Expect(page.Locator("body")).ToMatchAriaSnapshotAsync(@"
  - heading ""todos""
  - textbox ""What needs to be done?""
");

参数

¥Arguments

expected string #

options LocatorAssertionsToMatchAriaSnapshotOptions?（可选）

¥options LocatorAssertionsToMatchAriaSnapshotOptions? (optional)
- Timeout [float]? (optional)#

重试断言的时间（以毫秒为单位）。默认为 5000。

¥Time to retry the assertion for in milliseconds. Defaults to 5000.

¥Returns

void #

属性

¥Properties

否

¥Not

Added in: v1.20

locatorAssertions.Not

使断言检查相反的条件。例如，此代码测试定位器不包含文本 "error"：

¥Makes the assertion check for the opposite condition. For example, this code tests that the Locator doesn't contain text "error":

await Expect(locator).Not.ToContainTextAsync("error");

用法

¥Usage

Expect(Locator).Not

类型

¥Type

LocatorAssertions

方法​

ToBeAttachedAsync​

ToBeCheckedAsync​

ToBeDisabledAsync​

ToBeEditableAsync​

ToBeEmptyAsync​

ToBeEnabledAsync​

ToBeFocusedAsync​

ToBeHiddenAsync​

ToBeInViewportAsync​

ToBeVisibleAsync​

ToContainClassAsync​

ToContainTextAsync​

ToHaveAccessibleDescriptionAsync​

ToHaveAccessibleErrorMessageAsync​

ToHaveAccessibleNameAsync​

ToHaveAttributeAsync​

ToHaveClassAsync​

ToHaveCountAsync​

ToHaveCSSAsync​

ToHaveIdAsync​

ToHaveJSPropertyAsync​

ToHaveRoleAsync​

ToHaveTextAsync​

ToHaveValueAsync​

ToHaveValuesAsync​

ToMatchAriaSnapshotAsync​

属性​

否​

方法

ToBeAttachedAsync

ToBeCheckedAsync

ToBeDisabledAsync

ToBeEditableAsync

ToBeEmptyAsync

ToBeEnabledAsync

ToBeFocusedAsync

ToBeHiddenAsync

ToBeInViewportAsync

ToBeVisibleAsync

ToContainClassAsync

ToContainTextAsync

ToHaveAccessibleDescriptionAsync

ToHaveAccessibleErrorMessageAsync

ToHaveAccessibleNameAsync

ToHaveAttributeAsync

ToHaveClassAsync

ToHaveCountAsync

ToHaveCSSAsync

ToHaveIdAsync

ToHaveJSPropertyAsync

ToHaveRoleAsync

ToHaveTextAsync

ToHaveValueAsync

ToHaveValuesAsync

ToMatchAriaSnapshotAsync

属性

否