定位器

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

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

方法​

AllAsync​

当定位器指向一组元素时，这将返回一个定位器数组，分别指向各自的元素。

用法

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

返回

• IEnumerable<Locator>#

AllInnerTextsAsync​

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

用法

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

返回

• IEnumerable<string>#

AllTextContentsAsync​

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

用法

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

返回

• IEnumerable<string>#

并且​

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

用法

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

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

参数

• locator Locator#

  要匹配的附加定位器。

返回

• 定位器#

AriaSnapshotAsync​

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

用法

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

参数

• options LocatorAriaSnapshotOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• string#

详情

此方法捕获给定元素的ARIA快照。该快照是一个字符串，表示元素及其子元素的状态。快照可用于在测试中断言元素的状态，或与未来的状态进行比较。

ARIA快照使用YAML标记语言表示：

• 对象的键是元素的角色和可选的可访问名称。
• 这些值可以是文本内容或子元素数组。
• 通用静态文本可以用text键表示。

Below is the HTML markup and the respective ARIA snapshot:

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

在元素上调用blur。

用法

await Locator.BlurAsync(options);

参数

• options LocatorBlurOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• void#

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? (optional)

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

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

用法

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

参数

• options LocatorCheckOptions? (optional)

  • Force bool? (可选)#

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

  • NoWaitAfter bool? (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • Position 位置？(可选)#

    • X [浮点数]

    • Y [浮点数]

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

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选)#

    当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作但又不实际执行该操作的情况。

返回

• void#

详情

执行以下步骤：

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

如果在操作过程中元素从DOM中分离，该方法会抛出异常。

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

ClearAsync​

清空输入字段。

用法

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

参数

• options LocatorClearOptions? (optional)

  • Force bool? (可选)#

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

  • NoWaitAfter bool? (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• void#

详情

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

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

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? (optional)

  • 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 位置？(可选)#

    • X [浮点数]

    • Y [浮点数]

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

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选)#

    当设置此参数时，该方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作但又不实际执行的情况。请注意，无论trial设置如何，键盘modifiers都会被按下，以便测试那些只有在按下这些键时才可见的元素。

返回

• void#

详情

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

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

如果在操作过程中元素从DOM中分离，该方法会抛出异常。

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

内容框架​

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

当您已从某处获取了一个Locator对象，并希望稍后与框架内的内容进行交互时，这非常有用。

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

用法

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

返回

• FrameLocator#

CountAsync​

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

用法

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

返回

• int#

DblClickAsync​

双击一个元素。

用法

await Locator.DblClickAsync(options);

参数

• options LocatorDblClickOptions? (optional)

  • 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 位置？(可选)#

    • X [浮点数]

    • Y [浮点数]

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

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选)#

    当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作而无需实际执行的情况。请注意，无论trial如何设置，键盘modifiers都会被按下，以便测试那些仅在按下这些键时才可见的元素。

返回

• void#

详情

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

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

如果在操作过程中元素从DOM中分离，该方法会抛出异常。

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

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是事件特定的，请参阅事件文档以获取初始属性列表：

• DeviceMotionEvent
• DeviceOrientationEvent
• DragEvent
• 事件
• FocusEvent
• KeyboardEvent
• MouseEvent
• PointerEvent
• TouchEvent
• WheelEvent

如果希望将实时对象传递到事件中，您还可以将JSHandle指定为属性值：

var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await locator.DispatchEventAsync("dragstart", new Dictionary<string, object>
{
    { "dataTransfer", dataTransfer }
});

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 [浮点数]

    • Y [浮点数]

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

  • TargetPosition TargetPosition? (可选)#

    • X [浮点数]

    • Y [浮点数]

    在目标元素的这一点上相对于元素内边距框的左上角进行拖放。如果未指定，则使用元素的某个可见点。

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选)#

    当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作但又不实际执行该操作的情况。

返回

• void#

详情

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

EvaluateAsync​

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

用法

参数

• expression string#

  将在浏览器上下文中评估的JavaScript表达式。如果表达式评估为一个函数，该函数将自动被调用。

