Locator

Locators 是 Playwright 自动等待和可重试性的核心。简而言之，locators 代表着在任何时刻查找页面元素的方式。可以使用 Page.locator() 方法创建 locator。

了解更多关于 locators 的信息.

方法

all

添加于：v1.29

locator.all

当 locator 指向元素列表时，这将返回一个 locator 数组，指向它们各自的元素。

注意

Locator.all() 不会等待元素匹配 locator，而是立即返回页面中存在的任何内容。

当元素列表动态改变时，Locator.all() 将产生不可预测和不稳定的结果。

当元素列表稳定但动态加载时，请在调用 Locator.all() 之前等待整个列表加载完成。

用法

for (Locator li : page.getByRole("listitem").all())
  li.click();

返回值

List<Locator>#

allInnerTexts

添加于：v1.14

locator.allInnerTexts

返回所有匹配节点的 node.innerText 值数组。

断言文本

如果需要断言页面上的文本，请优先使用带有 setUseInnerText 选项的 assertThat(locator).hasText() 以避免不稳定性。更多详情请参阅断言指南。

用法

String[] texts = page.getByRole(AriaRole.LINK).allInnerTexts();

返回值

List<String>#

allTextContents

添加于：v1.14

locator.allTextContents

返回所有匹配节点的 node.textContent 值数组。

断言文本

如果需要断言页面上的文本，请优先使用 assertThat(locator).hasText() 以避免不稳定性。更多详情请参阅断言指南。

用法

String[] texts = page.getByRole(AriaRole.LINK).allTextContents();

返回值

List<String>#

and

添加于：v1.34

locator.and

创建一个同时匹配此 locator 和参数 locator 的 locator。

用法

以下示例查找具有特定标题的按钮。

Locator button = page.getByRole(AriaRole.BUTTON).and(page.getByTitle("Subscribe"));

参数

locator Locator #

需要匹配的附加 locator。

返回值

Locator #

ariaSnapshot

添加于：v1.49

locator.ariaSnapshot

捕获给定元素的 aria snapshot。阅读更多关于aria snapshots 以及用于相应断言的 assertThat(locator).matchesAriaSnapshot()。

用法

page.getByRole(AriaRole.LINK).ariaSnapshot();

参数

options Locator.AriaSnapshotOptions （可选）
- setRef boolean （可选）添加于：v1.52#
  
  为每个元素生成符号引用。在捕获快照后，可以使用 aria-ref=<ref> locator 立即对元素执行操作。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

String #

详情

此方法捕获给定元素的 aria snapshot。快照是一个字符串，表示元素及其子元素的状态。快照可用于在测试中断言元素的状态，或与未来的状态进行比较。

ARIA snapshot 使用 YAML 标记语言表示

对象的键是元素的角色和可选的可访问名称。
值可以是文本内容或子元素数组。
通用的静态文本可以使用 text 键表示。

下面是 HTML 标记和相应的 ARIA snapshot

<ul aria-label="Links">
  <li><a href="/">Home</a></li>
  <li><a href="/about">About</a></li>
<ul>

- list "Links":
  - listitem:
    - link "Home"
  - listitem:
    - link "About"

blur

添加于：v1.28

locator.blur

在元素上调用 blur。

用法

Locator.blur();
Locator.blur(options);

参数

options Locator.BlurOptions （可选）
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

boundingBox

添加于：v1.14

locator.boundingBox

此方法返回匹配 locator 的元素的边界框，如果元素不可见则返回 null。边界框是相对于主框架视口计算的，通常与浏览器窗口相同。

用法

BoundingBox box = page.getByRole(AriaRole.BUTTON).boundingBox();
page.mouse().click(box.x + box.width / 2, box.y + box.height / 2);

参数

options Locator.BoundingBoxOptions （可选）
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

null | BoundingBox#
- x double
  
  元素在像素中的 x 坐标。
- y double
  
  元素在像素中的 y 坐标。
- width double
  
  元素在像素中的宽度。
- height double
  
  元素在像素中的高度。

详情

滚动会影响返回的边界框，类似于 Element.getBoundingClientRect。这意味着 x 和/或 y 可能是负数。

子框架中的元素返回相对于主框架的边界框，这与 Element.getBoundingClientRect 不同。

假设页面是静态的，使用边界框坐标执行输入是安全的。例如，以下代码片段应点击元素的中心。

check

添加于：v1.14

locator.check

确保复选框或单选元素被选中。

用法

page.getByRole(AriaRole.CHECKBOX).check();

参数

options Locator.CheckOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position （可选）#
  - setX double
  - setY double
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。对于等待元素准备就绪但不执行操作很有用。

返回值

void #

详情

执行以下步骤

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。如果元素已被选中，此方法立即返回。
等待对元素进行可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素的中心。
确保元素现在已被选中。如果不是，此方法将抛出异常。

如果元素在操作期间从 DOM 中分离，此方法将抛出异常。

如果所有步骤在指定的 setTimeout 期间未能完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

clear

添加于：v1.28

locator.clear

清除输入字段。

用法

page.getByRole(AriaRole.TEXTBOX).clear();

参数

options Locator.ClearOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

详情

此方法等待可操作性检查，聚焦元素，清除内容，并在清除后触发 input 事件。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果元素在具有关联控件的 <label> 元素内，则会清除该控件。

click

添加于：v1.14

locator.click

点击一个元素。

用法

点击一个按钮

page.getByRole(AriaRole.BUTTON).click();

在画布上的特定位置进行 Shift + 右键点击

