跳到主要内容

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

返回值

AllInnerTextsAsync​

添加于: v1.14 locator.AllInnerTextsAsync

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

断言文本

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

用法

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

返回值

AllTextContentsAsync​

添加于: v1.14 locator.AllTextContentsAsync

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

断言文本

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

用法

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

返回值

And​

添加于: v1.34 locator.And

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

用法

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

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

参数

  • locator Locator#

    要匹配的附加定位器。

返回值

AriaSnapshotAsync​

添加于: v1.49 locator.AriaSnapshotAsync

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

用法

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

参数

返回值

详情

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

参数

返回值

BoundingBoxAsync​

添加于: v1.14 locator.BoundingBoxAsync

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

用法

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

参数

返回值

  • BoundingBox?#

    • x [float]

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

    • y [float]

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

    • width [float]

      元素的宽度，以像素为单位。

    • height [float]

      元素的高度，以像素为单位。

详情

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

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

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

CheckAsync​

添加于: v1.14 locator.CheckAsync

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

用法

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

参数

  • options LocatorCheckOptions? (可选)

    • Force bool? (可选)#

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

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      最大时间（毫秒）。默认为 30000 毫秒（30 秒）。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool? (可选)#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备就绪时很有用。

返回值

详情

执行以下步骤

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

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

当所有步骤组合在一起在指定的 Timeout 期间未完成时，此方法将抛出 TimeoutError。传递零超时将禁用此功能。

ClearAsync​

添加于: v1.28 locator.ClearAsync

清除输入字段。

用法

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

参数

  • options LocatorClearOptions? (可选)

返回值

详情

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

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果元素位于具有关联 控件 的 <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 设置如何，都会按下键盘修饰键，以允许测试仅在按下这些键时才可见的元素。

返回值

详情

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

  1. 等待元素的可操作性检查，除非设置了 Force 选项。
  2. 如果需要，滚动元素到视图中。
  3. 使用 Page.Mouse 在元素中心或指定的 Position 中单击。
  4. 等待启动的导航成功或失败，除非设置了 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();

返回值

CountAsync​

添加于: v1.14 locator.CountAsync

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

断言计数

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

用法

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

返回值

DblClickAsync​

添加于: v1.14 locator.DblClickAsync

双击一个元素。

用法

await Locator.DblClickAsync(options);

参数

  • options LocatorDblClickOptions? (可选)

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

      默认为 left。

    • Delay [float]? (可选)#

      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 设置如何，都会按下键盘修饰键，以允许测试仅在按下这些键时才可见的元素。

返回值

详情

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

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

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

当所有步骤组合在一起在指定的 Timeout 期间未完成时，此方法将抛出 TimeoutError。传递零超时将禁用此功能。

注意

element.dblclick() 调度两个 click 事件和一个 dblclick 事件。

DispatchEventAsync​

添加于: v1.14 locator.DispatchEventAsync

以编程方式在匹配的元素上调度事件。

用法

await locator.DispatchEventAsync("click");

参数

返回值

详情

上面的代码片段在元素上调度 click 事件。无论元素的可见性状态如何，都会调度 click 事件。这等效于调用 element.click()。

在底层，它基于给定的 type 创建一个事件实例，使用 eventInit 属性初始化它，并在元素上调度它。事件默认是 composed、cancelable 和 bubble 的。

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

返回值

详情

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

EvaluateAsync​

添加于: v1.14 locator.EvaluateAsync

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

用法

参数

  • expression string#

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

  • arg EvaluationArgument? (可选)#

    要传递给 expression 的可选参数。

  • options LocatorEvaluateOptions? (可选)

返回值

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

返回值

详情

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

Locator.EvaluateAsync() 和 Locator.EvaluateHandleAsync() 之间的唯一区别在于，Locator.EvaluateHandleAsync() 返回 JSHandle。

如果 expression 返回一个 Promise，此方法将等待 Promise resolve 并返回其值。

如果 expression 抛出错误或 reject，此方法也会抛出错误。

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

