LocatorAssertions

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

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

// ...
import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;

public class TestLocator {
  // ...
  @Test
  void statusBecomesSubmitted() {
    // ...
    page.getByRole(AriaRole.BUTTON).click();
    assertThat(page.locator(".status")).hasText("Submitted");
  }
}

方法

¥Methods

containsClass

Added in: v1.52

locatorAssertions.containsClass

确保 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>

assertThat(page.locator("#component")).containsClass("middle selected row");
assertThat(page.locator("#component")).containsClass("selected");
assertThat(page.locator("#component")).containsClass("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>

assertThat(page.locator("list > .component")).containsClass(new String[] {"inactive", "active", "inactive"});

参数

¥Arguments

expected String | List<String>#

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

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

options LocatorAssertions.ContainsClassOptions（可选）

¥options LocatorAssertions.ContainsClassOptions (optional)
- setTimeout double (optional)#

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

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

¥Returns

void #

containsText

Added in: v1.20

locatorAssertions.containsText

确保 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

assertThat(page.locator(".title")).containsText("substring");

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

¥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
assertThat(page.locator("ul > li")).containsText(new String[] {"Text 1", "Text 3", "Text 4"});

// ✖ Wrong order
assertThat(page.locator("ul > li")).containsText(new String[] {"Text 3", "Text 2"});

// ✖ No item contains this text
assertThat(page.locator("ul > li")).containsText(new String[] {"Some 33"});

// ✖ Locator points to the outer list element, not to the list items
assertThat(page.locator("ul")).containsText(new String[] {"Text 3"});

参数

¥Arguments

expected String | Pattern | String[] | Pattern[] Added in: v1.18#

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

¥Expected substring or RegExp or a list of those.

options LocatorAssertions.ContainsTextOptions（可选）

¥options LocatorAssertions.ContainsTextOptions (optional)
- setIgnoreCase boolean (optional) Added in: v1.23#

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

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

setTimeout double (optional) Added in: v1.18#

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

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

setUseInnerText boolean (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.

hasAccessibleDescription

Added in: v1.44

locatorAssertions.hasAccessibleDescription

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

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

用法

¥Usage

Locator locator = page.getByTestId("save-button");
assertThat(locator).hasAccessibleDescription("Save results to disk");

参数

¥Arguments

description String | Pattern #

预期可访问描述。

¥Expected accessible description.

options LocatorAssertions.HasAccessibleDescriptionOptions（可选）

¥options LocatorAssertions.HasAccessibleDescriptionOptions (optional)
- setIgnoreCase boolean (optional)#

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

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

setTimeout double (optional)#

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

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

¥Returns

void #

hasAccessibleErrorMessage

Added in: v1.50

locatorAssertions.hasAccessibleErrorMessage

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

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

用法

¥Usage

Locator locator = page.getByTestId("username-input");
assertThat(locator).hasAccessibleErrorMessage("Username is required.");

参数

¥Arguments

errorMessage String | Pattern #

预期可访问的错误消息。

¥Expected accessible error message.

options LocatorAssertions.HasAccessibleErrorMessageOptions（可选）

¥options LocatorAssertions.HasAccessibleErrorMessageOptions (optional)
- setIgnoreCase boolean (optional)#

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

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

setTimeout double (optional)#

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

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

¥Returns

void #

hasAccessibleName

Added in: v1.44

locatorAssertions.hasAccessibleName

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

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

用法

¥Usage

Locator locator = page.getByTestId("save-button");
assertThat(locator).hasAccessibleName("Save to disk");

参数

¥Arguments

name String | Pattern #

预期可访问名称。

¥Expected accessible name.

options LocatorAssertions.HasAccessibleNameOptions（可选）

¥options LocatorAssertions.HasAccessibleNameOptions (optional)
- setIgnoreCase boolean (optional)#

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

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

setTimeout double (optional)#

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

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

¥Returns

void #

hasAttribute

Added in: v1.20

locatorAssertions.hasAttribute

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

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

用法

¥Usage

assertThat(page.locator("input")).hasAttribute("type", "text");

参数

¥Arguments

name String Added in: v1.18#

属性名称。

¥Attribute name.

value String | Pattern Added in: v1.18#

期望的属性值。

¥Expected attribute value.

options LocatorAssertions.HasAttributeOptions（可选）

¥options LocatorAssertions.HasAttributeOptions (optional)
- setIgnoreCase boolean (optional) Added in: v1.40#

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

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

setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

hasClass

Added in: v1.20

locatorAssertions.hasClass

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

¥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 assertThat(locator).containsClass().

用法

¥Usage

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

assertThat(page.locator("#component")).hasClass("middle selected row");
assertThat(page.locator("#component")).hasClass(Pattern.compile("(^|\\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:

assertThat(page.locator("list > .component")).hasClass(new String[] {"component", "component selected", "component"});

参数

¥Arguments

expected String | Pattern | String[] | Pattern[] Added in: v1.18#

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

¥Expected class or RegExp or a list of those.

options LocatorAssertions.HasClassOptions（可选）

¥options LocatorAssertions.HasClassOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

hasCount

Added in: v1.20

locatorAssertions.hasCount

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

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

用法

¥Usage

assertThat(page.locator("list > .component")).hasCount(3);

参数

¥Arguments

count int Added in: v1.18#

预期计数。

¥Expected count.

options LocatorAssertions.HasCountOptions（可选）

¥options LocatorAssertions.HasCountOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

hasCSS

Added in: v1.20

locatorAssertions.hasCSS

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

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

用法

¥Usage

assertThat(page.getByRole(AriaRole.BUTTON)).hasCSS("display", "flex");

参数

¥Arguments

name String Added in: v1.18#

CSS 属性名称。

¥CSS property name.

value String | Pattern Added in: v1.18#

CSS 属性值。

¥CSS property value.

options LocatorAssertions.HasCSSOptions（可选）

¥options LocatorAssertions.HasCSSOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

hasId

Added in: v1.20

locatorAssertions.hasId

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

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

用法

¥Usage

assertThat(page.getByRole(AriaRole.TEXTBOX)).hasId("lastname");

参数

¥Arguments

id String | Pattern Added in: v1.18#

元素 ID。

¥Element id.

options LocatorAssertions.HasIdOptions（可选）

¥options LocatorAssertions.HasIdOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

hasJSProperty

Added in: v1.20

locatorAssertions.hasJSProperty

确保 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

assertThat(page.locator("input")).hasJSProperty("loaded", true);

参数

¥Arguments

name String Added in: v1.18#

属性名称。

¥Property name.

value Object Added in: v1.18#

属性值

¥Property value.

options LocatorAssertions.HasJSPropertyOptions（可选）

¥options LocatorAssertions.HasJSPropertyOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

hasRole

Added in: v1.44

locatorAssertions.hasRole

确保 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

Locator locator = page.getByTestId("save-button");
assertThat(locator).hasRole(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 LocatorAssertions.HasRoleOptions（可选）

¥options LocatorAssertions.HasRoleOptions (optional)
- setTimeout double (optional)#

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

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

¥Returns

void #

hasText

Added in: v1.20

locatorAssertions.hasText

确保 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

assertThat(page.locator(".title")).hasText("Welcome, Test User");
assertThat(page.locator(".title")).hasText(Pattern.compile("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
assertThat(page.locator("ul > li")).hasText(new String[] {"Text 1", "Text 2", "Text 3"});

// ✖ Wrong order
assertThat(page.locator("ul > li")).hasText(new String[] {"Text 3", "Text 2", "Text 1"});

// ✖ Last item does not match
assertThat(page.locator("ul > li")).hasText(new String[] {"Text 1", "Text 2", "Text"});

// ✖ Locator points to the outer list element, not to the list items
assertThat(page.locator("ul")).hasText(new String[] {"Text 1", "Text 2", "Text 3"});

参数

¥Arguments

expected String | Pattern | String[] | Pattern[] Added in: v1.18#

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

¥Expected string or RegExp or a list of those.

options LocatorAssertions.HasTextOptions（可选）

¥options LocatorAssertions.HasTextOptions (optional)
- setIgnoreCase boolean (optional) Added in: v1.23#

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

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

setTimeout double (optional) Added in: v1.18#

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

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

setUseInnerText boolean (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 将在匹配之前规范实际文本和预期字符串中的空格和换行符。使用正则表达式时，实际文本将按原样进行匹配。

hasValue

Added in: v1.20

locatorAssertions.hasValue

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

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

用法

¥Usage

assertThat(page.locator("input[type=number]")).hasValue(Pattern.compile("[0-9]"));

参数

¥Arguments

value String | Pattern Added in: v1.18#

期望值。

¥Expected value.

options LocatorAssertions.HasValueOptions（可选）

¥options LocatorAssertions.HasValueOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

hasValues

Added in: v1.23

locatorAssertions.hasValues

确保 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>

page.locator("id=favorite-colors").selectOption(new String[]{"R", "G"});
assertThat(page.locator("id=favorite-colors")).hasValues(new Pattern[] { Pattern.compile("R"), Pattern.compile("G") });

参数

¥Arguments

values String[] | Pattern[]#

当前选择的预期选项。

¥Expected options currently selected.

options LocatorAssertions.HasValuesOptions（可选）

¥options LocatorAssertions.HasValuesOptions (optional)
- setTimeout double (optional)#

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

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

¥Returns

void #

isAttached

Added in: v1.33

locatorAssertions.isAttached

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

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

用法

¥Usage

assertThat(page.getByText("Hidden text")).isAttached();

参数

¥Arguments

options LocatorAssertions.IsAttachedOptions（可选）

¥options LocatorAssertions.IsAttachedOptions (optional)
- setAttached boolean (optional)#
- setTimeout double (optional)#

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

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

¥Returns

void #

isChecked

Added in: v1.20

locatorAssertions.isChecked

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

¥Ensures the Locator points to a checked input.

用法

¥Usage

assertThat(page.getByLabel("Subscribe to newsletter")).isChecked();

参数

¥Arguments

options LocatorAssertions.IsCheckedOptions（可选）

¥options LocatorAssertions.IsCheckedOptions (optional)
- setChecked boolean (optional) Added in: v1.18#

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

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

setIndeterminate boolean (optional) Added in: v1.50#

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

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

setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

isDisabled

Added in: v1.20

locatorAssertions.isDisabled

确保 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

assertThat(page.locator("button.submit")).isDisabled();

参数

¥Arguments

options LocatorAssertions.IsDisabledOptions（可选）

¥options LocatorAssertions.IsDisabledOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

isEditable

Added in: v1.20

locatorAssertions.isEditable

确保 Locator 指向可编辑元素。

¥Ensures the Locator points to an editable element.

用法

¥Usage

assertThat(page.getByRole(AriaRole.TEXTBOX)).isEditable();

参数

¥Arguments

options LocatorAssertions.IsEditableOptions（可选）

¥options LocatorAssertions.IsEditableOptions (optional)
- setEditable boolean (optional) Added in: v1.26#
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

isEmpty

Added in: v1.20

locatorAssertions.isEmpty

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

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

用法

¥Usage

assertThat(page.locator("div.warning")).isEmpty();

参数

¥Arguments

options LocatorAssertions.IsEmptyOptions（可选）

¥options LocatorAssertions.IsEmptyOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

isEnabled

Added in: v1.20

locatorAssertions.isEnabled

确保 Locator 指向启用的元素。

¥Ensures the Locator points to an enabled element.

用法

¥Usage

assertThat(page.locator("button.submit")).isEnabled();

参数

¥Arguments

options LocatorAssertions.IsEnabledOptions（可选）

¥options LocatorAssertions.IsEnabledOptions (optional)
- setEnabled boolean (optional) Added in: v1.26#
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

isFocused

Added in: v1.20

locatorAssertions.isFocused

确保 Locator 指向焦点 DOM 节点。

¥Ensures the Locator points to a focused DOM node.

用法

¥Usage

assertThat(page.getByRole(AriaRole.TEXTBOX)).isFocused();

参数

¥Arguments

options LocatorAssertions.IsFocusedOptions（可选）

¥options LocatorAssertions.IsFocusedOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

isHidden

Added in: v1.20

locatorAssertions.isHidden

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

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

用法

¥Usage

assertThat(page.locator(".my-element")).isHidden();

参数

¥Arguments

options LocatorAssertions.IsHiddenOptions（可选）

¥options LocatorAssertions.IsHiddenOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

¥Returns

void #

isInViewport

Added in: v1.31

locatorAssertions.isInViewport

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

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

用法

¥Usage

Locator locator = page.getByRole(AriaRole.BUTTON);
// Make sure at least some part of element intersects viewport.
assertThat(locator).isInViewport();
// Make sure element is fully outside of viewport.
assertThat(locator).not().isInViewport();
// Make sure that at least half of the element intersects viewport.
assertThat(locator).isInViewport(new LocatorAssertions.IsInViewportOptions().setRatio(0.5));

参数

¥Arguments

options LocatorAssertions.IsInViewportOptions（可选）

¥options LocatorAssertions.IsInViewportOptions (optional)
- setRatio double (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.

setTimeout double (optional)#

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

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

¥Returns

void #

isVisible

Added in: v1.20

locatorAssertions.isVisible

确保 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.
assertThat(page.getByText("Welcome")).isVisible();

// At least one item in the list is visible.
assertThat(page.getByTestId("todo-item").first()).isVisible();

// At least one of the two elements is visible, possibly both.
assertThat(
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign in"))
    .or(page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign up")))
    .first()
).isVisible();

参数

¥Arguments

options LocatorAssertions.IsVisibleOptions（可选）

¥options LocatorAssertions.IsVisibleOptions (optional)
- setTimeout double (optional) Added in: v1.18#

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

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

setVisible boolean (optional) Added in: v1.26#

¥Returns

void #

matchesAriaSnapshot

Added in: v1.49

locatorAssertions.matchesAriaSnapshot

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

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

用法

¥Usage

page.navigate("https://demo.playwright.dev/todomvc/");
assertThat(page.locator("body")).matchesAriaSnapshot("""
  - heading "todos"
  - textbox "What needs to be done?"
""");

参数

¥Arguments

expected String #

options LocatorAssertions.MatchesAriaSnapshotOptions（可选）

¥options LocatorAssertions.MatchesAriaSnapshotOptions (optional)
- setTimeout double (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":

assertThat(locator).not().containsText("error");

用法

¥Usage

assertThat(locator).not()

¥Returns

LocatorAssertions

方法​

containsClass​

containsText​

hasAccessibleDescription​

hasAccessibleErrorMessage​

hasAccessibleName​

hasAttribute​

hasClass​

hasCount​

hasCSS​

hasId​

hasJSProperty​

hasRole​

hasText​

hasValue​

hasValues​

isAttached​

isChecked​

isDisabled​

isEditable​

isEmpty​

isEnabled​

isFocused​

isHidden​

isInViewport​

isVisible​

matchesAriaSnapshot​

属性​

not()​

方法

containsClass

containsText

hasAccessibleDescription

hasAccessibleErrorMessage

hasAccessibleName

hasAttribute

hasClass

hasCount

hasCSS

hasId

hasJSProperty

hasRole

hasText

hasValue

hasValues

isAttached

isChecked

isDisabled

isEditable

isEmpty

isEnabled

isFocused

isHidden

isInViewport

isVisible

matchesAriaSnapshot

属性

not()