page.locator("canvas").click(new Locator.ClickOptions()
  .setButton(MouseButton.RIGHT)
  .setModifiers(Arrays.asList(KeyboardModifier.SHIFT))
  .setPosition(23, 32));

参数

options Locator.ClickOptions （可选）
- setButton enum MouseButton { LEFT, RIGHT, MIDDLE } （可选）#
  
  默认为 left。
- setClickCount int （可选）#
  
  默认为 1。参阅 UIEvent.detail。
- setDelay double （可选）#
  
  在 mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> （可选）#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项将来将默认为 true。
  
  启动导航的操作会等待导航发生和页面开始加载。您可以通过设置此标志来退出等待。您仅在导航到不可访问页面等特殊情况下才需要此选项。默认为 false。
- setPosition Position （可选）#
  - setX double
  - setY double
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。对于等待元素准备就绪但不执行操作很有用。请注意，无论 trial 如何，都会按下键盘 modifiers 以便测试只有在按下这些键时才可见的元素。

返回值

void #

详情

此方法通过执行以下步骤来点击元素

等待对元素进行可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素的中心，或指定的 setPosition 位置。
等待已启动的导航成功或失败，除非设置了 setNoWaitAfter 选项。

如果元素在操作期间从 DOM 中分离，此方法将抛出异常。

如果所有步骤在指定的 setTimeout 期间未能完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

contentFrame

添加于：v1.43

locator.contentFrame

返回一个 FrameLocator 对象，指向与此 locator 相同的 iframe。

当您在某处获得一个 Locator 对象，并稍后想与框架内的内容交互时很有用。

对于反向操作，请使用 FrameLocator.owner()。

用法

Locator locator = page.locator("iframe[name=\"embedded\"]");
// ...
FrameLocator frameLocator = locator.contentFrame();
frameLocator.getByRole(AriaRole.BUTTON).click();

返回值

FrameLocator #

count

添加于：v1.14

locator.count

返回匹配 locator 的元素数量。

断言数量

如果需要断言页面上的元素数量，请优先使用 assertThat(locator).hasCount() 以避免不稳定性。更多详情请参阅断言指南。

用法

int count = page.getByRole(AriaRole.LISTITEM).count();

返回值

int #

dblclick

添加于：v1.14

locator.dblclick

双击一个元素。

用法

Locator.dblclick();
Locator.dblclick(options);

参数

options Locator.DblclickOptions （可选）
- setButton enum MouseButton { LEFT, RIGHT, MIDDLE } （可选）#
  
  默认为 left。
- setDelay double （可选）#
  
  在 mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> （可选）#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position （可选）#
  - setX double
  - setY double
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。对于等待元素准备就绪但不执行操作很有用。请注意，无论 trial 如何，都会按下键盘 modifiers 以便测试只有在按下这些键时才可见的元素。

返回值

void #

详情

此方法通过执行以下步骤来双击元素

等待对元素进行可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 在元素的中心或指定的 setPosition 位置进行双击。

如果元素在操作期间从 DOM 中分离，此方法将抛出异常。

如果所有步骤在指定的 setTimeout 期间未能完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

注意

element.dblclick() 分发两个 click 事件和一个 dblclick 事件。

dispatchEvent

添加于：v1.14

locator.dispatchEvent

以编程方式在匹配元素上分发事件。

用法

locator.dispatchEvent("click");

参数

type String #

DOM 事件类型："click", "dragstart" 等。
eventInit EvaluationArgument （可选）#

可选的事件特定初始化属性。
options Locator.DispatchEventOptions （可选）
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

详情

上面的代码片段在元素上分发 click 事件。无论元素的可见状态如何，都会分发 click 事件。这等效于调用 element.click()。

在底层，它根据给定的 type 创建一个事件实例，使用 eventInit 属性初始化它，并在元素上分发。事件默认是 composed, cancelable 和冒泡的。

由于 eventInit 是事件特定的，请参阅事件文档获取初始化属性列表

如果需要将实时对象作为属性值传递给事件，也可以指定 JSHandle

JSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
locator.dispatchEvent("dragstart", arg);

dragTo

添加于：v1.18

locator.dragTo

将源元素拖动到目标元素并释放。

用法

Locator source = page.locator("#source");
Locator target = page.locator("#target");

source.dragTo(target);
// or specify exact positions relative to the top-left corners of the elements:
source.dragTo(target, new Locator.DragToOptions()
  .setSourcePosition(34, 7).setTargetPosition(10, 20));

参数

target Locator #

要拖动到的元素的 locator。
options Locator.DragToOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setSourcePosition SourcePosition （可选）#
  - setX double
  - setY double
  在此点（相对于元素内边距框左上角）点击源元素。如果未指定，则使用元素的某个可见点。
- setTargetPosition TargetPosition （可选）#
  - setX double
  - setY double
  在此点（相对于元素内边距框左上角）在目标元素上释放。如果未指定，则使用元素的某个可见点。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。对于等待元素准备就绪但不执行操作很有用。

返回值

void #

详情

此方法将定位符拖动到另一个目标定位符或目标位置。它将首先移动到源元素，执行 mousedown，然后移动到目标元素或位置并执行 mouseup。

evaluate

添加于：v1.14

locator.evaluate

在页面中执行 JavaScript 代码，将匹配的元素作为参数。

用法

参数

expression 字符串 #

要在浏览器上下文中评估的 JavaScript 表达式。如果表达式评估结果为一个函数，则会自动调用该函数。
arg EvaluationArgument (可选)#

