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? (可选)
- Ref bool? (可选)添加于: v1.52#
  
  为每个元素生成符号引用。捕获快照后，可以立即使用 aria-ref=<ref> 定位器对元素执行操作。
- 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> 元素内，则会清空该控件。

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

返回一个指向与当前定位器相同的 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。这对于等待元素准备就绪而无需执行操作非常有用。请注意，无论是否设置了 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);
// 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 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 #

详细信息

此方法会等待 actionability 检查完成，聚焦到元素，填充值，并在填充后触发一个 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? (可选)#
  
  将方法结果缩小到包含与此相对定位器匹配的元素的那些结果。例如，包含 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。
  
  内部定位器必须相对于外部定位器，并且查询将从外部定位器匹配的元素开始，而不是文档根。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将会失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一个 frame。内部定位器不得包含 FrameLocator。
- HasNot Locator? (可选)新增于: v1.33#
  
  匹配不包含与内部定位器匹配的元素的那些元素。内部定位器是相对于外部定位器查询的。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位器必须属于同一个 frame。内部定位器不得包含 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 时，您可以创建一个 frame 定位器，该定位器将进入 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 中按 label "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

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

用法

例如，考虑以下 DOM 结构。

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

您可以在通过 placeholder 文本定位输入框后填充它

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 role)、ARIA 属性 (ARIA attributes) 和可访问名称 (accessible name) 定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过元素的隐式角色定位每个元素

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

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

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

参数

role enum AriaRole { Alert, Alertdialog, Application, Article, Banner, Blockquote, Button, Caption, Cell, Checkbox, Code, Columnheader, Combobox, Complementary, Contentinfo, Definition, Deletion, Dialog, Directory, Document, Emphasis, Feed, Figure, Form, Generic, Grid, Gridcell, Group, Heading, Img, Insertion, Link, List, Listbox, Listitem, Log, Main, Marquee, Math, Meter, Menu, Menubar, Menuitem, Menuitemcheckbox, Menuitemradio, Navigation, None, Note, Option, Paragraph, Presentation, Progressbar, Radio, Radiogroup, Region, Row, Rowgroup, Rowheader, Scrollbar, Search, Searchbox, Separator, Slider, Spinbutton, Status, Strong, Subscript, Superscript, Switch, Tab, Table, Tablist, Tabpanel, Term, Textbox, Time, Timer, Toolbar, Tooltip, Tree, Treegrid, Treeitem }#

必需的 aria role。
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? (可选)#
  
  控制是否匹配隐藏元素的选项。默认情况下，role 选择器只匹配非隐藏元素，如 ARIA 定义的那样。
  
  了解更多关于 aria-hidden 的信息。
- Level int? (可选)#
  
  通常存在于 heading、listitem、row、treeitem 角色中的数字属性，对于 <h1>-<h6> 元素有默认值。
  
  了解更多关于 aria-level 的信息。
- Name|NameRegex string? | Regex? (可选)#
  
  匹配可访问名称 (accessible name) 的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 Exact 来控制此行为。
  
  了解更多关于可访问名称 (accessible name) 的信息。
- Pressed bool? (可选)#
  
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- Selected bool? (可选)#
  
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected 的信息。

返回值

Locator #

详细信息

Role 选择器不能替代可访问性审计和一致性测试，但它可以对 ARIA 指南提供早期反馈。

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

GetByTestId

新增于: v1.27

locator.GetByTestId

通过 test id 定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过其 test id 定位元素

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

参数

testId string | Regex #

用于定位元素的 id。

返回值

Locator #

详细信息

默认情况下，data-testid 属性用作 test id。如有必要，使用 Selectors.SetTestIdAttribute() 配置不同的 test 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>

您可以在通过 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 #

详细信息

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

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

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

如果在指定的 Timeout 内未完成所有步骤，此方法将抛出 TimeoutError。传入零作为 timeout 会禁用此功能。

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。

文本断言

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

用法

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

返回元素是否被选中。如果元素不是 checkbox 或 radio 输入框，则抛出异常。

断言选中状态

如果您需要断言 checkbox 是否被选中，首选 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

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

断言可编辑状态

如果你需要断言一个元素是可编辑的，优先使用 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 之外的任何元素。
  
  请注意，外部和内部定位器必须属于同一个 frame。内部定位器不得包含 FrameLocator。
- HasNot Locator? (可选)新增于: v1.33#
  
  匹配不包含与内部定位器匹配的元素的那些元素。内部定位器是相对于外部定位器查询的。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位器必须属于同一个 frame。内部定位器不得包含 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

Added in: 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

Added in: 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 animations、CSS transitions 和 Web Animations。动画会根据其持续时间得到不同的处理
  - 有限动画会快进到完成，因此会触发 transitionend 事件。
  - 无限动画会被取消并回到初始状态，然后在截图后重新播放。
  默认为 "allow"，这会不改变动画。
- Caret enum ScreenshotCaret { Hide, Initial }? (可选的)#
  
  当设置为 "hide" 时，屏幕截图将隐藏文本插入符。当设置为 "initial" 时，文本插入符行为不会改变。默认为 "hide"。
- Mask IEnumerable?<Locator> (可选的)#
  
  指定在截屏时应被遮罩的定位器。被遮罩的元素将被一个粉色框 #FF00FF 覆盖（可通过 MaskColor 自定义），该框将完全覆盖其边界框。遮罩也应用于不可见元素，参见只匹配可见元素以禁用此功能。
- MaskColor string? (可选的)Added in: 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? (可选的)Added in: 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> 元素，此方法将抛出错误。但是，如果该元素在具有关联控件的 <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

Added in: 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 指向一个 input 元素。但是，如果该元素在具有关联控件的 <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

不推荐

始终优先使用Locators 和 web assertions，而不是ElementHandles，因为后者本质上存在竞态条件。

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

用法

await Locator.ElementHandleAsync(options);

参数

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

返回值

ElementHandle #

ElementHandlesAsync

添加于: v1.14

locator.ElementHandlesAsync

不推荐

始终优先使用Locators 和 web assertions，而不是ElementHandles，因为后者本质上存在竞态条件。

将给定的定位符解析为所有匹配的 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​

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

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