Locator

定位器是 Playwright 自动等待和重试能力的核心部分。简而言之，定位器代表一种在任何时刻查找页面上元素的方式。可以使用 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 #

ariaSnapshot

添加于: v1.49

locator.ariaSnapshot

捕获给定元素的 aria 快照。阅读更多关于 aria 快照和 assertThat(locator).matchesAriaSnapshot() 以获取相应的断言。

用法

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

参数

options Locator.AriaSnapshotOptions (可选)
- setTimeout double (可选)#
  
  最大等待时间，单位为毫秒。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

String #

详情

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

ARIA 快照使用 YAML 标记语言表示

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

以下是 HTML 标记和相应的 ARIA 快照

<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

此方法返回与定位器匹配的元素的边界框，如果元素不可见，则返回 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] 元素，此方法会抛出错误。但是，如果元素位于具有关联 control 的 <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。用于等待元素准备好进行操作而无需执行它。请注意，键盘 modifiers 将始终按下，而与 trial 无关，以允许测试仅在按下这些键时才可见的元素。

返回值

void #

详情

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

等待元素上的可操作性检查，除非设置了 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();

返回值

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。用于等待元素准备好进行操作而无需执行它。请注意，键盘 modifiers 将始终按下，而与 trial 无关，以允许测试仅在按下这些键时才可见的元素。

返回值

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 #

要拖动到的元素的定位器。
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 resolve 并返回其值。

如果 expression 抛出错误或 rejected，此方法将抛出错误。

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 resolve 并返回其值。

如果 expression 抛出错误或 rejected，此方法将抛出错误。

有关更多详细信息，请参阅 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 #

详情

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

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

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

filter

添加于版本：v1.22

locator.filter

此方法根据选项缩小现有 locator 的范围，例如按文本过滤。它可以链式调用以进行多次过滤。

用法

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#
  
  匹配不包含指定文本的元素，文本可能位于子元素或后代元素的内部某处。当传递 string 时，匹配不区分大小写并搜索子字符串。
- setHasText String | Pattern (可选)#
  
  匹配包含指定文本的元素，文本可能位于子元素或后代元素的内部某处。当传递 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

Locator #

first

添加于: v1.14

locator.first

返回指向第一个匹配元素的 locator。

用法

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 locator，它将进入 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

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

用法

例如，此方法将通过 alt 文本“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 boolean (可选)#
  
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded 的信息。
- setIncludeHidden boolean (可选)#
  
  控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素，如 ARIA 定义，会被角色选择器匹配。
  
  了解更多关于 aria-hidden 的信息。
- setLevel int (可选)#
  
  一个数字属性，通常用于角色 heading、listitem、row、treeitem，对于 <h1>-<h6> 元素具有默认值。
  
  了解更多关于 aria-level 的信息。
- setName String | Pattern (可选)#
  
  用于匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 setExact 来控制此行为。
  
  了解更多关于可访问名称的信息。
- setPressed boolean (可选)#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- setSelected boolean (可选)#
  
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected 的信息。

返回值

Locator #

详情

角色选择器**不能替代**可访问性审计和一致性测试，而是提供关于 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 String | Pattern #

用于定位元素的 ID。

返回值

Locator #

详情

默认情况下，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 String | Pattern #

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

返回值

Locator #

详情

即使是完全匹配，按文本匹配也始终会规范化空格。例如，它将多个空格变成一个空格，将换行符变成空格，并忽略前导和尾随空格。

类型为 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 String | Pattern #

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

返回值

Locator #

highlight

添加于版本：v1.20

locator.highlight

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

用法

Locator.highlight();

返回值

void #

hover

添加于: v1.14

locator.hover

悬停在匹配的元素上。

用法

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

参数

options Locator.HoverOptions (可选)
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta”在 Windows 和 Linux 上解析为“Control”，在 macOS 上解析为“Meta”。
- setNoWaitAfter boolean (可选)添加于: v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)#
  - setX double
  - setY double
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  最大等待时间，单位为毫秒。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而无需执行它。请注意，键盘 modifiers 将始终按下，而与 trial 无关，以允许测试仅在按下这些键时才可见的元素。

返回值

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。

断言文本

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

用法

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 #

详情

如果元素不是 input、textarea 或 select，则会抛出错误。但是，如果该元素位于具有关联控件的 <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

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

断言可编辑状态

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

用法

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

返回值

Locator #

locator

添加于: v1.14

locator.locator

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

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

用法

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

参数

selectorOrLocator String | Locator #

用于解析 DOM 元素的选择器或 Locator。
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#
  
  匹配不包含指定文本的元素，文本可能位于子元素或后代元素的内部某处。当传递 string 时，匹配不区分大小写并搜索子字符串。
- setHasText String | Pattern (可选)#
  
  匹配包含指定文本的元素，文本可能位于子元素或后代元素的内部某处。当传递 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

Locator #

nth

添加于: v1.14

locator.nth

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

用法

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

参数

index int #

返回值

Locator #

or

添加于版本：v1.33

locator.or

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

请注意，当两个 Locator 都匹配到内容时，生成的 Locator 将有多个匹配项，可能导致 Locator 严格性违规。

用法

考虑这样一种场景：您想点击“New email”按钮，但有时会出现安全设置对话框。在这种情况下，您可以等待“New email”按钮或对话框，并采取相应的操作。

注意

如果“New email”按钮和安全对话框都出现在屏幕上，“or” Locator 将同时匹配它们，可能抛出“严格模式违规”错误。在这种情况下，您可以使用 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。

返回值

Locator #

page

添加于: v1.19

locator.page

此 Locator 所属的页面。

用法

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

截取与 Locator 匹配的元素的屏幕截图。

用法

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> (可选)#
  
  指定在截取屏幕截图时应被遮罩的 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[]#

详情

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

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

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

scrollIntoViewIfNeeded

添加于: v1.14

locator.scrollIntoViewIfNeeded

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

有关滚动的替代方法，请参阅 scrolling。

用法

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> 元素内，且该元素具有关联的 control，则将使用该 control 代替。

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

一旦所有提供的选项都被选中，就会触发 change 和 input 事件。

selectText

添加于: v1.14

locator.selectText

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

如果元素在 <label> 元素内，且该元素具有关联的 control，则聚焦并选择 control 中的文本。

用法

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 元素。但是，如果元素位于具有关联 control 的 <label> 元素内，则会改为定位到 control。

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。用于等待元素准备好进行操作而无需执行它。请注意，键盘 modifiers 将始终按下，而与 trial 无关，以允许测试仅在按下这些键时才可见的元素。

返回值

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