传递给 expression 的可选参数。
options Locator.EvaluateOptions (可选)
- setTimeout double (可选)#
  
  在评估定位符之前等待的最大毫秒时间。请注意，定位符解析后，评估本身不受超时限制。默认为 30000 (30 秒)。传入 0 可禁用超时。

返回值

Object #

详情

返回 expression 的返回值，调用时将匹配的元素作为第一个参数，将 arg 作为第二个参数。

如果 expression 返回一个 Promise，此方法将等待 promise 解析并返回其值。

如果 expression 抛出错误或被拒绝，此方法将抛出错误。

evaluateAll

添加于：v1.14

locator.evaluateAll

在页面中执行 JavaScript 代码，将所有匹配的元素作为参数。

用法

Locator locator = page.locator("div");
boolean moreThanTen = (boolean) locator.evaluateAll("(divs, min) => divs.length > min", 10);

参数

expression 字符串 #

要在浏览器上下文中评估的 JavaScript 表达式。如果表达式评估结果为一个函数，则会自动调用该函数。
arg EvaluationArgument (可选)#

传递给 expression 的可选参数。

返回值

Object #

详情

返回 expression 的返回值，调用时将所有匹配元素的数组作为第一个参数，将 arg 作为第二个参数。

如果 expression 返回一个 Promise，此方法将等待 promise 解析并返回其值。

如果 expression 抛出错误或被拒绝，此方法将抛出错误。

evaluateHandle

添加于：v1.14

locator.evaluateHandle

在页面中执行 JavaScript 代码，将匹配的元素作为参数，并返回一个包含结果的 JSHandle。

用法

Locator.evaluateHandle(expression);
Locator.evaluateHandle(expression, arg, options);

参数

expression 字符串 #

要在浏览器上下文中评估的 JavaScript 表达式。如果表达式评估结果为一个函数，则会自动调用该函数。
arg EvaluationArgument (可选)#

传递给 expression 的可选参数。
options Locator.EvaluateHandleOptions (可选)
- setTimeout double (可选)#
  
  在评估定位符之前等待的最大毫秒时间。请注意，定位符解析后，评估本身不受超时限制。默认为 30000 (30 秒)。传入 0 可禁用超时。

返回值

JSHandle #

详情

返回 expression 的返回值作为JSHandle，调用时将匹配的元素作为第一个参数，将 arg 作为第二个参数。

Locator.evaluate() 和 Locator.evaluateHandle() 之间的唯一区别是 Locator.evaluateHandle() 返回 JSHandle。

如果 expression 返回一个 Promise，此方法将等待 promise 解析并返回其值。

如果 expression 抛出错误或被拒绝，此方法将抛出错误。

有关 Page.evaluateHandle() 的更多详细信息，请参阅。

fill

添加于：v1.14

locator.fill

为输入字段设置一个值。

用法

page.getByRole(AriaRole.TEXTBOX).fill("example value");

参数

value 字符串 #

对于 <input>, <textarea> 或 [contenteditable] 元素要设置的值。
options Locator.FillOptions (可选)
- setForce 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

详情

此方法等待可操作性检查，聚焦元素，填充它，并在填充后触发一个 input 事件。请注意，您可以传入一个空字符串来清除输入字段。

如果目标元素不是一个 <input>, <textarea> 或 [contenteditable] 元素，此方法将抛出错误。然而，如果元素在具有关联 control 的 <label> 元素内，则将填充该 control。

要发送细粒度的键盘事件，请使用 Locator.pressSequentially()。

filter

添加于: v1.22

locator.filter

此方法根据选项缩小现有定位符，例如按文本过滤。它可以被链式调用以多次过滤。

用法

Locator rowLocator = page.locator("tr");
// ...
rowLocator
    .filter(new Locator.FilterOptions().setHasText("text in column 1"))
    .filter(new Locator.FilterOptions().setHas(
        page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("column 2 button"))
    ))
    .screenshot();

参数

options Locator.FilterOptions (可选)
- setHas 定位符 (可选)#
  
  缩小方法结果到包含匹配此相对定位符的元素的那些。例如，具有 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。
  
  内部定位符 必须相对于 外部定位符，并且查询从外部定位符匹配开始，而不是文档根部。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到具有 div 的 content。然而，查找具有 article div 的 content 将会失败，因为内部定位符必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位符必须属于同一 frame。内部定位符不得包含 Frame 定位符。
- setHasNot 定位符 (可选)添加于: v1.33#
  
  匹配其内部不包含匹配内部定位符的元素的元素。内部定位符针对外部定位符进行查询。例如，不具有 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位符必须属于同一 frame。内部定位符不得包含 Frame 定位符。
- setHasNotText 字符串 | Pattern (可选)添加于: v1.33#
  
  匹配其内部（可能在子元素或后代元素中）不包含指定文本的元素。传入一个字符串时，匹配不区分大小写并搜索子字符串。
- setHasText 字符串 | Pattern (可选)#
  
  匹配其内部（可能在子元素或后代元素中）包含指定文本的元素。传入一个字符串时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。
- setVisible 布尔值 (可选)添加于: v1.51#
  
  仅匹配可见或不可见元素。

返回值

定位符 #

first

添加于：v1.14

locator.first

返回指向第一个匹配元素的定位符。

用法

Locator.first();

返回值

定位符 #

focus

添加于：v1.14

locator.focus

在匹配的元素上调用 focus。

用法

Locator.focus();
Locator.focus(options);

参数

options Locator.FocusOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

frameLocator

添加于: v1.17

locator.frameLocator

处理 iframe 时，您可以创建一个 frame 定位符，该定位符将进入 iframe 并允许在该 iframe 中定位元素

用法