• arg EvaluationArgument? (可选)#

  传递给expression的可选参数。

• options LocatorEvaluateOptions? (可选)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• [对象]#

详情

返回expression的返回值，该表达式以匹配元素作为第一个参数，arg作为第二个参数调用。

如果expression返回一个Promise，该方法将等待promise解析并返回其值。

如果expression抛出或拒绝，此方法将抛出异常。

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的可选参数。

返回

• [对象]#

详情

返回expression的返回值，该表达式以所有匹配元素的数组作为第一个参数，arg作为第二个参数调用。

如果expression返回一个Promise，该方法将等待promise解析并返回其值。

如果expression抛出或拒绝，此方法将抛出异常。

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​

为输入字段设置一个值。

用法

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

筛选器​

该方法根据选项缩小现有定位器的范围，例如通过文本进行过滤。可以链式调用以多次过滤。

用法

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? (optional)

  • Has Locator? (可选)#

    将方法的结果范围缩小到包含匹配此相对定位器的元素。例如，article 包含 text=Playwright 会匹配 <article><div>Playwright</div></article>。

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

    请注意，外部和内部定位器必须属于同一框架。内部定位器不能包含 FrameLocator。

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

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

    请注意，外部和内部定位器必须属于同一个框架。内部定位器不得包含FrameLocator。

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

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

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

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

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

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

返回

• 定位器#

第一个​

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

用法

Locator.First

返回

• 定位器#

FocusAsync​

在匹配的元素上调用focus。

用法

await Locator.FocusAsync(options);

参数

• options LocatorFocusOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• void#

FrameLocator​

在处理iframe时，您可以创建一个框架定位器，它将进入iframe并允许定位该iframe中的元素：

用法

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

参数

• selector string#

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

返回

• FrameLocator#

GetAttributeAsync​

返回匹配元素的属性值。

用法

await Locator.GetAttributeAsync(name, options);

参数

• name string#

  要获取值的属性名称。

• options LocatorGetAttributeOptions? (可选)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• string?#

GetByAltText​

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

用法

例如，这个方法将通过alt文本"Playwright logo"找到图片：

<img alt='Playwright logo'>

await page.GetByAltText("Playwright logo").ClickAsync();

参数

• text string | Regex#

  用于定位元素的文本。

• options LocatorGetByAltTextOptions? (可选)

  • Exact bool? (可选)#

    是否查找完全匹配：区分大小写且需整个字符串匹配。默认为false。使用正则表达式定位时此参数将被忽略。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

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​

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

用法

例如，考虑以下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​

允许通过元素的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的信息。

返回

• 定位器#

详情

角色选择器不能替代无障碍审计和合规性测试，而是提供关于ARIA指南的早期反馈。

Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

GetByTestId​

通过测试ID定位元素。

用法

考虑以下DOM结构。

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

您可以通过元素的测试ID来定位它：

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

参数

• testId string | Regex#

  用于定位元素的ID。

返回

• 定位器#

详情

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

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。使用正则表达式定位时此参数将被忽略。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

详情

按文本匹配时总是会规范化空白字符，即使是精确匹配。例如，它会将多个空格转换为一个，将换行符转换为空格，并忽略开头和结尾的空白字符。

类型为button和submit的输入元素是通过它们的value值而非文本内容来匹配的。例如，通过文本"Log in"定位会匹配到<input type=button value="Log in">。

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​

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

用法

await Locator.HighlightAsync();

返回

• void#

HoverAsync​

悬停在匹配的元素上。

用法

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

参数

• options LocatorHoverOptions? (optional)

  • Force bool? (可选)#

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

  • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#

    需要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前按下的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta"在Windows和Linux上解析为"Control"，在macOS上解析为"Meta"。

  • NoWaitAfter bool? (可选) v1.28版本新增#

    已弃用

    此选项无效。

    此选项无效。

  • Position 位置？(可选)#

    • X [浮点数]

    • Y [浮点数]

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

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选参数)#

    当设置此参数时，该方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作但又不实际执行的情况。请注意，无论trial如何设置，键盘modifiers都会被按下，以便测试那些仅在按下这些键时才可见的元素。

