Locator

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

了解更多关于定位器.

方法

AllAsync

新增于: v1.29

locator.AllAsync

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

注意

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

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

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

用法

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

IReadOnlyList<Locator>#

AllInnerTextsAsync

新增于：v1.14

locator.AllInnerTextsAsync

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

断言文本

如果你需要断言页面上的文本，请首选使用 Expect(Locator).ToHaveTextAsync() 并带有 UseInnerText 选项，以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

IReadOnlyList<string>#

AllTextContentsAsync

新增于：v1.14

locator.AllTextContentsAsync

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

断言文本

如果你需要断言页面上的文本，请首选使用 Expect(Locator).ToHaveTextAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

IReadOnlyList<string>#

And

新增于: v1.34

locator.And

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

用法

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

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

参数

locator Locator #

要匹配的附加定位器。

Locator #

AriaSnapshotAsync

新增于: v1.49

locator.AriaSnapshotAsync

捕获给定元素的 Aria 快照。阅读有关 Aria 快照和相应断言的 Expect(Locator).ToMatchAriaSnapshotAsync() 的更多信息。

用法

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

参数

options LocatorAriaSnapshotOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 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"

BlurAsync

新增于: v1.28

locator.BlurAsync

调用元素的 blur。

用法

await Locator.BlurAsync(options);

参数

options LocatorBlurOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

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);

参数

options LocatorBoundingBoxOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

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。在不执行操作的情况下等待元素准备好进行操作很有用。

void #

详情

执行以下步骤

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

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

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

ClearAsync

新增于: v1.28

locator.ClearAsync

清除输入字段。

用法

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

参数

options LocatorClearOptions? （可选）
- Force bool? （可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool? （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

详情

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

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

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]? （可选）#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 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]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。
- Trial bool? （可选）#
  
  设置后，此方法只执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而不执行它。请注意，无论 trial 如何，都会按下键盘 modifiers 以允许测试仅在按下这些键时可见的元素。

void #

详情

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

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

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

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

ContentFrame

新增于: v1.43

locator.ContentFrame

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

当你获得一个 Locator 对象后，稍后想与框架内的内容交互时，此功能非常有用。

对于反向操作，请使用 FrameLocator.Owner。

用法

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

FrameLocator #

CountAsync

新增于：v1.14

locator.CountAsync

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

断言数量

如果你需要断言页面上元素的数量，请首选使用 Expect(Locator).ToHaveCountAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

int #

DblClickAsync

新增于：v1.14

locator.DblClickAsync

双击元素。

用法

await Locator.DblClickAsync(options);

参数

options LocatorDblClickOptions? （可选）
- Button enum MouseButton { Left, Right, Middle }? （可选）#
  
  默认为 left。
- Delay [float]? （可选）#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 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]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。
- Trial bool? （可选）#
  
  设置后，此方法只执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而不执行它。请注意，无论 trial 如何，都会按下键盘 modifiers 以允许测试仅在按下这些键时可见的元素。

void #

详情

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

等待元素的可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 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 #

定位器描述。

Locator #

DispatchEventAsync

新增于：v1.14

locator.DispatchEventAsync

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

用法

await locator.DispatchEventAsync("click");

参数

type string #

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

可选的事件特定初始化属性。
options LocatorDispatchEventOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

详情

以上代码片段在元素上分发 click 事件。无论元素是否可见，都会分发 click。这等同于调用 element.click()。

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

由于 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]
  在此点（相对于元素内边距框的左上角）点击源元素。如果未指定，则使用元素的某个可见点。
- TargetPosition TargetPosition? （可选）#
  - X [float]
  - Y [float]
  在此点（相对于元素内边距框的左上角）拖放到目标元素。如果未指定，则使用元素的某个可见点。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。
- Trial bool? （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备好进行操作很有用。

void #

详情

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

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 以禁用超时。

JSHandle #

详情

返回 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? （可选）
- Force bool? （可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool? （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

详情

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

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

要发送细粒度的键盘事件，请使用 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> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- HasNot 定位器? (可选)新增于：v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器进行查询的。例如，不包含 div 的 article 匹配 <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#
  
  仅匹配可见或不可见元素。

Locator #

First

新增于：v1.14

locator.First

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

用法

Locator.First

Locator #