FillAsync​

添加于: v1.14 locator.FillAsync

为输入字段设置值。

用法

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

参数

  • value string#

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

  • options LocatorFillOptions? (可选)

返回值

详情

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

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

要发送细粒度的键盘事件，请使用 Locator.PressSequentiallyAsync()。

Filter​

添加于版本: v1.22 locator.Filter

此方法根据选项缩小现有 locator 的范围，例如按文本进行过滤。它可以链式调用以进行多次过滤。

用法

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

      将方法的結果缩小到那些包含与此相对 locator 匹配的元素的元素。例如，article 包含 text=Playwright 将匹配 <article><div>Playwright</div></article>。

      内部 locator **必须相对于** 外部 locator，并且查询从外部 locator 匹配项开始，而不是从文档根目录开始。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将会失败，因为内部 locator 必须是相对的，并且不应使用 content 之外的任何元素。

      请注意，外部和内部 locator 必须属于同一 frame。内部 locator 不得包含 FrameLocator。

    • HasNot Locator? (可选)添加于版本: v1.33#

      匹配不包含与内部 locator 匹配的元素的元素。内部 locator 针对外部 locator 进行查询。例如，不包含 div 的 article 将匹配 <article><span>Playwright</span></article>。

      请注意，外部和内部 locator 必须属于同一 frame。内部 locator 不得包含 FrameLocator。

    • HasNotText|HasNotTextRegex string? | Regex? (可选)添加于版本: v1.33#

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

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

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

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

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

返回值

First​

添加于: v1.14 locator.First

返回指向第一个匹配元素的 locator。

用法

Locator.First

返回值

FocusAsync​

添加于: v1.14 locator.FocusAsync

在匹配的元素上调用 focus。

用法

await Locator.FocusAsync(options);

参数

返回值

FrameLocator​

添加于版本: v1.17 locator.FrameLocator

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

用法

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

参数

  • selector string#

    解析 DOM 元素时要使用的选择器。

返回值

GetAttributeAsync​

添加于: v1.14 locator.GetAttributeAsync

返回匹配元素的属性值。

断言属性

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

用法

await Locator.GetAttributeAsync(name, options);

参数

返回值

GetByAltText​

添加于版本: v1.27 locator.GetByAltText

允许通过元素的 alt 文本定位元素。

用法

例如，此方法将通过 alt 文本 "Playwright logo" 找到图像

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

参数

  • text string | Regex#

    用于定位元素的文本。

  • options LocatorGetByAltTextOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配项：区分大小写和全字符串匹配。默认为 false。当通过正则表达式定位时，此选项将被忽略。请注意，完全匹配仍然会修剪空格。

返回值

GetByLabel​

添加于版本: v1.27 locator.GetByLabel

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

用法

例如，此方法将在以下 DOM 中通过标签 "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。当通过正则表达式定位时，此选项将被忽略。请注意，完全匹配仍然会修剪空格。

返回值

GetByPlaceholder​

添加于版本: v1.27 locator.GetByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

您可以在通过占位符文本定位输入框后，填充该输入框

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

参数

  • text string | Regex#

    用于定位元素的文本。

  • options LocatorGetByPlaceholderOptions? (可选)

    • Exact bool? (可选)#

      是否查找完全匹配项：区分大小写和全字符串匹配。默认为 false。当通过正则表达式定位时，此选项将被忽略。请注意，完全匹配仍然会修剪空格。

返回值

GetByRole​

添加于版本: v1.27 locator.GetByRole

允许通过元素的 ARIA role，ARIA 属性 和 可访问名称 定位元素。

用法

考虑以下 DOM 结构。

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

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

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

      通常用于 role 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。

返回值

详情

Role 选择器**不能替代**可访问性审计和一致性测试，而是提供有关 ARIA 指南的早期反馈。

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

GetByTestId​

添加于版本: v1.27 locator.GetByTestId

通过测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过元素的测试 ID 定位该元素

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

参数

返回值

详情

