跳转到主要内容

Locator

Locators 是 Playwright 自动等待和重试机制的核心。简而言之,Locators 代表了一种在任何时刻查找页面上元素的方法。可以通过 Page.Locator() 方法创建一个 Locator。

了解更多关于定位器.


方法

AllAsync

新增于: v1.29 locator.AllAsync

当定位器指向元素列表时,这会返回一个定位器数组,指向它们各自的元素。

注意

Locator.AllAsync() 不会等待元素与 locator 匹配,而是立即返回页面中当前存在的任何元素。

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

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

用法

foreach (var li in await page.GetByRole("listitem").AllAsync())
await li.ClickAsync();

返回


AllInnerTextsAsync

新增于:v1.14 locator.AllInnerTextsAsync

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

断言文本

如果你需要对页面上的文本进行断言,请优先使用带有 UseInnerText 选项的 Expect(Locator).ToHaveTextAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

var texts = await page.GetByRole(AriaRole.Link).AllInnerTextsAsync();

返回


AllTextContentsAsync

新增于:v1.14 locator.AllTextContentsAsync

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

断言文本

如果你需要对页面上的文本进行断言,请优先使用 Expect(Locator).ToHaveTextAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

var texts = await page.GetByRole(AriaRole.Link).AllTextContentsAsync();

返回


And

新增于: v1.34 locator.And

创建一个同时匹配此定位器和参数定位器的定位器。

用法

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

var button = page.GetByRole(AriaRole.Button).And(page.GetByTitle("Subscribe"));

参数

  • locator Locator#

    要匹配的附加定位器。

返回


AriaSnapshotAsync

新增于: v1.49 locator.AriaSnapshotAsync

捕获给定元素的 aria 快照。阅读更多关于 aria 快照 的信息,以及相应的断言 Expect(Locator).ToMatchAriaSnapshotAsync()

用法

await page.GetByRole(AriaRole.Link).AriaSnapshotAsync();

参数

  • options LocatorAriaSnapshotOptions? (可选)
    • Boxes bool? (可选)添加于: v1.60#

      当设为 true 时,会将每个元素的边界框追加为 [box=x,y,width,height] 到快照中。坐标相对于视口,单位为 CSS 像素,由 Element.getBoundingClientRect() 返回。默认值为 false

    • Depth int? (可选)新增于: v1.59#

      指定时,限制快照的深度。

    • Mode enum AriaSnapshotMode { Ai, Default }? (可选)新增于: v1.59#

      当设置为 "ai" 时,返回针对 AI 使用优化的快照。默认为 "default"。查看详情了解更多信息。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

返回

详情

此方法捕获给定元素的 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"

Mode 控制的 AI 优化快照,与默认快照不同。

  1. 包括元素引用 [ref=e2]。2. 不会等待与定位器匹配的元素,如果没有匹配元素则会抛出异常。3. 包括目标内部 <iframe> 的快照。

BlurAsync

新增于: v1.28 locator.BlurAsync

对元素调用 blur

用法

await Locator.BlurAsync(options);

参数

返回


BoundingBoxAsync

新增于:v1.14 locator.BoundingBoxAsync

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

用法

var box = await page.GetByRole(AriaRole.Button).BoundingBoxAsync();
await page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);

参数

返回

  • BoundingBox?#
    • x [float]

      元素的 x 坐标(以像素为单位)。

    • y [float]

      元素的 y 坐标(以像素为单位)。

    • width [float]

      元素的宽度(以像素为单位)。

    • height [float]

      元素的高度(以像素为单位)。

详情

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

Element.getBoundingClientRect 不同,来自子框架的元素返回的是相对于主框架的边界框。

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


CheckAsync

新增于:v1.14 locator.CheckAsync

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

用法

await page.GetByRole(AriaRole.Checkbox).CheckAsync();

参数

  • options LocatorCheckOptions? (可选)
    • Force bool? (可选)#

      是否跳过可操作性检查。默认为 false

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Trial bool? (可选)#

      设置此项后,该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

返回

详情

执行以下步骤

  1. 确保元素是复选框或单选输入。如果不是,此方法将抛出异常。如果元素已选中,此方法将立即返回。
  2. 对元素执行可操作性检查,除非设置了 Force 选项。
  3. 如果需要,将元素滚动到视图中。
  4. 使用 Page.Mouse 点击元素中心。
  5. 确保元素现在已选中。如果不是,此方法将抛出异常。

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

如果所有步骤在指定的 Timeout 内未完成,该方法将抛出 TimeoutError。将超时设置为零可禁用此限制。


ClearAsync

新增于: v1.28 locator.ClearAsync

清除输入字段。

用法

await page.GetByRole(AriaRole.Textbox).ClearAsync();

参数

  • options LocatorClearOptions? (可选)

返回

详情

该方法等待可操作性检查,聚焦元素,清除其内容,并在清除后触发一个 input 事件。

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


ClickAsync

新增于:v1.14 locator.ClickAsync

点击元素。

用法

点击按钮

await page.GetByRole(AriaRole.Button).ClickAsync();

在画布上的特定位置 Shift-右键单击

await page.Locator("canvas").ClickAsync(new() {
Button = MouseButton.Right,
Modifiers = new[] { KeyboardModifier.Shift },
Position = new Position { X = 0, Y = 0 }
});