FocusAsync

新增于：v1.14

locator.FocusAsync

在匹配的元素上调用 focus。

用法

await Locator.FocusAsync(options);

参数

options LocatorFocusOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

FrameLocator

新增于: v1.17

locator.FrameLocator

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

用法

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

参数

selector string #

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

FrameLocator #

GetAttributeAsync

新增于：v1.14

locator.GetAttributeAsync

返回匹配元素的属性值。

断言属性

如果你需要断言元素的属性，请首选使用 Expect(Locator).ToHaveAttributeAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

await Locator.GetAttributeAsync(name, options);

参数

name string #

要获取值的属性名称。
options LocatorGetAttributeOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

string?#

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。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

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。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

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。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

GetByRole

新增于：v1.27

locator.GetByRole

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

用法

考虑以下 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 的信息。
- Disabled bool? （可选）#
  
  通常由 aria-disabled 或 disabled 设置的属性。
  
  注意
  与大多数其他属性不同，disabled 在 DOM 层次结构中是继承的。了解更多关于 aria-disabled 的信息。
- Exact bool? (可选)新增于: v1.28#
  
  是否精确匹配 Name|NameRegex：区分大小写和完整字符串。默认为 false。当 Name|NameRegex 是正则表达式时忽略。请注意，精确匹配仍然会修剪空格。
- Expanded bool? （可选）#
  
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded 的信息。
- IncludeHidden bool? （可选）#
  
  控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（由 ARIA 定义）由角色选择器匹配。
  
  了解更多关于 aria-hidden 的信息。
- Level int? （可选）#
  
  通常用于角色 heading、listitem、row、treeitem 的数字属性，<h1>-<h6> 元素具有默认值。
  
  了解更多关于 aria-level 的信息。
- Name|NameRegex string? | Regex? （可选）#
  
  匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 Exact 来控制此行为。
  
  了解更多关于可访问名称的信息。
- Pressed bool? （可选）#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- Selected bool? （可选）#
  
  通常由 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 定位元素

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

参数

testId string | Regex #