Locator locator = page.frameLocator("iframe").getByText("Submit");
locator.click();

参数

selector 字符串 #

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

返回值

Frame 定位符 #

getAttribute

添加于：v1.14

locator.getAttribute

返回匹配元素的属性值。

断言属性

如果您需要断言元素的属性，优先使用 assertThat(locator).hasAttribute() 以避免不稳定。有关断言指南的更多详细信息，请参阅。

用法

Locator.getAttribute(name);
Locator.getAttribute(name, options);

参数

name 字符串 #

要获取其值的属性名。
options Locator.GetAttributeOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

null | 字符串 #

getByAltText

添加于: v1.27

locator.getByAltText

允许通过元素的 alt 文本定位元素。

用法

例如，此方法将通过 alt 文本 "Playwright logo" 找到图片

<img alt='Playwright logo'>

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

参数

text 字符串 | Pattern #

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

返回值

定位符 #

getByLabel

添加于: v1.27

locator.getByLabel

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

用法

例如，此方法将在以下 DOM 中通过 label "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 字符串 | Pattern #

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

返回值

定位符 #

getByPlaceholder

添加于: v1.27

locator.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

在通过 placeholder 文本定位后，您可以填充输入框

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

参数

text 字符串 | Pattern #

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

返回值

定位符 #

getByRole

添加于: v1.27

locator.getByRole

允许通过元素的 ARIA role, ARIA 属性和可访问名称定位元素。

用法

考虑以下 DOM 结构。

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

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

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

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

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

参数

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 role。
options Locator.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 定义的非隐藏元素会被 role 选择器匹配。
  
  了解有关 aria-hidden 的更多信息。
- setLevel int (可选)#
  
  一个通常存在于 role heading, listitem, row, treeitem 的数字属性，对于 <h1>-<h6> 元素具有默认值。
  
  了解有关 aria-level 的更多信息。
- setName 字符串 | Pattern (可选)#
  
  匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 setExact 来控制此行为。
  
  了解有关可访问名称的更多信息。
- setPressed 布尔值 (可选)#
  
  通常由 aria-pressed 设置的属性。
  
  了解有关 aria-pressed 的更多信息。
- setSelected 布尔值 (可选)#
  
  通常由 aria-selected 设置的属性。
  
  了解有关 aria-selected 的更多信息。

返回值

定位符 #

详情

Role 选择器 不取代 可访问性审计和一致性测试，而是提供了关于 ARIA 指南的早期反馈。

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

getByTestId

添加于: v1.27

locator.getByTestId

通过 test id 定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过它的 test id 定位元素

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

参数

testId 字符串 | Pattern #

用于定位元素的 Id。

返回值

定位符 #

详情

默认情况下，data-testid 属性被用作 test id。如果需要，使用 Selectors.setTestIdAttribute() 来配置不同的 test id 属性。

getByText

添加于: v1.27

locator.getByText

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

另请参阅 Locator.filter()，它允许按其他条件（例如可访问 role）匹配，然后按文本内容过滤。

用法

考虑以下 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 Page.GetByTextOptions().setExact(true));

// Matches both <div>s
page.getByText(Pattern.compile("Hello"));

// Matches second <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));

参数

text 字符串 | Pattern #

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

返回值

定位符 #

详情

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

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

getByTitle

添加于: v1.27

locator.getByTitle

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

用法

考虑以下 DOM 结构。

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

在通过 title 文本定位后，您可以检查问题计数

assertThat(page.getByTitle("Issues count")).hasText("25 issues");

参数

text 字符串 | Pattern #

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

返回值

定位符 #

highlight

添加于: v1.20

locator.highlight

高亮显示屏幕上相应的元素。对调试有用，不要提交使用 Locator.highlight() 的代码。

用法

Locator.highlight();

返回值

void #

hover

添加于：v1.14

locator.hover

悬停在匹配的元素上。

用法

page.getByRole(AriaRole.LINK).hover();

参数

options Locator.HoverOptions (可选)
- setForce 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter 布尔值 (可选)添加于：v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition 位置 (可选)#
  - setX double
  - setY double
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。对于等待元素准备就绪但不执行操作很有用。请注意，无论 trial 如何，都会按下键盘 modifiers 以便测试只有在按下这些键时才可见的元素。

返回值

void #

详情

此方法通过执行以下步骤将鼠标悬停在元素上

等待元素的可操作性检查通过，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 将鼠标悬停在元素的中心，或指定的 setPosition 位置。

如果元素在操作期间从 DOM 中分离，此方法将抛出异常。

当所有步骤在指定的 setTimeout 内未完成时，此方法会抛出 TimeoutError。传入零超时会禁用此行为。

innerHTML

添加于：v1.14

locator.innerHTML

返回 element.innerHTML。

用法

Locator.innerHTML();
Locator.innerHTML(options);

参数

options Locator.InnerHTMLOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

String #

innerText

添加于：v1.14

locator.innerText

返回 element.innerText。

断言文本

如果需要断言页面上的文本，请优先使用带有 setUseInnerText 选项的 assertThat(locator).hasText() 以避免不稳定性。更多详情请参阅断言指南。

用法

Locator.innerText();
Locator.innerText(options);

参数

options Locator.InnerTextOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

String #

inputValue

添加于：v1.14

locator.inputValue

返回匹配的 <input>、<textarea> 或 <select> 元素的值。

断言值

如果你需要断言输入值，为了避免不稳定性，最好使用 assertThat(locator).hasValue()。更多详情请参阅断言指南。

用法

String value = page.getByRole(AriaRole.TEXTBOX).inputValue();

参数