参数

  • options LocatorClickOptions? (可选)
    • Button enum MouseButton { Left, Right, Middle }? (可选)#

      默认为 left

    • ClickCount int? (可选)#

      默认为 1。参见 UIEvent.detail

    • Delay [float]? (可选)#

      mousedownmouseup 之间等待的时间(毫秒)。默认为 0。

    • Force bool? (可选)#

      是否跳过可操作性检查。默认为 false

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#

      要按下的修饰键。确保在操作期间只按下了这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项将来默认为 true

      发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项,例如导航到无法访问的页面。默认为 false

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。

    • Steps int? (可选)Added in: v1.57#

      默认为 1。发送 n 个插值过的 mousemove 事件,以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时,将发出一个到达目标位置的 mousemove 事件。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Trial bool? (可选)#

      设置后,此方法仅执行 可操作性 检查并跳过实际动作。默认为 false。在不执行动作的情况下等待元素就绪时非常有用。请注意,无论 trial 是否设置,键盘 modifiers 都会被按下,以允许测试仅在按下这些键时才可见的元素。

返回

详情

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

  1. 对元素执行可操作性检查,除非设置了 Force 选项。
  2. 如果需要,将元素滚动到视图中。
  3. 使用 Page.Mouse 点击元素的中心或指定的 Position
  4. 等待已发起的导航成功或失败,除非设置了 NoWaitAfter 选项。

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

如果所有步骤在指定的 Timeout 内未完成,该方法将抛出 TimeoutError。将超时设置为零可禁用此限制。


ContentFrame

新增于: v1.43 locator.ContentFrame

返回指向与此 locator 相同 iframeFrameLocator 对象。

当您在某处获得了 Locator 对象,且随后想与该框架内的内容进行交互时,此功能非常有用。

如需反向操作,请使用 FrameLocator.Owner

用法

var locator = Page.Locator("iframe[name=\"embedded\"]");
// ...
var frameLocator = locator.ContentFrame;
await frameLocator.GetByRole(AriaRole.Button).ClickAsync();

返回


CountAsync

新增于:v1.14 locator.CountAsync

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

断言计数

如果你需要断言页面上元素的数量,请优先使用 Expect(Locator).ToHaveCountAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

int count = await page.GetByRole(AriaRole.Listitem).CountAsync();

返回


DblClickAsync

新增于:v1.14 locator.DblClickAsync

双击元素。

用法

await Locator.DblClickAsync(options);

参数

  • options LocatorDblClickOptions? (可选)
    • Button enum MouseButton { Left, Right, Middle }? (可选)#

      默认为 left

    • Delay [float]? (可选)#

      mousedownmouseup 之间等待的时间(毫秒)。默认为 0。

    • Force bool? (可选)#

      是否跳过可操作性检查。默认为 false

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#

      要按下的修饰键。确保在操作期间只按下了这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。

    • Steps int? (可选)Added in: v1.57#

      默认为 1。发送 n 个插值过的 mousemove 事件,以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时,将发出一个到达目标位置的 mousemove 事件。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Trial bool? (可选)#

      设置后,此方法仅执行 可操作性 检查并跳过实际动作。默认为 false。在不执行动作的情况下等待元素就绪时非常有用。请注意,无论 trial 是否设置,键盘 modifiers 都会被按下,以允许测试仅在按下这些键时才可见的元素。

返回

详情

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

  1. 对元素执行可操作性检查,除非设置了 Force 选项。
  2. 如果需要,将元素滚动到视图中。
  3. 使用 Page.Mouse 在元素的中心或指定的 Position 执行双击。

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

如果所有步骤在指定的 Timeout 内未完成,该方法将抛出 TimeoutError。将超时设置为零可禁用此限制。

注意

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


Describe

新增于: v1.53 locator.Describe

描述定位器,描述用于跟踪查看器和报告。返回指向相同元素的定位器。

用法

var button = Page.GetByTestId("btn-sub").Describe("Subscribe button");
await button.ClickAsync();

参数

  • description string#

    定位器描述。

返回


Description

Added in: v1.57 locator.Description

返回之前用 Locator.Describe() 设置的 locator 描述。如果没有设置自定义描述,则返回 null

用法

var button = Page.GetByRole(AriaRole.Button).Describe("Subscribe button");
Console.WriteLine(button.Description()); // "Subscribe button"

var input = Page.GetByRole(AriaRole.Textbox);
Console.WriteLine(input.Description()); // null

返回


DispatchEventAsync

新增于:v1.14 locator.DispatchEventAsync

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

用法

await locator.DispatchEventAsync("click");

参数

  • type string#

    DOM 事件类型:"click""dragstart" 等。

  • eventInit EvaluationArgument? (可选)#

    可选的事件特定初始化属性。

  • options LocatorDispatchEventOptions? (可选)

返回

详情

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

在底层,它会根据给定的 type 创建一个事件实例,使用 eventInit 属性对其进行初始化,并在元素上分发该事件。事件默认是 composedcancelable 的,并且会冒泡。

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

如果你想将实时对象传递到事件中,也可以指定 JSHandle 作为属性值。

var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await locator.DispatchEventAsync("dragstart", new Dictionary<string, object>
{
{ "dataTransfer", dataTransfer }
});

DragToAsync

新增于: v1.18 locator.DragToAsync

将源元素拖向目标元素并放下。

用法

var source = Page.Locator("#source");
var target = Page.Locator("#target");

await source.DragToAsync(target);
// or specify exact positions relative to the top-left corners of the elements:
await source.DragToAsync(target, new()
{
SourcePosition = new() { X = 34, Y = 7 },
TargetPosition = new() { X = 10, Y = 20 },
});