默认情况下，data-testid 属性用作测试 ID。如果需要配置不同的测试 ID 属性，请使用 Selectors.SetTestIdAttribute()。

GetByText​

添加于版本: v1.27 locator.GetByText

允许定位包含给定文本的元素。

另请参阅 Locator.Filter()，它允许通过其他条件（例如可访问的 role）进行匹配，然后再按文本内容进行过滤。

用法

考虑以下 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。当通过正则表达式定位时，此选项将被忽略。请注意，完全匹配仍然会修剪空格。

返回值

详情

即使使用完全匹配，按文本匹配始终会规范化空格。例如，它将多个空格变成一个空格，将换行符变成空格，并忽略前导和尾随空格。

类型为 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。当通过正则表达式定位时，此选项将被忽略。请注意，完全匹配仍然会修剪空格。

返回值

HighlightAsync​

添加于版本: v1.20 locator.HighlightAsync

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

用法

await Locator.HighlightAsync();

返回值

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 设置如何，都会按下键盘修饰键，以允许测试仅在按下这些键时才可见的元素。

返回值

详情

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

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

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

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

InnerHTMLAsync​

添加于: v1.14 locator.InnerHTMLAsync

返回 element.innerHTML。

用法

await Locator.InnerHTMLAsync(options);

参数

返回值

InnerTextAsync​

添加于: v1.14 locator.InnerTextAsync

返回 element.innerText。

断言文本

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

用法

await Locator.InnerTextAsync(options);

参数

返回值

InputValueAsync​

添加于: v1.14 locator.InputValueAsync

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

断言值

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

用法

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

参数

返回值

详情

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

IsCheckedAsync​

添加于: v1.14 locator.IsCheckedAsync

返回元素是否被选中。如果元素不是复选框或单选输入框，则抛出错误。

断言选中状态

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

用法

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

参数

返回值

IsDisabledAsync​

添加于: v1.14 locator.IsDisabledAsync

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

断言禁用状态

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

用法

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

参数

返回值

IsEditableAsync​

添加于: v1.14 locator.IsEditableAsync

返回元素是否为 editable。如果目标元素不是 <input>、<textarea>、<select>、[contenteditable] 且没有 role 允许 [aria-readonly]，则此方法会抛出错误。

断言可编辑状态

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

用法

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

参数

返回值

IsEnabledAsync​

添加于: v1.14 locator.IsEnabledAsync

返回元素是否已启用。

断言启用状态

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

用法

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

参数

返回值

IsHiddenAsync​

添加于: v1.14 locator.IsHiddenAsync

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

断言可见性

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

用法

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

参数

  • options LocatorIsHiddenOptions? (可选)

    • Timeout [float]? (可选)#

      已弃用

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

返回值

IsVisibleAsync​

添加于: v1.14 locator.IsVisibleAsync

返回元素是否可见。

断言可见性

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

用法

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

参数

  • options LocatorIsVisibleOptions? (可选)

    • Timeout [float]? (可选)#

      已弃用

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

返回值

Last​

添加于: v1.14 locator.Last

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

用法

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

返回值

Locator​

添加于: v1.14 locator.Locator

此方法在定位器的子树中查找与指定选择器匹配的元素。它还接受筛选选项，类似于 Locator.Filter() 方法。

了解更多关于定位器的信息.

用法

Locator.Locator(selectorOrLocator, options);

参数

  • selectorOrLocator string | Locator#

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

  • options LocatorLocatorOptions? (可选)

    • Has Locator? (可选)#

      将方法的結果缩小到那些包含与此相对 locator 匹配的元素的元素。例如，article 包含 text=Playwright 将匹配 <article><div>Playwright</div></article>。

      内部 locator **必须相对于** 外部 locator，并且查询从外部 locator 匹配项开始，而不是从文档根目录开始。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将会失败，因为内部 locator 必须是相对的，并且不应使用 content 之外的任何元素。

      请注意，外部和内部 locator 必须属于同一 frame。内部 locator 不得包含 FrameLocator。

    • HasNot Locator? (可选)添加于版本: v1.33#

      匹配不包含与内部 locator 匹配的元素的元素。内部 locator 针对外部 locator 进行查询。例如，不包含 div 的 article 将匹配 <article><span>Playwright</span></article>。

      请注意，外部和内部 locator 必须属于同一 frame。内部 locator 不得包含 FrameLocator。

    • HasNotText|HasNotTextRegex string? | Regex? (可选)添加于版本: v1.33#

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

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

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