options Locator.InputValueOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

String #

详情

如果元素不是输入框、文本区域或选择框，则抛出错误。但是，如果元素位于具有关联control的 <label> 元素内，则返回该 control 的值。

isChecked

添加于：v1.14

locator.isChecked

返回元素是否被选中。如果元素不是复选框或单选输入框，则抛出错误。

断言选中状态

如果你需要断言复选框被选中，为了避免不稳定性，最好使用 assertThat(locator).isChecked()。更多详情请参阅断言指南。

用法

boolean checked = page.getByRole(AriaRole.CHECKBOX).isChecked();

参数

options Locator.IsCheckedOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

boolean #

isDisabled

添加于：v1.14

locator.isDisabled

返回元素是否被禁用，与可用相反。

断言禁用状态

如果你需要断言元素被禁用，为了避免不稳定性，最好使用 assertThat(locator).isDisabled()。更多详情请参阅断言指南。

用法

boolean disabled = page.getByRole(AriaRole.BUTTON).isDisabled();

参数

options Locator.IsDisabledOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

boolean #

isEditable

添加于：v1.14

locator.isEditable

返回元素是否可编辑。如果目标元素不是 <input>, <textarea>, <select>, [contenteditable] 且没有允许 [aria-readonly] 的角色，此方法会抛出错误。

断言可编辑状态

如果你需要断言元素可编辑，为了避免不稳定性，最好使用 assertThat(locator).isEditable()。更多详情请参阅断言指南。

用法

boolean editable = page.getByRole(AriaRole.TEXTBOX).isEditable();

参数

options Locator.IsEditableOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

boolean #

isEnabled

添加于：v1.14

locator.isEnabled

返回元素是否可用。

断言可用状态

如果你需要断言元素可用，为了避免不稳定性，最好使用 assertThat(locator).isEnabled()。更多详情请参阅断言指南。

用法

boolean enabled = page.getByRole(AriaRole.BUTTON).isEnabled();

参数

options Locator.IsEnabledOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

boolean #

isHidden

添加于：v1.14

locator.isHidden

返回元素是否隐藏，与可见相反。

断言可见性

如果你需要断言元素隐藏，为了避免不稳定性，最好使用 assertThat(locator).isHidden()。更多详情请参阅断言指南。

用法

boolean hidden = page.getByRole(AriaRole.BUTTON).isHidden();

参数

options Locator.IsHiddenOptions (可选)
- setTimeout double (可选)#
  
  已弃用
  此选项会被忽略。Locator.isHidden() 不会等待元素变为隐藏，而是立即返回。

返回值

boolean #

isVisible

添加于：v1.14

locator.isVisible

返回元素是否可见。

断言可见性

如果你需要断言元素可见，为了避免不稳定性，最好使用 assertThat(locator).isVisible()。更多详情请参阅断言指南。

用法

boolean visible = page.getByRole(AriaRole.BUTTON).isVisible();

参数

options Locator.IsVisibleOptions (可选)
- setTimeout double (可选)#
  
  已弃用
  此选项会被忽略。Locator.isVisible() 不会等待元素变为可见，而是立即返回。

返回值

boolean #

last

添加于：v1.14

locator.last

返回匹配到的最后一个元素的定位器。

用法

Locator banana = page.getByRole(AriaRole.LISTITEM).last();

返回值

Locator #

locator

添加于：v1.14

locator.locator

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

了解更多关于 locators 的信息.

用法

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

参数

selectorOrLocator String | Locator #

用于解析 DOM 元素的选择器或定位器。
options Locator.LocatorOptions (可选)
- setHas Locator (可选)#
  
  缩小方法结果到包含匹配此相对定位符的元素的那些。例如，具有 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。
  
  内部定位符 必须相对于 外部定位符，并且查询从外部定位符匹配开始，而不是文档根部。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到具有 div 的 content。然而，查找具有 article div 的 content 将会失败，因为内部定位符必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位符必须属于同一 frame。内部定位符不得包含 Frame 定位符。
- setHasNot 定位符 (可选)添加于: v1.33#
  
  匹配其内部不包含匹配内部定位符的元素的元素。内部定位符针对外部定位符进行查询。例如，不具有 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位符必须属于同一 frame。内部定位符不得包含 Frame 定位符。
- setHasNotText 字符串 | Pattern (可选)添加于: v1.33#
  
  匹配其内部（可能在子元素或后代元素中）不包含指定文本的元素。传入一个字符串时，匹配不区分大小写并搜索子字符串。
- setHasText String | Pattern (可选)#
  
  匹配其内部（可能在子元素或后代元素中）包含指定文本的元素。传入一个字符串时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

Locator #

nth

添加于：v1.14

locator.nth

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

用法

Locator banana = page.getByRole(AriaRole.LISTITEM).nth(2);

参数

index int #

返回值

Locator #

or

添加于: v1.33

locator.or

创建一个匹配两个定位器中任意一个或两个都匹配的元素的定位器。

请注意，当两个定位器都匹配某些元素时，结果定位器将会有多个匹配项，可能会导致定位器严格性违规。

用法

考虑这样一种场景：你想要点击“新邮件”按钮，但有时会弹出安全设置对话框。在这种情况下，你可以等待“新邮件”按钮或对话框，并据此采取行动。

注意

如果“新邮件”按钮和安全对话框同时出现在屏幕上，“or”定位器将匹配它们两者，可能会抛出“严格模式违规”错误。在这种情况下，你可以使用 Locator.first() 只匹配其中的一个。