参数

  • target Locator#

    要拖动到的元素的定位器。

  • options LocatorDragToOptions? (可选)

    • Force bool? (可选)#

      是否跳过可操作性检查。默认为 false

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • SourcePosition SourcePosition? (可选)#

      • X [float]

      • Y [float]

      在此点(相对于元素内边距框的左上角)点击源元素。如果未指定,则使用元素的某个可见点。

    • Steps int? (可选)Added in: v1.57#

      默认为 1。发送 n 个插值的 mousemove 事件以表示从 mousedownmouseup 的拖动过程。当设置为 1 时,在目标位置发出单个 mousemove 事件。

    • TargetPosition TargetPosition? (可选)#

      • X [float]

      • Y [float]

      在此点(相对于元素内边距框的左上角)拖放到目标元素。如果未指定,则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Trial bool? (可选)#

      设置此项后,该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

返回

详情

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


DropAsync

添加于: v1.60 locator.DropAsync

模拟将文件或类似剪贴板的数据拖放到此定位器上。

用法

将文件缓冲区拖放到上传区域

同时拖放纯文本和 URL

参数

  • payload Payload#

    要拖放到目标上的数据。提供 files(文件路径或内存缓冲区)、data(MIME 类型到字符串的映射,用于类似剪贴板的内容,如 text/plaintext/htmltext/uri-list),或两者兼有。

  • options LocatorDropOptions? (可选)

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

返回

详情

在目标元素的中心分发原生的 dragenterdragoverdrop 事件,并携带包含所提供文件和/或数据条目的合成 [DataTransfer]。通过在页面上下文中构建 [DataTransfer] 实现跨浏览器兼容。

如果目标元素的 dragover 监听器未调用 preventDefault(),则视为目标拒绝了放置:Playwright 会分发 dragleave 并且此方法会抛出异常。


EvaluateAsync

新增于:v1.14 locator.EvaluateAsync

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

用法

expression 传递参数

var result = await page.GetByTestId("myId").EvaluateAsync<string>("(element, [x, y]) => element.textContent + ' ' + x * y)", new[] { 7, 8 });
Console.WriteLine(result); // prints "myId text 56"

参数

  • expression string#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数,则该函数会自动调用。

  • arg EvaluationArgument? (可选)#

    传递给 expression 的可选参数。

  • options LocatorEvaluateOptions? (可选)

    • Timeout [float]? (可选)#

      在求值之前等待定位器的最长时间(毫秒)。请注意,定位器解析后,求值本身不受超时限制。默认为 30000(30 秒)。传递 0 以禁用超时。

返回

  • [object]#

详情

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

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

如果 expression 抛出异常或被拒绝,此方法将抛出异常。


EvaluateAllAsync

新增于:v1.14 locator.EvaluateAllAsync

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

用法

var locator = page.Locator("div");
var moreThanTen = await locator.EvaluateAllAsync<bool>("(divs, min) => divs.length > min", 10);

参数

  • expression string#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数,则该函数会自动调用。

  • arg EvaluationArgument? (可选)#

    传递给 expression 的可选参数。

返回

  • [object]#

详情

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

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

如果 expression 抛出异常或被拒绝,此方法将抛出异常。


EvaluateHandleAsync

新增于:v1.14 locator.EvaluateHandleAsync

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

用法

await Locator.EvaluateHandleAsync(expression, arg, options);

参数

  • expression string#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数,则该函数会自动调用。

  • arg EvaluationArgument? (可选)#

    传递给 expression 的可选参数。

  • options LocatorEvaluateHandleOptions? (可选)

    • Timeout [float]? (可选)#

      在求值之前等待定位器的最长时间(毫秒)。请注意,定位器解析后,求值本身不受超时限制。默认为 30000(30 秒)。传递 0 以禁用超时。

返回

详情

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

Locator.EvaluateAsync()Locator.EvaluateHandleAsync() 之间的唯一区别是 Locator.EvaluateHandleAsync() 返回 JSHandle

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

如果 expression 抛出异常或被拒绝,此方法将抛出异常。

有关更多详细信息,请参阅 Page.EvaluateHandleAsync()


FillAsync

新增于:v1.14 locator.FillAsync

设置输入字段的值。

用法

await page.GetByRole(AriaRole.Textbox).FillAsync("example value");

参数

  • value string#

    要为 <input><textarea>[contenteditable] 元素设置的值。

  • options LocatorFillOptions? (可选)

返回

详情

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

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

要发送精细的键盘事件,请使用 Locator.PressSequentiallyAsync()


Filter

新增于: v1.22 locator.Filter

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

用法

var rowLocator = page.Locator("tr");
// ...
await rowLocator
.Filter(new() { HasText = "text in column 1" })
.Filter(new() {
Has = page.GetByRole(AriaRole.Button, new() { Name = "column 2 button" } )
})
.ScreenshotAsync();

参数

  • options LocatorFilterOptions? (可选)
    • Has Locator? (可选)#

      将方法的返回结果缩小到包含匹配此相对定位器的元素的结果。例如,article 包含 text=Playwright 匹配 <article><div>Playwright</div></article>

      内部定位器必须相对于外部定位器,并且从外部定位器匹配而不是文档根开始查询。例如,你可以在 <article><content><div>Playwright</div></content></article> 中查找包含 divcontent。但是,查找包含 article divcontent 会失败,因为内部定位器必须是相对的,不应使用 content 之外的任何元素。

      请注意,外部和内部定位器必须属于同一帧。内部定位器不得包含 FrameLocator

    • HasNot Locator? (可选)新增于:v1.33#

      匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器查询的。例如,不包含 divarticle 匹配 <article><span>Playwright</span></article>

      请注意,外部和内部定位器必须属于同一帧。内部定位器不得包含 FrameLocator

    • HasNotText|HasNotTextRegex string? | Regex? (可选)新增于:v1.33#

      匹配内部未包含指定文本的元素,可能在子元素或后代元素中。当传递 string 时,匹配是不区分大小写的并搜索子字符串。

    • HasText|HasTextRegex string? | Regex? (可选)#

      匹配内部包含指定文本的元素,可能在子元素或后代元素中。当传递 string 时,匹配是不区分大小写的并搜索子字符串。例如,"Playwright" 匹配 <article><div>Playwright</div></article>

    • Visible bool? (可选)添加于: v1.51#

      仅匹配可见或不可见元素。