返回值

Nth​

添加于: v1.14 locator.Nth

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

用法

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

参数

返回值

Or​

添加于版本: v1.33 locator.Or

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

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

用法

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

注意

如果“新邮件”按钮和安全对话框都出现在屏幕上，“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#

    要匹配的备用定位器。

返回值

Page​

添加于版本：v1.19 locator.Page

此定位器所属的页面。

用法

Locator.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() 方法更改。

返回值

详情

聚焦元素，然后使用 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"); // Types instantly
await locator.PressSequentiallyAsync("World", new() { Delay = 100 }); // Types slower, like a user

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

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

参数

  • text string#

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

  • options LocatorPressSequentiallyOptions? (可选)

    • Delay [float]? (可选)#

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

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Timeout [float]? (可选)#

      最大时间（毫秒）。默认为 30000 毫秒（30 秒）。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

ScreenshotAsync​

添加于: v1.14 locator.ScreenshotAsync

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

用法

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

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

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

参数

  • options LocatorScreenshotOptions? (可选)

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

      当设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。动画根据其持续时间获得不同的处理方式

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

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

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

      当设置为 "hide" 时，屏幕截图将隐藏文本光标。当设置为 "initial" 时，文本光标行为将不会更改。默认为 "hide"。

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

      指定在拍摄屏幕截图时应遮罩的定位器。遮罩元素将覆盖一个粉红色框 #FF00FF（由 MaskColor 自定义），该框完全覆盖其边界框。遮罩也适用于不可见元素，请参阅仅匹配可见元素以禁用该功能。

    • MaskColor string? (可选)添加于版本：v1.35#

      指定遮罩元素的覆盖框颜色，采用 CSS 颜色格式。默认颜色为粉红色 #FF00FF。

    • OmitBackground bool? (可选)#

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

    • Path string? (可选)#

      用于保存图像的文件路径。屏幕截图类型将从文件扩展名中推断出来。如果 Path 是相对路径，则它相对于当前工作目录解析。如果未提供路径，则图像不会保存到磁盘。

    • Quality int? (可选)#

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

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

      当设置为 "css" 时，屏幕截图的每个 css 像素将有一个像素。对于高 dpi 设备，这将使屏幕截图保持较小。使用 "device" 选项将使每个设备像素生成一个像素，因此高 dpi 设备的屏幕截图将大两倍甚至更大。

      默认为 "device"。

    • Style string? (可选)添加于版本：v1.41#

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

    • Timeout [float]? (可选)#

      最大时间（毫秒）。默认为 30000 毫秒（30 秒）。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

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

      指定屏幕截图类型，默认为 png。

返回值

详情

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

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

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

ScrollIntoViewIfNeededAsync​

添加于: v1.14 locator.ScrollIntoViewIfNeededAsync

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

有关滚动的替代方法，请参阅滚动。

用法

await Locator.ScrollIntoViewIfNeededAsync(options);

参数

返回值

SelectOptionAsync​

添加于: v1.14 locator.SelectOptionAsync

在 <select> 中选择一个或多个选项。

用法

<select multiple>
  <option value="red">Red</option>
  <option value="green">Green</option>
  <option value="blue">Blue</option>
</select>
// single selection matching the value or label
await element.SelectOptionAsync(new[] { "blue" });
// single selection matching the label
await element.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection for blue, red and second option
await element.SelectOptionAsync(new[] { "red", "green", "blue" });