Locator newEmail = page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("New"));
Locator dialog = page.getByText("Confirm security settings");
assertThat(newEmail.or(dialog).first()).isVisible();
if (dialog.isVisible())
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Dismiss")).click();
newEmail.click();

参数

locator Locator #

备选的匹配定位器。

返回值

Locator #

page

新增于: v1.19

locator.page

此定位器所属的页面。

用法

Locator.page();

返回值

Page #

press

添加于：v1.14

locator.press

聚焦匹配的元素并按下组合键。

用法

page.getByRole(AriaRole.TEXTBOX).press("Backspace");

参数

key String #

要按下的键名或要生成的字符，例如 ArrowLeft 或 a。
options Locator.PressOptions (可选)
- setDelay double (可选)#
  
  keydown 和 keyup 之间等待的时间，单位为毫秒。默认为 0。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项将来将默认为 true。
  
  启动导航的操作会等待导航发生和页面开始加载。您可以通过设置此标志来退出等待。您仅在导航到不可访问页面等特殊情况下才需要此选项。默认为 false。
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

详情

聚焦元素，然后使用 Keyboard.down() 和 Keyboard.up()。

key 可以指定预期的 keyboardEvent.key 值或生成文本的单个字符。key 值的超集可以在此处找到。键的示例包括：

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp 等。

还支持以下修饰符快捷键：Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

按住 Shift 会输入与 key 对应的大写文本。

如果 key 是单个字符，则区分大小写，因此值 a 和 A 将生成不同的文本。

也支持诸如 key: "Control+o"、key: "Control++" 或 key: "Control+Shift+T" 的快捷键。当指定了修饰符时，修饰符会被按下并保持，同时后续的键被按下。

pressSequentially

新增于: v1.38

locator.pressSequentially

提示

在大多数情况下，你应该使用 Locator.fill()。只有在页面有特殊的键盘处理时，你才需要逐个按键。

聚焦元素，然后为文本中的每个字符发送一个 keydown、keypress/input 和 keyup 事件。

要按特殊键，如 Control 或 ArrowDown，请使用 Locator.press()。

用法

locator.pressSequentially("Hello"); // Types instantly
locator.pressSequentially("World", new Locator.pressSequentiallyOptions().setDelay(100)); // Types slower, like a user

向文本字段输入文本然后提交表单的示例：

Locator locator = page.getByLabel("Password");
locator.pressSequentially("my password");
locator.press("Enter");

参数

text String #

要按顺序按到聚焦元素中的字符串。
options Locator.PressSequentiallyOptions (可选)
- setDelay double (可选)#
  
  按键之间等待的时间，单位为毫秒。默认为 0。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

screenshot

添加于：v1.14

locator.screenshot

截取匹配定位器的元素的屏幕截图。

用法

page.getByRole(AriaRole.LINK).screenshot();

禁用动画并保存截图到文件

page.getByRole(AriaRole.LINK).screenshot(new Locator.ScreenshotOptions()
    .setAnimations(ScreenshotAnimations.DISABLED)
    .setPath(Paths.get("example.png")));

参数

options Locator.ScreenshotOptions (可选)
- setAnimations enum ScreenshotAnimations { DISABLED, ALLOW } (可选)#
  
  设置为 "disabled" 时，停止 CSS动画、CSS过渡和 Web动画。根据动画的持续时间，动画的处理方式不同：
  - 有限动画会快进完成，以便触发 transitionend 事件。
  - 无限动画会被取消并回到初始状态，然后在截图后重新播放。
  默认为 "allow"，它会保留动画不受影响。
- setCaret enum ScreenshotCaret { HIDE, INITIAL } (可选)#
  
  设置为 "hide" 时，截图将隐藏文本光标。设置为 "initial" 时，文本光标的行为将不会改变。默认为 "hide"。
- setMask List<Locator> (可选)#
  
  指定截图时应被遮罩的定位器。被遮罩的元素将叠加一个粉色框 #FF00FF（通过 setMaskColor 自定义），完全覆盖其边界框。遮罩也适用于不可见元素，请参阅仅匹配可见元素来禁用此行为。
- setMaskColor String (可选)新增于: v1.35#
  
  以CSS颜色格式指定被遮罩元素的叠加框颜色。默认颜色为粉色 #FF00FF。
- setOmitBackground boolean (可选)#
  
  隐藏默认的白色背景，允许捕获带有透明度的截图。不适用于 jpeg 图像。默认为 false。
- setPath Path (可选)#
  
  保存图像的文件路径。截图类型将从文件扩展名推断。如果 setPath 是相对路径，则它是相对于当前工作目录解析的。如果未提供路径，图像将不会保存到磁盘。
- setQuality int (可选)#
  
  图像质量，介于 0-100 之间。不适用于 png 图像。
- setScale enum ScreenshotScale { CSS, DEVICE } (可选)#
  
  设置为 "css" 时，截图的每个 CSS 像素对应一个物理像素。对于高 DPI 设备，这将使截图文件较小。使用 "device" 选项将使每个设备像素对应一个物理像素，因此高 DPI 设备的截图文件将是两倍甚至更大。
  
  默认为 "device"。
- setStyle String (可选)新增于: v1.41#
  
  截图时应用的样式表文本。你可以在这里隐藏动态元素、使元素不可见或更改其属性，以帮助你创建可重复的截图。此样式表会穿透 Shadow DOM 并应用于内嵌帧。
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setType enum ScreenshotType { PNG, JPEG } (可选)#
  
  指定截图类型，默认为 png。

返回值

byte[]#

详情