用于定位元素的 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() { 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。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

详情

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

类型为 button 和 submit 的输入元素通过其 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。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

HighlightAsync

新增于: v1.20

locator.HighlightAsync

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

用法

await Locator.HighlightAsync();

void #

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 以允许测试仅在按下这些键时可见的元素。

void #

详情

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

等待元素的可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 悬停在元素的中心，或指定的 Position。

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

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

InnerHTMLAsync

新增于：v1.14

locator.InnerHTMLAsync

返回 `element.innerHTML`。

用法

await Locator.InnerHTMLAsync(options);

参数

options LocatorInnerHTMLOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

string #

InnerTextAsync

新增于：v1.14

locator.InnerTextAsync

返回 element.innerText。

断言文本

如果你需要断言页面上的文本，请首选使用 Expect(Locator).ToHaveTextAsync() 并带有 UseInnerText 选项，以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

await Locator.InnerTextAsync(options);

参数

options LocatorInnerTextOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

string #

InputValueAsync

新增于：v1.14

locator.InputValueAsync

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

断言值

如果你需要断言输入值，请首选使用 Expect(Locator).ToHaveValueAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

参数

options LocatorInputValueOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

string #

详情

抛出不是 input、textarea 或 select 的元素。但是，如果元素位于具有关联 control 的 <label> 元素内，则返回 control 的值。

IsCheckedAsync

新增于：v1.14

locator.IsCheckedAsync

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

断言选中状态

如果你需要断言复选框是否被选中，请首选使用 Expect(Locator).ToBeCheckedAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

参数

options LocatorIsCheckedOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

bool #

IsDisabledAsync

新增于：v1.14

locator.IsDisabledAsync

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

断言禁用状态

如果你需要断言元素被禁用，请首选使用 Expect(Locator).ToBeDisabledAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

参数

options LocatorIsDisabledOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

bool #

IsEditableAsync

新增于：v1.14

locator.IsEditableAsync

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

断言可编辑状态

如果你需要断言元素可编辑，请首选使用 Expect(Locator).ToBeEditableAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

参数

options LocatorIsEditableOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

bool #

IsEnabledAsync

新增于：v1.14

locator.IsEnabledAsync

返回元素是否已启用。

断言启用状态

如果你需要断言元素已启用，请首选使用 Expect(Locator).ToBeEnabledAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

参数

options LocatorIsEnabledOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

bool #

IsHiddenAsync

新增于：v1.14

locator.IsHiddenAsync

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

断言可见性

如果你需要断言元素被隐藏，请首选使用 Expect(Locator).ToBeHiddenAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

参数

options LocatorIsHiddenOptions? （可选）
- Timeout [float]? （可选）#
  
  已弃用
  此选项被忽略。Locator.IsHiddenAsync() 不会等待元素变为隐藏并立即返回。

bool #

IsVisibleAsync

新增于：v1.14

locator.IsVisibleAsync

返回元素是否可见。

断言可见性

如果你需要断言元素可见，请首选使用 Expect(Locator).ToBeVisibleAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

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

参数

options LocatorIsVisibleOptions? （可选）
- Timeout [float]? （可选）#
  
  已弃用
  此选项被忽略。Locator.IsVisibleAsync() 不会等待元素变为可见并立即返回。

bool #

Last

新增于：v1.14

locator.Last

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

用法

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

Locator #

Locator

新增于：v1.14

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> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- HasNot 定位器? (可选)新增于：v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器进行查询的。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- HasNotText|HasNotTextRegex string? | Regex? （可选）新增于：v1.33#
  
  匹配不包含指定文本（可能在子元素或后代元素中）的元素。当传入 string 时，匹配不区分大小写并搜索子字符串。
- HasText|HasTextRegex string? | Regex? （可选）#
  
  匹配包含指定文本（可能在子元素或后代元素中）的元素。当传入 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

Locator #

Nth

新增于：v1.14

locator.Nth

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

用法

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

参数

index int #

Locator #

Or

新增于：v1.33

locator.Or

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

请注意，当两个定位器都匹配某些内容时，生成的定位器将具有多个匹配项，可能会导致定位器严格性违规。

用法

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

注意

如果“新电子邮件”按钮和安全对话框都出现在屏幕上，“或”定位器将匹配它们两者，可能会抛出 “严格模式违规”错误。在这种情况下，你可以使用 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 #

要匹配的替代定位器。

Locator #

Page

新增于：v1.19

locator.Page

此定位器所属的页面。

用法

Locator.Page

Page #

PressAsync

新增于：v1.14

locator.PressAsync

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

用法

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

参数

key string #

要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。
options LocatorPressOptions? （可选）
- Delay [float]? （可选）#
  
  keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。
- NoWaitAfter bool? （可选）#
  
  已弃用
  此选项将来默认为 true。
  
  启动导航的操作会等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择不等待。只有在导航到无法访问的页面等特殊情况下才需要此选项。默认为 false。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

详情

聚焦元素，然后使用 Keyboard.DownAsync() 和 Keyboard.UpAsync()。

key 可以指定预期的 keyboardEvent.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 键将以大写形式键入与键对应的文本。

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

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

PressSequentiallyAsync

新增于: v1.38

locator.PressSequentiallyAsync

提示

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

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

要按特殊键，例如 Control 或 ArrowDown，请使用 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() 方法进行更改。

void #

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。

byte[]#

详情

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

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

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

ScrollIntoViewIfNeededAsync

新增于：v1.14

locator.ScrollIntoViewIfNeededAsync

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

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

用法

await Locator.ScrollIntoViewIfNeededAsync(options);

参数

options LocatorScrollIntoViewIfNeededOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

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? （可选）
- Force bool? （可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool? （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

IReadOnlyList<string>#

详情

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

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

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

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

SelectTextAsync

新增于：v1.14

locator.SelectTextAsync

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

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

用法

await Locator.SelectTextAsync(options);

参数

options LocatorSelectTextOptions? （可选）
- Force bool? （可选）#
  
  是否绕过可操作性检查。默认为 false。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

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。在不执行操作的情况下等待元素准备好进行操作很有用。

void #

详情

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

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

当所有步骤在指定的 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"),
});

参数

files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#
- Name string
  
  文件名
- MimeType string
  
  文件类型
- Buffer byte[]
  
  文件内容
options LocatorSetInputFilesOptions? （可选）
- NoWaitAfter bool? （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

详情

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

