Locator

定位器是 Playwright 自动等待和重试功能的核心部分。简而言之，定位器表示在任何时刻查找页面上元素（s）的方法。可以使用 Page.locator() 方法创建定位器。

了解有关定位器的更多信息.

方法

all

添加于：v1.29

locator.all

当定位器指向元素列表时，这将返回一个定位器数组，指向其各自的元素。

注意

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

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

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

用法

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

返回值

List<Locator>#

allInnerTexts

添加于：v1.14

locator.allInnerTexts

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

断言文本

如果您需要断言页面上的文本，请首选使用 assertThat(locator).hasText() 以及 setUseInnerText 选项来避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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 button = page.getByRole(AriaRole.BUTTON).and(page.getByTitle("Subscribe"));

参数

locator Locator #

要匹配的其他定位器。

返回值

Locator #

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

此方法返回匹配定位器的元素的边界框，如果元素不可见，则返回 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 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

空 #

详情

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

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

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 枚举 MouseButton { LEFT, RIGHT, MIDDLE } (可选)#
  
  默认为left。
- setClickCount 整数 (可选)#
  
  默认为1。参见UIEvent.detail。
- setDelay 双精度浮点数 (可选)#
  
  在mousedown和mouseup之间等待的时间（毫秒）。默认为0。
- setForce 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers 列表<枚举 KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta"在Windows和Linux上解析为"Control"，在macOS上解析为"Meta"。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项将来将默认为true。
  
  启动导航的操作将等待这些导航发生并等待页面开始加载。您可以通过设置此标志来选择不等待。您只需要在特殊情况下使用此选项，例如导航到不可访问的页面。默认为false。