此方法捕获页面的屏幕截图，并根据匹配定位器的特定元素的大小和位置进行裁剪。如果元素被其他元素覆盖，则在截图中将不可见。如果元素是可滚动的容器，则截图中只会显示当前滚动到的内容。

此方法会等待可操作性检查通过，然后在截图前将元素滚动到视图中。如果元素从 DOM 中分离，此方法会抛出错误。

返回包含捕获到的屏幕截图的缓冲区。

scrollIntoViewIfNeeded

添加于：v1.14

locator.scrollIntoViewIfNeeded

此方法等待可操作性检查通过，然后尝试将元素滚动到视图中，除非根据 IntersectionObserver 的 ratio 定义，它已完全可见。

有关其他滚动方式，请参阅滚动。

用法

Locator.scrollIntoViewIfNeeded();
Locator.scrollIntoViewIfNeeded(options);

参数

options Locator.ScrollIntoViewIfNeededOptions (可选)
- setTimeout double (可选)#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

selectOption

添加于：v1.14

locator.selectOption

在 <select> 中选择一个或多个选项。

用法

<select multiple>
  <option value="red">Red</option>
  <option value="green">Green</option>
  <option value="blue">Blue</option>
</select>

// single selection matching the value or label
element.selectOption("blue");
// single selection matching the label
element.selectOption(new SelectOption().setLabel("Blue"));
// multiple selection for blue, red and second option
element.selectOption(new String[] {"red", "green", "blue"});

参数

values null | String | ElementHandle | String[] | SelectOption | ElementHandle[] | SelectOption[]#
- setValue String (可选)
  
  根据 option.value 匹配。可选。
- setLabel String (可选)
  
  根据 option.label 匹配。可选。
- setIndex int (可选)
  
  根据索引匹配。可选。
要选择的选项。如果 <select> 具有 multiple 属性，则所有匹配的选项都会被选中；否则，仅选择匹配其中一个传入选项的第一个选项。字符串值同时匹配值和标签。如果所有指定的属性都匹配，则认为选项是匹配的。
options Locator.SelectOptionOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

List<String>#

详情

此方法会等待可操作性检查，等待直到所有指定的选项都存在于 <select> 元素中，然后选择这些选项。

如果目标元素不是 <select> 元素，此方法将抛出错误。但是，如果元素位于具有关联控件的 <label> 元素内，则将改为使用该控件。

返回已成功选中的选项值的数组。

在所有提供的选项都被选中后，触发一个 change 和 input 事件。

selectText

添加于：v1.14

locator.selectText

此方法会等待可操作性检查，然后聚焦到元素并选中其所有文本内容。

如果元素位于具有关联控件的 <label> 元素内，则改为聚焦并选中该控件中的文本。

用法

Locator.selectText();
Locator.selectText(options);

参数

options Locator.SelectTextOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

setChecked

添加于: v1.15

locator.setChecked

设置复选框或单选元素的选中状态。

用法

page.getByRole(AriaRole.CHECKBOX).setChecked(true);

参数

checked boolean #

是否选中或取消选中复选框。
options Locator.SetCheckedOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position （可选）#
  - setX double
  - setY double
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。对于等待元素准备就绪但不执行操作很有用。

返回值

void #

详情

此方法通过执行以下步骤来选中或取消选中元素

确保匹配的元素是复选框或单选输入框。如果不是，此方法将抛出。
如果元素已处于正确的选中状态，此方法将立即返回。
等待对匹配的元素进行可操作性检查，除非设置了setForce选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素的中心。
确保元素现在已被选中或取消选中。如果不是，此方法将抛出。

当所有步骤组合在指定的setTimeout期间未完成时，此方法将抛出TimeoutError。传递零超时会禁用此功能。

setInputFiles

添加于：v1.14

locator.setInputFiles

将文件或多个文件上传到 <input type=file>。对于具有 [webkitdirectory] 属性的输入框，仅支持单个目录路径。

用法

// Select one file
page.getByLabel("Upload file").setInputFiles(Paths.get("myfile.pdf"));

// Select multiple files
page.getByLabel("Upload files").setInputFiles(new Path[] {Paths.get("file1.txt"), Paths.get("file2.txt")});

// Select a directory
page.getByLabel("Upload directory").setInputFiles(Paths.get("mydir"));

// Remove all the selected files
page.getByLabel("Upload file").setInputFiles(new Path[0]);

// Upload buffer from memory
page.getByLabel("Upload file").setInputFiles(new FilePayload(
  "file.txt", "text/plain", "this is test".getBytes(StandardCharsets.UTF_8)));

参数

files Path | Path[] | FilePayload | FilePayload[]#
- setName String
  
  文件名
- setMimeType String
  
  文件类型
- setBuffer byte[]
  
  文件内容
options Locator.SetInputFilesOptions （可选）
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

详情

将文件输入框的值设置为这些文件路径或文件。如果某些 filePaths 是相对路径，则它们将相对于当前工作目录解析。对于空数组，将清除选中的文件。

此方法期望Locator指向input 元素。但是，如果元素位于具有关联控件的 <label> 元素内，则将改为以该控件为目标。

tap

添加于：v1.14

locator.tap

对匹配定位器的元素执行轻触手势。有关通过手动分派触摸事件来模拟其他手势的示例，请参阅模拟传统触摸事件页面。

用法

Locator.tap();
Locator.tap(options);

参数

options Locator.TapOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> （可选）#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position （可选）#
  - setX double
  - setY double
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。对于等待元素准备就绪但不执行操作很有用。请注意，无论 trial 如何，都会按下键盘 modifiers 以便测试只有在按下这些键时才可见的元素。

返回值

void #

详情