返回


First

新增于:v1.14 locator.First

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

用法

Locator.First

返回


FocusAsync

新增于:v1.14 locator.FocusAsync

在匹配的元素上调用 focus

用法

await Locator.FocusAsync(options);

参数

返回


FrameLocator

新增于: v1.17 locator.FrameLocator

使用 iframe 时,您可以创建一个框架定位器,它将进入 iframe 并允许在 iframe 中定位元素

用法

var locator = page.FrameLocator("iframe").GetByText("Submit");
await locator.ClickAsync();

参数

  • selector string#

    用于解析 DOM 元素的选取器。

返回


GetAttributeAsync

新增于:v1.14 locator.GetAttributeAsync

返回匹配元素的属性值。

断言属性

如果你需要断言元素的属性,请优先使用 Expect(Locator).ToHaveAttributeAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

await Locator.GetAttributeAsync(name, options);

参数

返回


GetByAltText

新增于:v1.27 locator.GetByAltText

允许根据元素的 alt 文本定位元素。

用法

例如,此方法将通过 alt 文本“Playwright logo”找到图像

<img alt='Playwright logo'>
await page.GetByAltText("Playwright logo").ClickAsync();

参数

  • text string | Regex#

    用于定位元素的文本。

  • options LocatorGetByAltTextOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意,精确匹配仍会去除空白。

返回


GetByLabel

新增于:v1.27 locator.GetByLabel

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

用法

例如,此方法将在以下 DOM 中通过标签“用户名”和“密码”找到输入

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
await page.GetByLabel("Username").FillAsync("john");
await page.GetByLabel("Password").FillAsync("secret");

参数

  • text string | Regex#

    用于定位元素的文本。

  • options LocatorGetByLabelOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意,精确匹配仍会去除空白。

返回


GetByPlaceholder

新增于:v1.27 locator.GetByPlaceholder

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

用法

例如,考虑以下 DOM 结构。

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

您可以按占位符文本定位输入框后填充它

await page
.GetByPlaceholder("name@example.com")
.FillAsync("playwright@microsoft.com");

参数

  • text string | Regex#

    用于定位元素的文本。

  • options LocatorGetByPlaceholderOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意,精确匹配仍会去除空白。

返回


GetByRole

新增于:v1.27 locator.GetByRole

允许通过元素的 ARIA 角色ARIA 属性可访问名称(accessible name) 来定位元素。

用法

考虑以下 DOM 结构。

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

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

await Expect(Page
.GetByRole(AriaRole.Heading, new() { Name = "Sign up" }))
.ToBeVisibleAsync();

await page
.GetByRole(AriaRole.Checkbox, new() { Name = "Subscribe" })
.CheckAsync();

await page
.GetByRole(AriaRole.Button, new() {
NameRegex = new Regex("submit", RegexOptions.IgnoreCase)
})
.ClickAsync();

参数

  • 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 LocatorGetByRoleOptions? (可选)

    • Checked bool? (可选)#

      通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。

      了解更多关于 aria-checked 的信息。

    • Description|DescriptionRegex string? | Regex? (可选)添加于: v1.60#

      匹配 无障碍描述 (accessible description) 的选项。默认情况下,匹配是不区分大小写的,并且搜索子字符串,使用 Exact 来控制此行为。

      了解更多关于 可访问描述 的信息。

    • Disabled bool? (可选)#

      通常由 aria-disableddisabled 设置的属性。

      注意

      与大多数其他属性不同,disabled 通过 DOM 层级结构继承。了解更多关于 aria-disabled 的信息。

    • Exact bool? (可选)新增于: v1.28#

      是否完全匹配 Name|NameRegexDescription|DescriptionRegex:区分大小写且全字符串匹配。默认为 false。当值为正则表达式时,此选项被忽略。注意,精确匹配仍会修剪空白字符。

    • Expanded bool? (可选)#

      通常由 aria-expanded 设置的属性。

      了解更多关于 aria-expanded 的信息。

    • IncludeHidden bool? (可选)#

      控制是否匹配隐藏元素的选项。默认情况下,角色选择器仅匹配 ARIA 定义 中的非隐藏元素。

      了解更多关于 aria-hidden 的信息。

    • Level int? (可选)#

      通常用于角色 headinglistitemrowtreeitem 的数字属性,<h1>-<h6> 元素具有默认值。

      了解更多关于 aria-level 的信息。

    • Name|NameRegex string? | Regex? (可选)#

      匹配 无障碍名称 (accessible name) 的选项。默认情况下,匹配是不区分大小写的,并且搜索子字符串,使用 Exact 来控制此行为。

      了解更多关于 可访问名称 的信息。

    • Pressed bool? (可选)#

      通常由 aria-pressed 设置的属性。

      了解更多关于 aria-pressed 的信息。

    • Selected bool? (可选)#

      通常由 aria-selected 设置的属性。

      了解更多关于 aria-selected 的信息。

返回

详情

角色选择器 不替代 可访问性审计和合规性测试,而是提供有关 ARIA 指南的早期反馈。

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


GetByTestId

新增于:v1.27 locator.GetByTestId

按测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

您可以按其测试 ID 定位元素

await page.GetByTestId("directions").ClickAsync();

参数

返回

详情

默认情况下,使用 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() { Exact = true });

// Matches both <div>s
page.GetByText(new Regex("Hello"));