此方法期望定位器指向输入元素。但是，如果元素位于具有关联控制的 <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 以允许测试仅在按下这些键时可见的元素。

void #

详情

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

等待元素上的可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Touchscreen 轻触元素的中心，或指定的 Position。

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

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

注意

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

TextContentAsync

新增于：v1.14

locator.TextContentAsync

返回 node.textContent。

断言文本

如果你需要断言页面上的文本，请首选使用 Expect(Locator).ToHaveTextAsync() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

await Locator.TextContentAsync(options);

参数

options LocatorTextContentOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

string?#

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。在不执行操作的情况下等待元素准备好进行操作很有用。

void #

详情

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

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

如果在操作期间元素从 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() 方法进行更改。

void #

已弃用

ElementHandleAsync

新增于：v1.14

locator.ElementHandleAsync

不推荐

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

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

用法

await Locator.ElementHandleAsync(options);

参数

options LocatorElementHandleOptions? （可选）
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

ElementHandle #

ElementHandlesAsync

新增于：v1.14

locator.ElementHandlesAsync

不推荐

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

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

用法

await Locator.ElementHandlesAsync();

IReadOnlyList<ElementHandle>#

TypeAsync

新增于：v1.14

locator.TypeAsync

已弃用

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

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

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

用法

参数

text string #

要输入到聚焦元素的文本。
options LocatorTypeOptions? （可选）
- Delay [float]? （可选）#
  
  按键之间等待的时间，以毫秒为单位。默认为 0。
- NoWaitAfter bool? （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? （可选）#
  
  最长时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。

void #

方法​

AllAsync​

AllInnerTextsAsync​

AllTextContentsAsync​

And​

AriaSnapshotAsync​

BlurAsync​

BoundingBoxAsync​

CheckAsync​

ClearAsync​

ClickAsync​

ContentFrame​

CountAsync​

DblClickAsync​

Describe​

DispatchEventAsync​

DragToAsync​

EvaluateAsync​

EvaluateAllAsync​

EvaluateHandleAsync​

FillAsync​

Filter​

First​

FocusAsync​

FrameLocator​

GetAttributeAsync​

GetByAltText​

GetByLabel​

GetByPlaceholder​

GetByRole​

GetByTestId​

GetByText​

GetByTitle​

HighlightAsync​

HoverAsync​

InnerHTMLAsync​

InnerTextAsync​

InputValueAsync​

IsCheckedAsync​

IsDisabledAsync​

IsEditableAsync​

IsEnabledAsync​

IsHiddenAsync​

IsVisibleAsync​

Last​

Locator​

Nth​

Or​

Page​

PressAsync​

PressSequentiallyAsync​

ScreenshotAsync​

ScrollIntoViewIfNeededAsync​

SelectOptionAsync​

SelectTextAsync​

SetCheckedAsync​

SetInputFilesAsync​

TapAsync​

TextContentAsync​

UncheckAsync​

WaitForAsync​

已弃用​

ElementHandleAsync​

ElementHandlesAsync​

TypeAsync​

方法

AllAsync

AllInnerTextsAsync

AllTextContentsAsync

And

AriaSnapshotAsync

BlurAsync

BoundingBoxAsync

CheckAsync

ClearAsync

ClickAsync

ContentFrame

CountAsync

DblClickAsync

Describe

DispatchEventAsync

DragToAsync

EvaluateAsync

EvaluateAllAsync

EvaluateHandleAsync

FillAsync

Filter

First

FocusAsync

FrameLocator

GetAttributeAsync

GetByAltText

GetByLabel

GetByPlaceholder

GetByRole

GetByTestId

GetByText

GetByTitle

HighlightAsync

HoverAsync

InnerHTMLAsync

InnerTextAsync

InputValueAsync

IsCheckedAsync

IsDisabledAsync

IsEditableAsync

IsEnabledAsync

IsHiddenAsync

IsVisibleAsync

Last

Locator

Nth

Or

Page

PressAsync

PressSequentiallyAsync

ScreenshotAsync

ScrollIntoViewIfNeededAsync

SelectOptionAsync

SelectTextAsync

SetCheckedAsync

SetInputFilesAsync

TapAsync

TextContentAsync

UncheckAsync

WaitForAsync

已弃用

ElementHandleAsync

ElementHandlesAsync

TypeAsync