此方法通过执行以下步骤来轻触元素

等待对元素进行可操作性检查，除非设置了setForce选项。
如果需要，将元素滚动到视图中。
使用Page.touchscreen()来轻触元素的中心，或指定的setPosition位置。

如果元素在操作期间从 DOM 中分离，此方法将抛出异常。

当所有步骤组合在指定的setTimeout期间未完成时，此方法将抛出TimeoutError。传递零超时会禁用此功能。

注意

element.tap() 要求浏览器上下文的 hasTouch 选项设置为 true。

textContent

添加于：v1.14

locator.textContent

返回node.textContent。

断言文本

如果需要断言页面上的文本，请优先使用 assertThat(locator).hasText() 以避免不稳定性。更多详情请参阅断言指南。

用法

Locator.textContent();
Locator.textContent(options);

参数

options Locator.TextContentOptions （可选）
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

null | String #

uncheck

添加于：v1.14

locator.uncheck

确保复选框或单选元素未被选中。

用法

page.getByRole(AriaRole.CHECKBOX).uncheck();

参数

options Locator.UncheckOptions （可选）
- setForce boolean （可选）#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position （可选）#
  - setX double
  - setY double
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。对于等待元素准备就绪但不执行操作很有用。

返回值

void #

详情

此方法通过执行以下步骤来取消选中元素

确保元素是复选框或单选输入框。如果不是，此方法将抛出。如果元素已未被选中，此方法将立即返回。
等待对元素进行可操作性检查，除非设置了setForce选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素的中心。
确保元素现在已未被选中。如果不是，此方法将抛出。

如果元素在操作期间从 DOM 中分离，此方法将抛出异常。

当所有步骤组合在指定的setTimeout期间未完成时，此方法将抛出TimeoutError。传递零超时会禁用此功能。

waitFor

添加于: v1.16

locator.waitFor

当定位器指定的元素满足setState选项时返回。

如果目标元素已经满足条件，此方法将立即返回。否则，最多等待setTimeout毫秒，直到满足条件。

用法

Locator orderSent = page.locator("#order-sent");
orderSent.waitFor();

参数

options Locator.WaitForOptions （可选）
- setState enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN } （可选）#
  
  默认为 'visible'。可以是以下之一：
  - 'attached' - 等待元素出现在 DOM 中。
  - 'detached' - 等待元素不在 DOM 中。
  - 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空的边界框，并且不被视为可见。
  - 'hidden' - 等待元素从 DOM 中分离，或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

已弃用

elementHandle

添加于：v1.14

locator.elementHandle

不鼓励

始终优先使用定位器 (Locator) 和 web 断言，而不是元素句柄 (ElementHandle)，因为后者固有地存在竞态条件。

将给定定位器解析为第一个匹配的 DOM 元素。如果没有匹配的元素，则等待一个。如果多个元素匹配定位器，则抛出。

用法

Locator.elementHandle();
Locator.elementHandle(options);

参数

options Locator.ElementHandleOptions （可选）
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

ElementHandle #

elementHandles

添加于：v1.14

locator.elementHandles

不鼓励

始终优先使用定位器 (Locator) 和 web 断言，而不是元素句柄 (ElementHandle)，因为后者固有地存在竞态条件。

将给定定位器解析为所有匹配的 DOM 元素。如果没有匹配的元素，则返回空列表。

用法

Locator.elementHandles();

返回值

List<ElementHandle>#

type

添加于：v1.14

locator.type

已弃用

在大多数情况下，你应该使用Locator.fill()。只有当页面上有特殊的键盘处理时，才需要逐个按下按键 - 在这种情况下，请使用Locator.pressSequentially()。

聚焦元素，然后为文本中的每个字符发送一个 keydown、keypress/input 和 keyup 事件。

要按特殊键，如 Control 或 ArrowDown，请使用 Locator.press()。

用法

参数

text String #

要输入到焦点元素中的文本。
options Locator.TypeOptions （可选）
- setDelay double （可选）#
  
  按键之间等待的时间，单位为毫秒。默认为 0。
- setNoWaitAfter boolean （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double （可选）#
  
  最大超时时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

方法​

all​

allInnerTexts​

allTextContents​

and​

ariaSnapshot​

blur​

boundingBox​

check​

clear​

click​

contentFrame​

count​

dblclick​

dispatchEvent​

dragTo​

evaluate​

evaluateAll​

evaluateHandle​

fill​

filter​

first​

focus​

frameLocator​

getAttribute​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

highlight​

hover​

innerHTML​

innerText​

inputValue​

isChecked​

isDisabled​

isEditable​

isEnabled​

isHidden​

isVisible​

last​

locator​

nth​

or​

page​

press​

pressSequentially​

screenshot​

scrollIntoViewIfNeeded​

selectOption​

selectText​

setChecked​

setInputFiles​

tap​

textContent​

uncheck​

waitFor​

已弃用​

elementHandle​

elementHandles​

type​

方法

all

allInnerTexts

allTextContents

and

ariaSnapshot

blur

boundingBox

check

clear

click

contentFrame

count

dblclick

dispatchEvent

dragTo

evaluate

evaluateAll

evaluateHandle

fill

filter

first

focus

frameLocator

getAttribute

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

highlight

hover

innerHTML

innerText

inputValue

isChecked

isDisabled

isEditable

isEnabled

isHidden

isVisible

last

locator

nth

or

page

press

pressSequentially

screenshot

scrollIntoViewIfNeeded

selectOption

selectText

setChecked

setInputFiles

tap

textContent

uncheck

waitFor

已弃用

elementHandle

elementHandles

type