返回

• void#

详情

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

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

如果在操作过程中元素从DOM中分离，该方法会抛出异常。

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

InnerHTMLAsync​

Returns the element.innerHTML.

用法

await Locator.InnerHTMLAsync(options);

参数

• options LocatorInnerHTMLOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• string#

InnerTextAsync​

返回 element.innerText。

用法

await Locator.InnerTextAsync(options);

参数

• options LocatorInnerTextOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• string#

InputValueAsync​

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

用法

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

参数

• options LocatorInputValueOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• string#

详情

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

IsCheckedAsync​

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

用法

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

参数

• options LocatorIsCheckedOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• bool#

IsDisabledAsync​

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

用法

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

参数

• options LocatorIsDisabledOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• bool#

IsEditableAsync​

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

用法

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

参数

• options LocatorIsEditableOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• bool#

IsEnabledAsync​

返回元素是否启用。

用法

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

参数

• options LocatorIsEnabledOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• bool#

IsHiddenAsync​

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

用法

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

参数

• options LocatorIsHiddenOptions? (optional)

  • Timeout [float]? (可选)#

    已弃用

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

返回

• bool#

IsVisibleAsync​

返回元素是否可见。

用法

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

参数

• options LocatorIsVisibleOptions? (optional)

  • Timeout [float]? (可选)#

    已弃用

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

返回

• bool#

最后​

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

用法

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

返回

• 定位器#

定位器​

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

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

用法

Locator.Locator(selectorOrLocator, options);

参数

• selectorOrLocator string | Locator#

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

• options LocatorLocatorOptions? (可选)

  • Has Locator? (可选)#

    将方法的结果范围缩小到包含匹配此相对定位器的元素。例如，article 包含 text=Playwright 会匹配 <article><div>Playwright</div></article>。

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

    请注意，外部和内部定位器必须属于同一框架。内部定位器不能包含 FrameLocator。

  • HasNot 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>。

返回

• 定位器#

第N个​

返回第n个匹配元素的定位器。它是基于零的索引，nth(0)选择第一个元素。

用法

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

参数

• index int# 索引

返回

• 定位器#

或者​

创建一个定位器，匹配符合两个定位器中任意一个或全部的所有元素。

请注意，当两个定位器都匹配到内容时，结果定位器可能会有多个匹配项，这可能导致定位器严格性违规。

用法

考虑一个场景，您想要点击"新邮件"按钮，但有时会弹出一个安全设置对话框。在这种情况下，您可以等待"新邮件"按钮或对话框出现，然后采取相应操作。

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

返回

• 页面#

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​

聚焦元素，然后为文本中的每个字符发送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​

对匹配定位器的元素进行截图。

用法

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

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

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

参数

• options LocatorScreenshotOptions? (optional)

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

    当设置为"disabled"时，会停止CSS动画、CSS过渡和Web动画。动画会根据其持续时间受到不同的处理：

    • 有限动画会被快进到完成状态，因此会触发transitionend事件。
    • 无限循环动画会被取消回到初始状态，截图完成后会重新播放。

    默认为"allow"，表示保持动画原样不做处理。

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

    当设置为"hide"时，截图将隐藏文本插入光标。当设置为"initial"时，文本插入光标行为将保持不变。默认为"hide"。

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

    指定在截图时应被遮罩的定位器。被遮罩的元素将被一个粉红色盒子#FF00FF（可通过MaskColor自定义）完全覆盖其边界框。该遮罩也会应用于不可见元素，如需禁用此功能，请参阅Matching only visible elements。

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

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

查看scrolling获取其他滚动方式。

用法

await Locator.ScrollIntoViewIfNeededAsync(options);

参数

• options LocatorScrollIntoViewIfNeededOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• void#

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 字符串 | ElementHandle | IEnumerable | SelectOption | IEnumerable | IEnumerable?#

  • Value string? (可选)

    通过option.value匹配。可选。

  • Label string? (可选)

    通过option.label匹配。可选。

  • Index int? (可选)

    通过索引进行匹配。可选参数。

  Options to select. If the <select> has the multiple attribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.
