定位器

定位器是 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();

返回值

IEnumerable<Locator>#

AllInnerTextsAsync

新增于：v1.14

locator.AllInnerTextsAsync

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

断言文本

如果您需要断言页面上的文本，请优先使用 Expect(Locator).ToHaveTextAsync() 以及 UseInnerText 选项来避免不稳定性。有关详细信息，请参阅断言指南。

用法

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

返回值

IEnumerable<string>#

AllTextContentsAsync

新增于：v1.14

locator.AllTextContentsAsync

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

断言文本

如果您需要断言页面上的文本，请优先使用 Expect(Locator).ToHaveTextAsync() 来避免不稳定性。有关详细信息，请参阅断言指南。

用法

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

返回值

IEnumerable<string>#

And

新增于：v1.34

locator.And

创建一个定位器，匹配此定位器和参数定位器。

用法

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

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

参数

locator Locator #

要匹配的额外定位器。

返回值

Locator #

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 中分离，则此方法将抛出异常。

如果所有步骤在指定的时间内没有完成超时，则此方法将抛出 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。有助于等待元素准备好执行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试仅在按下这些键时可见的元素。

返回值

void #

详细信息

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

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

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

如果所有步骤在指定的时间内没有完成超时，则此方法将抛出 TimeoutError。传递零超时将禁用此功能。

ContentFrame

添加于：v1.43

locator.ContentFrame

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

当您从某个地方获得一个 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。有助于等待元素准备好执行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试仅在按下这些键时可见的元素。

返回值

void #

详细信息

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

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

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

如果所有步骤在指定的时间内没有完成超时，则此方法将抛出 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);
// 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 代码，并将匹配的元素作为参数。

用法

var tweets = page.Locator(".tweet .retweets");
Assert.AreEqual("10 retweets", await tweets.EvaluateAsync("node => node.innerText"));

参数

expression string #

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

要传递给 expression 的可选参数。
options LocatorEvaluateOptions? (可选)
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传递 0 来禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

[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 来禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

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> 元素内部，则将填充该控件。

要发送细粒度的键盘事件，请使用 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>。

返回值

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

允许通过其替代文本定位元素。

用法

例如，此方法将通过替代文本“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 属性定位输入元素。

用法

例如，此方法将通过标签“Username”和“Password”找到以下 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="[email protected]" />

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

await page
    .GetByPlaceholder("[email protected]")
    .FillAsync("[email protected]");

参数

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 而不是文本内容进行匹配。例如，通过文本 "Log in" 定位匹配 <input type=button value="Log in">。

GetByTitle

添加时间：v1.27

locator.GetByTitle

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

用法

考虑以下 DOM 结构。

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

你可以通过标题文本定位元素后检查问题数量。

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

返回值

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> 元素内，则返回 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

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

断言禁用状态

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

返回元素是否可编辑。

断言可编辑状态

如果您需要断言元素可编辑，请优先使用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 个匹配元素的定位器。它是从零开始的，nth(0) 选择第一个元素。

用法

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

参数

index int #

返回值

Locator #

Or

添加于：v1.33

locator.Or

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

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

用法

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

var newEmail = page.GetByRole(AriaRole.Button, new() { Name = "New" });
var dialog = page.GetByText("Confirm security settings");
await Expect(newEmail.Or(dialog)).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 对应的文本。

如果键是单个字符，则区分大小写，因此值 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</div>
  <option value="green">Green</div>
  <option value="blue">Blue</div>
</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() 方法更改默认值。

返回值

IEnumerable<string>#

详细信息

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

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

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

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

SelectTextAsync

新增于：v1.14

locator.SelectTextAsync

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

如果元素位于具有关联控制的<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是相对路径，则它们将相对于当前工作目录解析。对于空数组，将清除选定的文件。

此方法期望Locator指向一个输入元素。但是，如果元素位于具有关联控制的<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。有助于等待元素准备好执行操作，而无需执行操作。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试仅在按下这些键时可见的元素。

返回值

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

返回值

IEnumerable<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​

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​

PressSequentiallyAsync​

ScreenshotAsync​

ScrollIntoViewIfNeededAsync​

SelectOptionAsync​

SelectTextAsync​

SetCheckedAsync​

SetInputFilesAsync​

TapAsync​

TextContentAsync​

UncheckAsync​

WaitForAsync​

已弃用​

ElementHandleAsync​

ElementHandlesAsync​

TypeAsync​

方法

AllAsync

AllInnerTextsAsync

AllTextContentsAsync

And

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

PressSequentiallyAsync

ScreenshotAsync

ScrollIntoViewIfNeededAsync

SelectOptionAsync

SelectTextAsync

SetCheckedAsync

SetInputFilesAsync

TapAsync

TextContentAsync

UncheckAsync

WaitForAsync

已弃用

ElementHandleAsync

ElementHandlesAsync

TypeAsync