// Matches second <div>
page.GetByText(new Regex("^hello$", RegexOptions.IgnoreCase));

参数

  • text string | Regex#

    用于定位元素的文本。

  • options LocatorGetByTextOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意,精确匹配仍会去除空白。

返回

详情

按文本匹配始终会规范化空格,即使是精确匹配也是如此。例如,它会将多个空格转换为一个空格,将换行符转换为空格,并忽略前导和尾随空格。

类型为 buttonsubmit 的输入元素通过其 value 而不是文本内容进行匹配。例如,通过文本 "登录" 定位匹配 <input type=button value="登录">


GetByTitle

新增于:v1.27 locator.GetByTitle

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

用法

考虑以下 DOM 结构。

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

您可以通过 title 文本定位它后检查问题数量

await Expect(Page.GetByTitle("Issues count")).toHaveText("25 issues");

参数

  • text string | Regex#

    用于定位元素的文本。

  • options LocatorGetByTitleOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配:区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意,精确匹配仍会去除空白。

返回


HideHighlightAsync

添加于: v1.60 locator.HideHighlightAsync

隐藏之前由 Locator.HighlightAsync() 添加的元素高亮。

用法

await Locator.HideHighlightAsync();

返回


HighlightAsync

新增于: v1.20 locator.HighlightAsync

在屏幕上高亮显示相应的元素。仅用于调试,不要提交使用 Locator.HighlightAsync() 的代码。

用法

await Locator.HighlightAsync(options);

参数

  • options LocatorHighlightOptions? (可选)
    • Style string? (可选)添加于: v1.60#

      应用于高亮覆盖层的额外内联 CSS,例如 "outline: 2px dashed red"

返回

  • [Disposable]#

HoverAsync

新增于:v1.14 locator.HoverAsync

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

用法

await page.GetByRole(AriaRole.Link).HoverAsync();

参数

  • options LocatorHoverOptions? (可选)
    • Force bool? (可选)#

      是否跳过可操作性检查。默认为 false

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#

      要按下的修饰键。确保在操作期间只按下了这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。

    • NoWaitAfter bool? (可选)新增于: v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Trial bool? (可选)#

      设置后,此方法仅执行 可操作性 检查并跳过实际动作。默认为 false。在不执行动作的情况下等待元素就绪时非常有用。请注意,无论 trial 是否设置,键盘 modifiers 都会被按下,以允许测试仅在按下这些键时才可见的元素。

返回

详情

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

  1. 对元素执行可操作性检查,除非设置了 Force 选项。
  2. 如果需要,将元素滚动到视图中。
  3. 使用 Page.Mouse 悬停在元素的中心或指定的 Position 上。

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

如果所有步骤在指定的 Timeout 内未完成,该方法将抛出 TimeoutError。将超时设置为零可禁用此限制。


InnerHTMLAsync

新增于:v1.14 locator.InnerHTMLAsync

返回 element.innerHTML

用法

await Locator.InnerHTMLAsync(options);

参数

返回


InnerTextAsync

新增于:v1.14 locator.InnerTextAsync

返回 element.innerText

断言文本

如果你需要对页面上的文本进行断言,请优先使用带有 UseInnerText 选项的 Expect(Locator).ToHaveTextAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

await Locator.InnerTextAsync(options);

参数

返回


InputValueAsync

新增于:v1.14 locator.InputValueAsync

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

断言值

如果你需要断言输入值,请优先使用 Expect(Locator).ToHaveValueAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

String value = await page.GetByRole(AriaRole.Textbox).InputValueAsync();

参数

返回

详情

对于非 input、textarea 或 select 元素,该方法会报错。但是,如果元素位于具有关联 control<label> 元素内,则会返回该控件的值。


IsCheckedAsync

新增于:v1.14 locator.IsCheckedAsync

返回元素是否已选中。如果元素不是复选框或单选输入,则抛出异常。

断言选中状态

如果你需要断言复选框已被选中,请优先使用 Expect(Locator).ToBeCheckedAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

var isChecked = await page.GetByRole(AriaRole.Checkbox).IsCheckedAsync();

参数

返回


IsDisabledAsync

新增于:v1.14 locator.IsDisabledAsync

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

断言禁用状态

如果你需要断言元素已被禁用,请优先使用 Expect(Locator).ToBeDisabledAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

Boolean disabled = await page.GetByRole(AriaRole.Button).IsDisabledAsync();

参数

返回


IsEditableAsync

新增于:v1.14 locator.IsEditableAsync

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

断言可编辑状态

如果你需要断言元素是可编辑的,请优先使用 Expect(Locator).ToBeEditableAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

Boolean editable = await page.GetByRole(AriaRole.Textbox).IsEditableAsync();

参数

返回


IsEnabledAsync

新增于:v1.14 locator.IsEnabledAsync

返回元素是否已 启用

断言启用状态

如果你需要断言元素是可用的(已启用),请优先使用 Expect(Locator).ToBeEnabledAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

Boolean enabled = await page.GetByRole(AriaRole.Button).IsEnabledAsync();

参数

返回


IsHiddenAsync

新增于:v1.14 locator.IsHiddenAsync

返回元素是否隐藏,即 可见 (visible) 的反面。

断言可见性

如果你需要断言元素是隐藏的,请优先使用 Expect(Locator).ToBeHiddenAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

Boolean hidden = await page.GetByRole(AriaRole.Button).IsHiddenAsync();

参数

  • options LocatorIsHiddenOptions? (可选)
    • Timeout [float]? (可选)#

      已弃用

      此选项被忽略。Locator.IsHiddenAsync() 不会等待元素变为隐藏状态,而是立即返回。

