Locator

定位器（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 值组成的数组。

断言文本

如果需要在页面上断言文本，建议使用带 UseInnerText 选项的 Expect(Locator).ToHaveTextAsync()，以避免出现不稳定情况。更多详细信息，请参阅断言指南。

用法

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] 元素，此方法将抛出错误。但是，如果该元素在具有关联控件的 <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]?（可选）#
  
  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 事件。

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);
// 或者指定相对于元素左上角的精确位置：
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); // 输出 "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] 元素，此方法将抛出错误。但是，如果该元素位于具有关联控件的 <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?（可选）#
  
  将方法的结果范围缩小到包含与该相对定位器匹配的元素的结果。例如，有 text=Playwright 的 article 与 <article><div>Playwright</div></article> 匹配。
  
  内部定位器 必须相对于 外部定位器，并且从外部定位器匹配的位置开始查询，而不是从文档根目录开始。例如，在 <article><content><div>Playwright</div></content></article> 中，你可以找到有 div 的 content。但是，查找有 article div 的 content 会失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator。
- HasNot Locator? 新增于：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 text）定位元素。

用法

例如，此方法将通过替代文本“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 中按标签“Username”和“Password”查找输入框：

<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>注册</h3>
<label>
  <input type="checkbox" /> 订阅
</label>
<br/>
<button>提交</button>

你可以通过每个元素的隐式角色来定位它们：

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

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

await page
    .GetByRole(AriaRole.Button, new() {
        NameRegex = new Regex("提交", 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>

你可以通过文本子字符串、精确字符串或正则表达式进行定位：

// 匹配 <span>
page.GetByText("world");

// 匹配第一个 <div>
page.GetByText("Hello world");

// 匹配第二个 <div>
page.GetByText("Hello", new() { Exact = true });

// 匹配两个 <div>
page.GetByText(new Regex("Hello"));

// 匹配第二个 <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='问题数量'>25 个问题</span>

通过标题文本定位后，你可以检查问题数量：

await Expect(Page.GetByTitle("问题数量")).toHaveText("25 个问题");

参数

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 #

详细信息

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

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

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

断言禁用状态

如果需要断言元素已禁用，建议使用 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?（可选）#
  
  将该方法的结果范围缩小到包含与这个相对定位器匹配的元素。例如，有 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。
  
  内部定位器 必须相对于 外部定位器，并且从外部定位器匹配的位置开始查询，而不是从文档根开始。例如，你可以在 <article><content><div>Playwright</div></content></article> 中找到有 div 的 content。但是，查找有 article div 的 content 会失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一框架。内部定位器不能包含 FrameLocator。
- HasNot Locator? 新增于：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 个匹配元素。索引从 0 开始，nth(0) 选择第一个元素。

用法

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

参数

index int #

返回值

Locator #

Or

添加于：v1.33

locator.Or

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

请注意，当两个定位器都匹配某些内容时，结果定位器将有多个匹配项，这可能会导致定位器严格性冲突。

用法

假设有这样一种场景：你想要点击“新建邮件”按钮，但有时会弹出一个安全设置对话框。在这种情况下，你可以等待“新建邮件”按钮或对话框出现，然后采取相应的行动。

备注

如果“新建邮件”按钮和安全对话框同时出现在屏幕上，“或”定位器（or locator）会匹配到它们两者，这可能会抛出“严格模式违规”错误。在这种情况下，你可以使用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 值，或指定一个字符以生成相应文本。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"` 之类的快捷键。当与修饰键一起指定时，按下后续键时，修饰键将被按下并保持按下状态。

PressSequentiallyAsync

新增于：v1.38

locator.PressSequentiallyAsync

提示

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

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

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

用法

await locator.PressSequentiallyAsync("Hello"); // 立即输入
await locator.PressSequentiallyAsync("World", new() { Delay = 100 }); // 输入速度较慢，类似用户输入

在文本字段中输入内容然后提交表单的示例：

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">红色</option>
  <option value="green">绿色</option>
  <option value="blue">蓝色</option>
</select>

// 选择匹配值或标签的单个选项
await element.SelectOptionAsync(new[] { "blue" });
// 选择匹配标签的单个选项
await element.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// 选择蓝色、红色和第二个选项的多个选项
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] 属性的输入框，仅支持单个目录路径。

用法

// 选择单个文件
await page.GetByLabel("Upload file").SetInputFilesAsync("myfile.pdf");

// 选择多个文件
await page.GetByLabel("Upload files").SetInputFilesAsync(new[] { "file1.txt", "file12.txt" });

// 选择一个目录
await page.GetByLabel("Upload directory").SetInputFilesAsync("mydir");

// 移除所有选定的文件
await page.GetByLabel("Upload file").SetInputFilesAsync(new[] {});

// 从内存中上传缓冲区
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 是相对路径，则它们将相对于当前工作目录进行解析。对于空数组，将清除选定的文件。

此方法要求 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，以便测试仅在按下这些键时才可见的元素。

返回值

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 和网页断言，而不是 ElementHandle，因为后者本质上是竞争的。

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

用法

await Locator.ElementHandleAsync(options);

参数

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

返回值

ElementHandle #

ElementHandlesAsync

添加于：v1.14

locator.ElementHandlesAsync

不推荐

始终优先使用 Locator 和网页断言，而不是 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​

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​

用法​

也支持诸如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 之类的快捷键。当与修饰键一起指定时，按下后续键时，修饰键将被按下并保持按下状态。​

PressSequentiallyAsync​

ScreenshotAsync​

ScrollIntoViewIfNeededAsync​

SelectOptionAsync​

SelectTextAsync​

SetCheckedAsync​

SetInputFilesAsync​

TapAsync​

TextContentAsync​

方法

AllAsync

AllInnerTextsAsync

AllTextContentsAsync

And

AriaSnapshotAsync

BlurAsync

BoundingBoxAsync

CheckAsync

ClearAsync

参数

返回值

详细信息

ClickAsync

ContentFrame

CountAsync

DblClickAsync

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

用法

也支持诸如 `key: "Control+o"`、`key: "Control++` 或 `key: "Control+Shift+T"` 之类的快捷键。当与修饰键一起指定时，按下后续键时，修饰键将被按下并保持按下状态。

PressSequentiallyAsync

ScreenshotAsync

ScrollIntoViewIfNeededAsync

SelectOptionAsync

SelectTextAsync

SetCheckedAsync

SetInputFilesAsync

TapAsync

TextContentAsync