参数

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

    • Value string? (可选)

      按 option.value 匹配。可选。

    • Label string? (可选)

      按 option.label 匹配。可选。

    • Index int? (可选)

      按索引匹配。可选。

    要选择的选项。如果 <select> 具有 multiple 属性，则选择所有匹配的选项，否则仅选择与传递的选项之一匹配的第一个选项。字符串值同时匹配值和标签。如果所有指定的属性都匹配，则认为选项匹配。
  • options LocatorSelectOptionOptions? (可选)

返回值

详情

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

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

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

在所有提供的选项都已选择后，触发 change 和 input 事件。

SelectTextAsync​

添加于: v1.14 locator.SelectTextAsync

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

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

用法

await Locator.SelectTextAsync(options);

参数

返回值

SetCheckedAsync​

添加于版本：v1.15 locator.SetCheckedAsync

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

用法

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

参数

  • checkedState bool#

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

  • options LocatorSetCheckedOptions? (可选)

    • Force bool? (可选)#

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

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      最大时间（毫秒）。默认为 30000 毫秒（30 秒）。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool? (可选)#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备就绪时很有用。

返回值

详情

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

  1. 确保匹配的元素是复选框或单选输入。如果不是，则此方法会抛出错误。
  2. 如果元素已具有正确的选中状态，则此方法立即返回。
  3. 等待匹配元素上的可操作性检查，除非设置了 Force 选项。如果在检查期间元素分离，则会重试整个操作。
  4. 如果需要，滚动元素到视图中。
  5. 使用 Page.Mouse 在元素中心单击。
  6. 确保元素现在已选中或取消选中。如果不是，则此方法会抛出错误。

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

SetInputFilesAsync​

添加于: v1.14 locator.SetInputFilesAsync

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

用法

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

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

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

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

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

参数

返回值

详情

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

此方法期望 Locator 指向 input 元素。但是，如果元素位于具有关联控件的 <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 设置如何，都会按下键盘修饰键，以允许测试仅在按下这些键时才可见的元素。

返回值

详情

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

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

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

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

注意

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

TextContentAsync​

添加于: v1.14 locator.TextContentAsync

返回 node.textContent。

断言文本

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

用法

await Locator.TextContentAsync(options);

参数

返回值

UncheckAsync​

添加于: v1.14 locator.UncheckAsync

确保取消选中复选框或单选按钮元素。

用法

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

参数

  • options LocatorUncheckOptions? (可选)

    • Force bool? (可选)#

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

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。

    • Timeout [float]? (可选)#

      最大时间（毫秒）。默认为 30000 毫秒（30 秒）。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool? (可选)#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。在不执行操作的情况下等待元素准备就绪时很有用。

返回值

详情

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

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

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

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

WaitForAsync​

添加于：v1.16 locator.WaitForAsync

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

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

用法

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

参数

  • options LocatorWaitForOptions? (可选)

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

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

      • 'attached' - 等待元素出现在 DOM 中。
      • 'detached' - 等待元素不出现在 DOM 中。
      • 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空的边界框，并且不被认为是可见的。
      • 'hidden' - 等待元素从 DOM 中分离，或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。

    • Timeout [float]? (可选)#

      最大时间（毫秒）。默认为 30000 毫秒（30 秒）。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

已弃用​

ElementHandleAsync​

添加于: v1.14 locator.ElementHandleAsync
不推荐使用

始终首选使用 Locator 和 Web 断言，而不是 ElementHandle，因为后者本质上是竞态的。

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

用法

await Locator.ElementHandleAsync(options);

参数

返回值

ElementHandlesAsync​

添加于: v1.14 locator.ElementHandlesAsync
不推荐使用

始终首选使用 Locator 和 Web 断言，而不是 ElementHandle，因为后者本质上是竞态的。

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

用法

await Locator.ElementHandlesAsync();

返回值

TypeAsync​

添加于: v1.14 locator.TypeAsync
已弃用

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

聚焦元素，然后为文本中的每个字符发送 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() 方法更改。

返回值