返回


IsVisibleAsync

新增于:v1.14 locator.IsVisibleAsync

返回元素是否 可见 (visible)

断言可见性

如果你需要断言元素是可见的,请优先使用 Expect(Locator).ToBeVisibleAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

Boolean visible = await page.GetByRole(AriaRole.Button).IsVisibleAsync();

参数

  • options LocatorIsVisibleOptions? (可选)
    • Timeout [float]? (可选)#

      已弃用

      此选项被忽略。Locator.IsVisibleAsync() 不会等待元素变为可见状态,而是立即返回。

返回


Last

新增于:v1.14 locator.Last

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

用法

var banana = await page.GetByRole(AriaRole.Listitem).Last(1);

返回


Locator

新增于:v1.14 locator.Locator

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

了解更多关于定位器.

用法

Locator.Locator(selectorOrLocator, options);

参数

  • selectorOrLocator string | Locator#

    用于解析 DOM 元素的选择器或定位器。

  • options LocatorLocatorOptions? (可选)

    • Has Locator? (可选)#

      将方法的返回结果缩小到包含匹配此相对定位器的元素的结果。例如,article 包含 text=Playwright 匹配 <article><div>Playwright</div></article>

      内部定位器必须相对于外部定位器,并且从外部定位器匹配而不是文档根开始查询。例如,你可以在 <article><content><div>Playwright</div></content></article> 中查找包含 divcontent。但是,查找包含 article divcontent 会失败,因为内部定位器必须是相对的,不应使用 content 之外的任何元素。

      请注意,外部和内部定位器必须属于同一帧。内部定位器不得包含 FrameLocator

    • HasNot Locator? (可选)新增于:v1.33#

      匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器查询的。例如,不包含 divarticle 匹配 <article><span>Playwright</span></article>

      请注意,外部和内部定位器必须属于同一帧。内部定位器不得包含 FrameLocator

    • HasNotText|HasNotTextRegex string? | Regex? (可选)新增于:v1.33#

      匹配内部未包含指定文本的元素,可能在子元素或后代元素中。当传递 string 时,匹配是不区分大小写的并搜索子字符串。

    • HasText|HasTextRegex string? | Regex? (可选)#

      匹配内部包含指定文本的元素,可能在子元素或后代元素中。当传递 string 时,匹配是不区分大小写的并搜索子字符串。例如,"Playwright" 匹配 <article><div>Playwright</div></article>

返回


NormalizeAsync

新增于: v1.59 locator.NormalizeAsync

返回一个新的定位器,该定位器使用引用匹配元素的最佳实践,优先选择测试 ID、Aria 角色和其他面向用户的属性,而非 CSS 选择器。这对于将实现细节选择器转换为更具弹性、人类可读的定位器非常有用。

用法

await Locator.NormalizeAsync();

返回


Nth

新增于:v1.14 locator.Nth

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

用法

var banana = await page.GetByRole(AriaRole.Listitem).Nth(2);

参数

返回


Or

新增于:v1.33 locator.Or

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

请注意,当两个 locator 都匹配到内容时,生成的 locator 将有多个匹配项,这可能会导致locator 严格性 (locator strictness) 违规。

用法

考虑一个场景,你想点击一个“新邮件”按钮,但有时会弹出一个安全设置对话框。在这种情况下,你可以等待“新邮件”按钮,或者一个对话框并相应地操作。

注意

如果“新邮件”按钮和安全对话框同时出现在屏幕上,“或” locator 将匹配它们两者,并可能抛出“严格模式违规 (strict mode violation)”错误。在这种情况下,你可以使用 Locator.First 仅匹配其中一个。

var newEmail = page.GetByRole(AriaRole.Button, new() { Name = "New" });
var dialog = page.GetByText("Confirm security settings");
await Expect(newEmail.Or(dialog).First).ToBeVisibleAsync();
if (await dialog.IsVisibleAsync())
await page.GetByRole(AriaRole.Button, new() { Name = "Dismiss" }).ClickAsync();
await newEmail.ClickAsync();

参数

  • locator Locator#

    要匹配的替代定位器。

返回


Page

新增于:v1.19 locator.Page

此定位器所属的页面。

用法

Locator.Page

返回


PressAsync

新增于:v1.14 locator.PressAsync

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

用法

await page.GetByRole(AriaRole.Textbox).PressAsync("Backspace");

参数

  • key string#

    要按下的键的名称或要生成的字符,例如 ArrowLefta

  • options LocatorPressOptions? (可选)

    • Delay [float]? (可选)#

      keydownkeyup 之间等待的时间(毫秒)。默认为 0。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项将来默认为 true

      发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项,例如导航到无法访问的页面。默认为 false

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

返回

详情

聚焦该元素,然后使用 Keyboard.DownAsync()Keyboard.UpAsync()

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, ControlOrMetaControlOrMeta 在 Windows 和 Linux 上解析为 Control,在 macOS 上解析为 Meta

按住 Shift 键将输入对应于 key 的大写文本。

如果 key 是单个字符,则区分大小写,因此值 aA 将分别生成不同的文本。

也支持快捷键,例如 key: "Control+o"key: "Control++key: "Control+Shift+T"。当与修饰符一起指定时,修饰符在按下后续键时被按下并保持。


PressSequentiallyAsync

新增于: v1.38 locator.PressSequentiallyAsync
提示

在大多数情况下,你应该改用 Locator.FillAsync()。仅当页面有特殊键盘处理逻辑时,才需要逐个按键输入。

聚焦元素,然后为文本中的每个字符发送一个 keydownkeypress/inputkeyup 事件。

要按下特殊键(例如 ControlArrowDown),请使用 Locator.PressAsync()