• options LocatorSelectOptionOptions? (optional)

  • Force bool? (可选)#

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

  • NoWaitAfter bool? (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• IEnumerable<string>#

详情

该方法会等待可操作性检查，直到所有指定选项出现在<select>元素中并选择这些选项。

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

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

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

SelectTextAsync​

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

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

用法

await Locator.SelectTextAsync(options);

参数

• options LocatorSelectTextOptions? (optional)

  • Force bool? (可选)#

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

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• void#

SetCheckedAsync​

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

用法

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

参数

• checkedState bool#

  是否勾选或取消勾选该复选框。

• options LocatorSetCheckedOptions? (可选)

  • Force bool? (可选)#

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

  • NoWaitAfter bool? (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • Position 位置？(可选)#

    • X [浮点数]

    • Y [浮点数]

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

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选)#

    当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作但又不实际执行该操作的情况。

返回

• void#

详情

该方法通过执行以下步骤来勾选或取消勾选元素：

1. 确保匹配的元素是复选框或单选输入。如果不是，该方法会抛出异常。
2. 如果元素已经处于正确的选中状态，该方法会立即返回。
3. 等待匹配元素上的可操作性检查完成，除非设置了强制选项。如果在检查过程中元素被分离，整个操作将重试。
4. 如果需要，将元素滚动到视图中。
5. 使用 Page.Mouse 点击元素的中心位置。
6. 确保元素现在已被选中或取消选中。如果没有，此方法将抛出异常。

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

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 字符串 | IEnumerable<字符串> | FilePayload | IEnumerable<FilePayload>#

  • Name string

    文件名

  • MimeType string

    文件类型

  • Buffer byte[]

    文件内容

• options LocatorSetInputFilesOptions? (optional)

  • NoWaitAfter bool? (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• void#

详情

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

此方法期望Locator指向一个input元素。但如果该元素位于具有关联control的<label>元素内，则会改为定位到该控件。

TapAsync​

在匹配定位器的元素上执行轻触手势。有关通过手动分发触摸事件来模拟其他手势的示例，请参阅模拟传统触摸事件页面。

用法

await Locator.TapAsync(options);

参数

• options LocatorTapOptions? (optional)

  • Force bool? (可选)#

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

  • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#

    需要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前按下的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta"在Windows和Linux上解析为"Control"，在macOS上解析为"Meta"。

  • NoWaitAfter bool? (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • Position 位置？(可选)#

    • X [浮点数]

    • Y [浮点数]

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

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选参数)#

    当设置此参数时，该方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作但又不实际执行的情况。请注意，无论trial如何设置，键盘modifiers都会被按下，以便测试那些仅在按下这些键时才可见的元素。

返回

• void#

详情

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

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

如果在操作过程中元素从DOM中分离，该方法会抛出异常。

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

TextContentAsync​

返回 node.textContent。

用法

await Locator.TextContentAsync(options);

参数

• options LocatorTextContentOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• string?#

取消勾选Async​

确保复选框或单选按钮元素处于未选中状态。

用法

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

参数

• options LocatorUncheckOptions? (optional)

  • Force bool? (可选)#

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

  • NoWaitAfter bool? (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • Position 位置？(可选)#

    • X [浮点数]

    • Y [浮点数]

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

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选)#

    当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作但又不实际执行该操作的情况。

返回

• void#

详情

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

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

如果在操作过程中元素从DOM中分离，该方法会抛出异常。

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

等待异步​

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

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

用法

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

参数

• options LocatorWaitForOptions? (optional)

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

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

用法

await Locator.ElementHandleAsync(options);

参数

• options LocatorElementHandleOptions? (optional)

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

返回

• ElementHandle#

ElementHandlesAsync​

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

用法

await Locator.ElementHandlesAsync();

返回

• IEnumerable<ElementHandle>#

TypeAsync​

聚焦元素，然后为文本中的每个字符发送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#