- setPosition 位置 (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的一些可见点。
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setTrial 布尔值 (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为false。用于在不执行操作的情况下等待元素准备好执行操作。请注意，无论trial如何，键盘modifiers都将被按下，以便测试只有在按下这些键时才可见的元素。

返回值

空 #

详情

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

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

如果元素在操作期间的任何时刻与DOM分离，则此方法将抛出异常。

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

contentFrame

新增于：v1.43

locator.contentFrame

返回一个指向与该定位器相同的iframe的FrameLocator对象。

当您在某个地方获取了一个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

返回与定位器匹配的元素数量。

断言计数

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

用法

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

返回值

整数 #

dblclick

添加于：v1.14

locator.dblclick

双击一个元素。

用法

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

参数

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

返回值

空 #

详情

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

等待元素上的可操作性检查，除非设置了setForce选项。
根据需要滚动元素到视图中。
使用Page.mouse()双击元素的中心或指定的setPosition。

如果元素在操作期间的任何时刻与DOM分离，则此方法将抛出异常。

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

注意

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

dispatchEvent

添加于：v1.14

locator.dispatchEvent

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

用法

locator.dispatchEvent("click");

参数

type 字符串 #

DOM事件类型："click"、"dragstart"等。
eventInit 评估参数 (可选)#

可选的特定于事件的初始化属性。
options Locator.DispatchEventOptions (可选)
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

void #

详情

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

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

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

如果希望将活动对象传递到事件中，还可以将JSHandle指定为属性值。

// Note you can only create DataTransfer in Chromium and Firefox
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 #

要拖动到的元素的定位器。
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 代码，并将匹配的元素作为参数。

用法

Locator tweets = page.locator(".tweet .retweets");
assertEquals("10 retweets", tweets.evaluate("node => node.innerText"));

参数

expression String #

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

要传递给expression的可选参数。
options Locator.EvaluateOptions (可选)
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

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

要在浏览器上下文中评估的 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 String #

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

要传递给expression的可选参数。
options Locator.EvaluateHandleOptions (可选)
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

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

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

返回值

void #

详情

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

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

要发送细粒度的键盘事件，请使用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 Locator (可选)#
  
  将方法的结果缩小到包含与该相对定位器匹配的元素的结果。例如，包含 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。
  
  内部定位器**必须相对于**外部定位器，并且从外部定位器匹配开始查询，而不是从文档根开始。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将失败，因为内部定位器必须是相对的，并且不应使用 content 外部的任何元素。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- setHasNot Locator (可选)新增于：v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器针对外部定位器进行查询。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- setHasNotText String | Pattern (可选)新增于：v1.33#
  
  匹配在内部（可能在子元素或后代元素中）不包含指定文本的元素。当传递字符串时，匹配不区分大小写并搜索子字符串。
- setHasText String | Pattern (可选)#
  
  匹配在内部（可能在子元素或后代元素中）包含指定文本的元素。当传递字符串时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

Locator #

first

添加于：v1.14

locator.first

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

用法

Locator.first();

返回值

Locator #

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

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

返回值

FrameLocator #

getAttribute

添加于：v1.14

locator.getAttribute

返回匹配元素的属性值。

断言属性

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

用法

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

参数

name String #

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

返回值

null | String #

getByAltText

新增于：v1.27

locator.getByAltText

允许通过它们的替代文本定位元素。

用法

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

<img alt='Playwright logo'>

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

参数

text String | Pattern #

定位元素的文本。
options Locator.GetByAltTextOptions (可选)
- setExact boolean (可选)#
  
  是否查找完全匹配：区分大小写且为整个字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

Locator #

getByLabel

新增于：v1.27

locator.getByLabel

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

用法

例如，此方法将在以下 DOM 中通过标签“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 String | Pattern #

定位元素的文本。
options Locator.GetByLabelOptions (可选)
- setExact boolean (可选)#
  
  是否查找完全匹配：区分大小写且为整个字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

Locator #

getByPlaceholder

新增于：v1.27

locator.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

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

page.getByPlaceholder("[email protected]").fill("[email protected]");

参数

text String | Pattern #

定位元素的文本。
options Locator.GetByPlaceholderOptions (可选)
- setExact boolean (可选)#
  
  是否查找完全匹配：区分大小写且为整个字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

Locator #

getByRole

新增于：v1.27

locator.getByRole

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

用法

考虑以下 DOM 结构。

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

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

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 角色。
options Locator.GetByRoleOptions (可选)
- setChecked boolean (可选)#
  
  通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。
  
  了解有关 aria-checked 的更多信息。
- setDisabled boolean (可选)#
  
  通常由 aria-disabled 或 disabled 设置的属性。
  
  注意
  与大多数其他属性不同，disabled 在 DOM 层次结构中是继承的。了解有关 aria-disabled 的更多信息。
- setExact boolean (可选)添加于：v1.28#
  
  是否完全匹配 setName：区分大小写且匹配整个字符串。默认为 false。当 setName 为正则表达式时忽略。请注意，即使是精确匹配也会去除空格。
- setExpanded 布尔值 （可选）#
  
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded 的信息。
- setIncludeHidden 布尔值 （可选）#
  
  控制是否匹配隐藏元素的选项。默认情况下，角色选择器只匹配非隐藏元素，如 ARIA 定义的那样。
  
  了解更多关于 aria-hidden 的信息。
- setLevel 整数 （可选）#
  
  通常出现在 heading、listitem、row、treeitem 等角色中的数字属性，并且对于 <h1>-<h6> 元素具有默认值。
  
  了解更多关于 aria-level 的信息。
- setName 字符串 | 模式 （可选）#
  
  用于匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 setExact 控制此行为。
  
  了解更多关于可访问名称的信息。
- setPressed 布尔值 （可选）#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- setSelected 布尔值 （可选）#
  
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected 的信息。

返回值

定位器 #

详情

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

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

getByTestId

新增于：v1.27

locator.getByTestId

根据测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

您可以根据元素的测试 ID 定位它。

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

参数

testId 字符串 | 模式 #

要根据其定位元素的 ID。

返回值

定位器 #

详情

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

getByText

新增于：v1.27

locator.getByText

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

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

用法

考虑以下 DOM 结构

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

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

// Matches <span>
page.getByText("world")

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

// Matches second <div>
page.getByText("Hello", new 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 字符串 | 模式 #

定位元素的文本。
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>

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

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

参数

text 字符串 | 模式 #

定位元素的文本。
options Locator.GetByTitleOptions （可选）
- setExact 布尔值 （可选）#
  
  是否查找完全匹配：区分大小写且为整个字符串。默认为 false。在通过正则表达式定位时忽略。请注意，完全匹配仍然会修剪空格。

返回值

定位器 #

highlight

新增于：v1.20

locator.highlight

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

用法

Locator.highlight();

返回值

空 #

hover

添加于：v1.14

locator.hover

将鼠标悬停在匹配的元素上。

用法

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

参数

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

返回值

空 #

详情

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

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

如果元素在操作期间的任何时刻与DOM分离，则此方法将抛出异常。

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

innerHTML

添加于：v1.14

locator.innerHTML

返回 element.innerHTML。

用法

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

参数

options Locator.InnerHTMLOptions （可选）
- setTimeout 双精度浮点数 （可选）#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

字符串 #

innerText

添加于：v1.14

locator.innerText

返回 element.innerText。

断言文本

如果您需要断言页面上的文本，请首选使用 assertThat(locator).hasText() 以及 setUseInnerText 选项来避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

参数

options Locator.InnerTextOptions （可选）
- setTimeout 双精度浮点数 （可选）#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

字符串 #

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> 元素内，则返回控件的值。

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

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

断言禁用状态

如果您需要断言元素是否被禁用，请优先使用 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

返回元素是否可编辑。

断言可编辑状态

如果您需要断言元素是否可编辑，请优先使用 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

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

断言可见性

如果您需要断言元素是否隐藏，请优先使用 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() 方法。

了解有关定位器的更多信息.

用法

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 外部的任何元素。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- setHasNot Locator (可选)新增于：v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器针对外部定位器进行查询。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- setHasNotText String | Pattern (可选)新增于：v1.33#
  
  匹配在内部（可能在子元素或后代元素中）不包含指定文本的元素。当传递字符串时，匹配不区分大小写并搜索子字符串。
- setHasText String | Pattern (可选)#
  
  匹配在内部（可能在子元素或后代元素中）包含指定文本的元素。当传递字符串时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

Locator #

nth

添加于：v1.14

locator.nth

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

用法

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

参数

index int #

返回值

Locator #

or

新增于：v1.33

locator.or

创建一个定位器，匹配与两个定位器中的一个或两个都匹配的所有元素。

请注意，当两个定位器都匹配某些内容时，生成的定位器将具有多个匹配项，并违反定位器严格性指南。

用法

考虑以下场景：您希望点击“新邮件”按钮，但有时安全设置对话框会显示出来。在这种情况下，您可以等待“新邮件”按钮或对话框，并相应地采取行动。

Locator newEmail = page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("New"));
Locator dialog = page.getByText("Confirm security settings");
assertThat(newEmail.or(dialog)).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 字符串 #

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

返回值

空 #

详情

聚焦元素，然后使用 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 字符串 #

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

返回值

空 #

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 列表<Locator> (可选)#
  
  指定在拍摄截图时应屏蔽的定位器。屏蔽的元素将覆盖一个粉红色框 #FF00FF（由 setMaskColor 自定义），该框完全覆盖其边界框。
- setMaskColor 字符串 (可选)新增于：v1.35#
  
  以 CSS 颜色格式指定屏蔽元素的覆盖框的颜色。默认颜色为粉红色 #FF00FF。
- setOmitBackground 布尔值 (可选)#
  
  隐藏默认的白色背景并允许捕获具有透明度的屏幕截图。不适用于 jpeg 图像。默认为 false。
- setPath 路径 (可选)#
  
  保存图像的文件路径。截图类型将从文件扩展名推断。如果 setPath 是相对路径，则相对于当前工作目录解析。如果未提供路径，则图像不会保存到磁盘。
- setQuality 整数 (可选)#
  
  图像的质量，介于 0-100 之间。不适用于 png 图像。
- setScale enum ScreenshotScale { CSS, DEVICE } (可选)#
  
  设置为 "css" 时，截图将每个页面上的每个 css 像素对应一个像素。对于高 dpi 设备，这将使截图保持较小。使用 "device" 选项将产生每个设备像素一个像素，因此高 dpi 设备的截图将是两倍甚至更大。
  
  默认为 "device"。
- setStyle 字符串 (可选)新增于：v1.41#
  
  要应用于拍摄截图时的样式表的文本。在这里，您可以隐藏动态元素，使元素不可见或更改其属性以帮助您创建可重复的截图。此样式表穿透 Shadow DOM 并应用于内部框架。
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setType enum ScreenshotType { PNG, JPEG } (可选)#
  
  指定截图类型，默认为 png。

返回值

字节数组 #

详情

此方法捕获页面的屏幕截图，剪裁到与匹配定位器的特定元素的大小和位置相同。如果元素被其他元素覆盖，则它实际上不会在屏幕截图中可见。如果元素是可滚动的容器，则只有当前滚动的内容将在屏幕截图中可见。

此方法等待可操作性检查，然后在拍摄屏幕截图之前将元素滚动到视图中。如果元素从 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</div>
  <option value="green">Green</div>
  <option value="blue">Blue</div>
</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 布尔值 (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为false。用于在不执行操作的情况下等待元素准备好执行操作。请注意，无论trial如何，键盘modifiers都将被按下，以便测试只有在按下这些键时才可见的元素。

返回值

空 #

详情

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

等待元素上的可操作性检查，除非设置了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 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

空 | 字符串 #

uncheck

添加于：v1.14

locator.uncheck

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

用法

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

参数

options Locator.UncheckOptions (可选)
- setForce 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition 位置 (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的一些可见点。
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setTrial 布尔值 (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作，而无需执行操作。

返回值

空 #

详情

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

确保元素是复选框或单选按钮输入。如果不是，则此方法会抛出异常。如果元素已取消选中，则此方法会立即返回。
等待元素上的可操作性检查，除非设置了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 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

空 #

已弃用

elementHandle

添加于：v1.14

locator.elementHandle

不推荐

始终优先使用Locator和 Web 断言而不是ElementHandle，因为后者本质上是竞争条件。

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

用法

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

参数

options Locator.ElementHandleOptions (可选)
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

ElementHandle #

elementHandles

添加于：v1.14

locator.elementHandles

不推荐

始终优先使用Locator和 Web 断言而不是ElementHandle，因为后者本质上是竞争条件。

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

用法

Locator.elementHandles();

返回值

列表<ElementHandle>#

type

添加于：v1.14

locator.type

已弃用

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

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

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

用法

参数

text 字符串 #

要键入到已聚焦元素中的文本。
options Locator.TypeOptions (可选)
- setDelay 双精度浮点数 (可选)#
  
  键之间等待的时间（毫秒）。默认为 0。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

空 #

方法​

all​

allInnerTexts​

allTextContents​

and​

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

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