用法

await locator.PressSequentiallyAsync("Hello"); // Types instantly
await locator.PressSequentiallyAsync("World", new() { Delay = 100 }); // Types slower, like a user

键入文本字段然后提交表单的示例

var locator = page.GetByLabel("Password");
await locator.PressSequentiallyAsync("my password");
await locator.PressAsync("Enter");

参数

  • text string#

    要顺序按入聚焦元素的字符字符串。

  • options LocatorPressSequentiallyOptions? (可选)

    • Delay [float]? (可选)#

      按键之间等待的时间,以毫秒为单位。默认为 0。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

返回


ScreenshotAsync

新增于:v1.14 locator.ScreenshotAsync

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

用法

await page.GetByRole(AriaRole.Link).ScreenshotAsync();

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

await page.GetByRole(AriaRole.Link).ScreenshotAsync(new() {
Animations = ScreenshotAnimations.Disabled,
Path = "link.png"
});

参数

  • options LocatorScreenshotOptions? (可选)
    • Animations enum ScreenshotAnimations { Disabled, Allow }? (可选)#

      设置为 "disabled" 时,停止 CSS 动画、CSS 过渡和 Web 动画。动画的处理方式因其持续时间而异

      • 有限动画会快进到完成,因此它们会触发 transitionend 事件。
      • 无限动画会取消到初始状态,然后在截图后重新播放。

      默认为 "allow",保持动画不变。

    • Caret enum ScreenshotCaret { Hide, Initial }? (可选)#

      设置为 "hide" 时,截图将隐藏文本插入符号。设置为 "initial" 时,文本插入符号行为不会更改。默认为 "hide"

    • Mask IEnumerable?<Locator> (可选)#

      指定截图时应被遮盖的定位器。被遮盖的元素将覆盖一个粉色框 #FF00FF(可通过 MaskColor 自定义),完全覆盖其边界框。遮盖也适用于不可见元素,请参阅 仅匹配可见元素 以禁用此行为。

    • MaskColor string? (可选)添加于:v1.35#

      指定被遮盖元素的覆盖框颜色,使用 CSS 颜色格式。默认颜色为粉色 #FF00FF

    • OmitBackground bool? (可选)#

      隐藏默认的白色背景并允许捕获透明截图。不适用于 jpeg 图像。默认为 false

    • Path string? (可选)#

      保存图像的文件路径。截图类型将根据文件扩展名推断。如果 Path 是相对路径,则解析为相对于当前工作目录。如果未提供路径,图像将不会保存到磁盘。

    • Quality int? (可选)#

      图像质量,介于 0-100 之间。不适用于 png 图像。

    • Scale enum ScreenshotScale { Css, Device }? (可选)#

      设置为 "css" 时,截屏将具有页面上每个 CSS 像素的单个像素。对于高 DPI 设备,这将保持截屏较小。使用 "device" 选项将产生每个设备像素的单个像素,因此高 DPI 设备的截屏将大两倍或更大。

      默认为 "device"

    • Style string? (可选)新增于: v1.41#

      在截屏时应用的样式表文本。您可以在此处隐藏动态元素、使元素不可见或更改其属性,以帮助您创建可重复的截屏。此样式表会穿透 Shadow DOM 并应用于内部框架。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Type enum ScreenshotType { Png, Jpeg }? (可选)#

      指定截图类型,默认为 png

返回

详情

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

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

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


ScrollIntoViewIfNeededAsync

新增于:v1.14 locator.ScrollIntoViewIfNeededAsync

此方法等待操作性检查,然后尝试将元素滚动到视图中,除非元素已按照 IntersectionObserverratio 完全可见。

有关滚动的其他方法,请参阅滚动

用法

await Locator.ScrollIntoViewIfNeededAsync(options);

参数

返回


SelectOptionAsync

新增于:v1.14 locator.SelectOptionAsync

<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
await element.SelectOptionAsync(new[] { "blue" });
// single selection matching the label
await element.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection for blue, red and second option
await element.SelectOptionAsync(new[] { "red", "green", "blue" });

参数

  • values string | ElementHandle | IEnumerable | SelectOption | IEnumerable | IEnumerable?#

    • Value string? (可选)

      option.value 匹配。可选。

    • Label string? (可选)

      option.label 匹配。可选。

    • Index int? (可选)

      按索引匹配。可选。

    要选择的选项。如果 <select> 具有 multiple 属性,则选择所有匹配的选项,否则仅选择与传入选项之一匹配的第一个选项。字符串值同时匹配值和标签。当所有指定的属性都匹配时,认为选项匹配。

  • options LocatorSelectOptionOptions? (可选)

返回

详情

此方法等待操作性检查,等待直到指定的选项出现在 <select> 元素中,并选中这些选项。

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

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

一旦所有提供的选项都已选中,将触发 changeinput 事件。


SelectTextAsync

新增于:v1.14 locator.SelectTextAsync

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

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

用法

await Locator.SelectTextAsync(options);

参数

返回


SetCheckedAsync

新增于: v1.15 locator.SetCheckedAsync

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

用法

await page.GetByRole(AriaRole.Checkbox).SetCheckedAsync(true);

参数

  • checkedState bool#

    是否选中或取消选中复选框。

  • options LocatorSetCheckedOptions? (可选)

    • Force bool? (可选)#

      是否跳过可操作性检查。默认为 false

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Trial bool? (可选)#

      设置此项后,该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

返回

详情

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

  1. 确保匹配的元素是复选框或单选输入。如果不是,此方法将抛出错误。
  2. 如果元素已经处于正确的选中状态,此方法将立即返回。
  3. 对匹配的元素执行操作性检查,除非设置了 Force 选项。如果元素在检查期间被分离,则会重试整个操作。
  4. 如果需要,将元素滚动到视图中。
  5. 使用 Page.Mouse 点击元素中心。
  6. 确保元素现在已选中或未选中。如果不是,此方法将抛出异常。

当所有步骤在指定的 Timeout 内未完成时,此方法会抛出 TimeoutError。传入零超时将禁用此功能。


SetInputFilesAsync

新增于:v1.14 locator.SetInputFilesAsync

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

用法

// Select one file
await page.GetByLabel("Upload file").SetInputFilesAsync("myfile.pdf");

// Select multiple files
await page.GetByLabel("Upload files").SetInputFilesAsync(new[] { "file1.txt", "file12.txt" });

// Select a directory
await page.GetByLabel("Upload directory").SetInputFilesAsync("mydir");

// Remove all the selected files
await page.GetByLabel("Upload file").SetInputFilesAsync(new[] {});

// Upload buffer from memory
await page.GetByLabel("Upload file").SetInputFilesAsync(new FilePayload
{
Name = "file.txt",
MimeType = "text/plain",
Buffer = System.Text.Encoding.UTF8.GetBytes("this is a test"),
});

参数

返回

详情

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

此方法期望 Locator 指向 input 元素。但是,如果元素位于具有关联 control<label> 元素内,则改为定位该控件。


TapAsync

新增于:v1.14 locator.TapAsync

对匹配定位器的元素执行点击手势。有关通过手动分发触摸事件来模拟其他手势的示例,请参阅模拟旧版触摸事件页面。

用法

await Locator.TapAsync(options);

参数

  • options LocatorTapOptions? (可选)
    • Force bool? (可选)#

      是否跳过可操作性检查。默认为 false

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#

      要按下的修饰键。确保在操作期间只按下了这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Trial bool? (可选)#

      设置后,此方法仅执行 可操作性 检查并跳过实际动作。默认为 false。在不执行动作的情况下等待元素就绪时非常有用。请注意,无论 trial 是否设置,键盘 modifiers 都会被按下,以允许测试仅在按下这些键时才可见的元素。

返回

详情

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

  1. 对元素执行操作性检查,除非设置了 Force 选项。
  2. 如果需要,将元素滚动到视图中。
  3. 使用 Page.Touchscreen 点击元素的中心或指定的 Position

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

当所有步骤在指定的 Timeout 内未完成时,此方法会抛出 TimeoutError。传入零超时将禁用此功能。

注意

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


TextContentAsync

新增于:v1.14 locator.TextContentAsync

返回 node.textContent

断言文本

如果你需要对页面上的文本进行断言,请优先使用 Expect(Locator).ToHaveTextAsync() 以避免测试不稳定。更多详情请参阅 断言指南

用法

await Locator.TextContentAsync(options);

参数

返回


UncheckAsync

新增于:v1.14 locator.UncheckAsync

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

用法

await page.GetByRole(AriaRole.Checkbox).UncheckAsync();

参数

  • options LocatorUncheckOptions? (可选)
    • Force bool? (可选)#

      是否跳过可操作性检查。默认为 false

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素填充框左上角的点。如果未指定,则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

    • Trial bool? (可选)#

      设置此项后,该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

返回

详情

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

  1. 确保元素是复选框或单选输入。如果不是,此方法将抛出异常。如果元素已经未选中,此方法将立即返回。
  2. 对元素执行操作性检查,除非设置了 Force 选项。
  3. 如果需要,将元素滚动到视图中。
  4. 使用 Page.Mouse 点击元素中心。
  5. 确保元素现在未选中。如果不是,此方法将抛出异常。

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

当所有步骤在指定的 Timeout 内未完成时,此方法会抛出 TimeoutError。传入零超时将禁用此功能。


WaitForAsync

添加于:v1.16 locator.WaitForAsync

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

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

用法

var orderSent = page.Locator("#order-sent");
orderSent.WaitForAsync();

参数

  • options LocatorWaitForOptions? (可选)
    • State enum WaitForSelectorState { Attached, Detached, Visible, Hidden }? (可选)#

      默认为 'visible'。可以是以下之一:

      • 'attached' - 等待元素出现在 DOM 中。
      • 'detached' - 等待元素不在 DOM 中。
      • 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意,没有任何内容或具有 display:none 的元素具有空的边界框,不被视为可见。
      • 'hidden' - 等待元素从 DOM 中分离,或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。
    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

返回


已弃用

ElementHandleAsync

新增于:v1.14 locator.ElementHandleAsync
不推荐

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

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

用法

await Locator.ElementHandleAsync(options);

参数

返回


ElementHandlesAsync

新增于:v1.14 locator.ElementHandlesAsync
不推荐

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

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

用法

await Locator.ElementHandlesAsync();

返回


TypeAsync

新增于:v1.14 locator.TypeAsync
已弃用

在大多数情况下,您应该改用 Locator.FillAsync()。仅当页面上有特殊的键盘处理逻辑时,才需要逐个按键输入 - 在这种情况下,请使用 Locator.PressSequentiallyAsync()

聚焦元素,然后为文本中的每个字符发送一个 keydownkeypress/inputkeyup 事件。

要按下特殊键(例如 ControlArrowDown),请使用 Locator.PressAsync()

用法

参数

  • text string#

    要输入到聚焦元素的文本。

  • options LocatorTypeOptions? (可选)

    • Delay [float]? (可选)#

      按键之间等待的时间,以毫秒为单位。默认为 0。

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Timeout [float]? (可选)#

      以毫秒为单位的最长等待时间。默认为 30000(30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout()Page.SetDefaultTimeout() 方法来更改。

返回