Locator

定位器 (Locator) 是 Playwright 自动等待和重试机制的核心。简而言之，定位器代表了一种在任何时刻查找页面上元素的方法。可以使用 page.locator() 方法创建定位器。

了解更多关于定位器.

方法

all

新增于: v1.29

locator.all

当定位器指向元素列表时，这会返回一个定位器数组，指向它们各自的元素。

注意

locator.all() 不会等待元素与定位器匹配，而是直接返回页面上当前存在的任何内容。

当元素列表动态变化时，locator.all() 会产生不可预测且不稳定的结果。

当元素列表稳定但动态加载时，请在调用 locator.all() 之前等待完整列表加载完成。

用法

for (const li of await page.getByRole('listitem').all())
  await li.click();

Promise<Array<Locator>>#

allInnerTexts

新增于：v1.14

locator.allInnerTexts

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

断言文本

如果您需要对页面上的文本进行断言，建议优先使用带有 useInnerText 选项的 expect(locator).toHaveText() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const texts = await page.getByRole('link').allInnerTexts();

Promise<Array<string>>#

allTextContents

新增于：v1.14

locator.allTextContents

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

断言文本

如果您需要对页面上的文本进行断言，建议优先使用 expect(locator).toHaveText() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const texts = await page.getByRole('link').allTextContents();

Promise<Array<string>>#

and

新增于: v1.34

locator.and

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

用法

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

const button = page.getByRole('button').and(page.getByTitle('Subscribe'));

参数

locator Locator #

要匹配的附加定位器。

Locator #

ariaSnapshot

新增于: v1.49

locator.ariaSnapshot

捕获给定元素的 aria 快照。阅读更多关于 aria 快照的信息，以及用于相关断言的 expect(locator).toMatchAriaSnapshot()。

用法

await page.getByRole('link').ariaSnapshot();

参数

options Object (可选)
- depth number (可选)新增于: v1.59#
  
  指定时，限制快照的深度。
- mode "ai" | "default" (可选)新增于: v1.59#
  
  当设置为 "ai" 时，返回针对 AI 使用优化的快照。默认为 "default"。查看详情了解更多信息。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<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"

AI 优化的快照（由 mode 控制）与默认快照不同。

包括元素引用 [ref=e2]。2. 不会等待与定位器匹配的元素，如果没有匹配元素则会抛出异常。3. 包括目标内部 <iframe> 的快照。

blur

新增于: v1.28

locator.blur

调用元素的 blur。

用法

await locator.blur();
await locator.blur(options);

参数

options Object (可选)
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

boundingBox

新增于：v1.14

locator.boundingBox

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

用法

const box = await page.getByRole('button').boundingBox();
await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);

参数

options Object (可选)
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<null | Object>#
- x 数字
  
  元素的 x 坐标（以像素为单位）。
- y 数字
  
  元素的 y 坐标（以像素为单位）。
- width number
  
  元素的宽度（以像素为单位）。
- height number
  
  元素的高度（以像素为单位）。

详情

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

子帧中的元素返回相对于主帧的边界框，与 Element.getBoundingClientRect 不同。

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

check

新增于：v1.14

locator.check

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

用法

await page.getByRole('checkbox').check();

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x 数字
  - y 数字
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而不执行它。

Promise<void>#

详情

执行以下步骤

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。如果元素已选中，此方法将立即返回。
等待元素的可操作性 (actionability) 检查，除非设置了 force 选项。
如果需要，将元素滚动到视图中。
使用 page.mouse 单击元素的中心。
确保元素现在已选中。如果不是，此方法将抛出异常。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤在指定的 timeout 内未完成时，该方法会抛出 TimeoutError。将超时设置为零可禁用此限制。

clear

新增于: v1.28

locator.clear

清除输入字段。

用法

await page.getByRole('textbox').clear();

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

详情

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

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

click

新增于：v1.14

locator.click

点击元素。

用法

点击按钮

await page.getByRole('button').click();

在画布上的特定位置 Shift-右键单击

await page.locator('canvas').click({
  button: 'right',
  modifiers: ['Shift'],
  position: { x: 23, y: 32 },
});

参数

options Object (可选)
- button "left" | "right" | "middle" (可选)#
  
  默认为 left。
- clickCount number (可选)#
  
  默认为 1。参见 UIEvent.detail。
- delay number (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项将来默认为 true。
  
  发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。
- position Object (可选)#
  - x 数字
  - y 数字
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- steps number (可选)Added in: v1.57#
  
  默认为 1。发送 n 个插值过的 mousemove 事件，以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时，将发出一个到达目标位置的 mousemove 事件。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而不执行它。请注意，键盘 modifiers 将被按下，无论 trial 如何，以便允许测试在这些键按下时才可见的元素。

Promise<void>#

详情

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

等待元素的可操作性检查，除非设置了 force 选项。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素的中心，或者点击指定的 position。
等待发起的导航成功或失败，除非设置了 noWaitAfter 选项。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤在指定的 timeout 内未完成时，该方法会抛出 TimeoutError。将超时设置为零可禁用此限制。

contentFrame

新增于: v1.43

locator.contentFrame

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

当您在某处获得了 Locator 对象，并且稍后想要与该框架内的内容进行交互时，此方法非常有用。

要执行反向操作，请使用 frameLocator.owner()。

用法

const locator = page.locator('iframe[name="embedded"]');
// ...
const frameLocator = locator.contentFrame();
await frameLocator.getByRole('button').click();

FrameLocator #

count

新增于：v1.14

locator.count

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

断言计数

如果您需要对页面上的元素数量进行断言，建议优先使用 expect(locator).toHaveCount() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const count = await page.getByRole('listitem').count();

Promise<number>#

dblclick

新增于：v1.14

locator.dblclick

双击元素。

用法

await locator.dblclick();
await locator.dblclick(options);

参数

options Object (可选)
- button "left" | "right" | "middle" (可选)#
  
  默认为 left。
- delay number (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x 数字
  - y 数字
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- steps number (可选)Added in: v1.57#
  
  默认为 1。发送 n 个插值过的 mousemove 事件，以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时，将发出一个到达目标位置的 mousemove 事件。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而不执行它。请注意，键盘 modifiers 将被按下，无论 trial 如何，以便允许测试在这些键按下时才可见的元素。

Promise<void>#

详情

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

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

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤在指定的 timeout 内未完成时，该方法会抛出 TimeoutError。将超时设置为零可禁用此限制。

注意

`element.dblclick()` 分派两个 `click` 事件和一个 `dblclick` 事件。

describe

新增于: v1.53

locator.describe

描述定位器，描述用于跟踪查看器和报告。返回指向相同元素的定位器。

用法

const button = page.getByTestId('btn-sub').describe('Subscribe button');
await button.click();

参数

description string #

定位器描述。

Locator #

description

Added in: v1.57

locator.description

返回之前使用 locator.describe() 设置的定位器描述。如果没有设置自定义描述，则返回 null。建议优先使用 locator.toString() 以获取人类可读的表示形式，因为它在可用时会使用该描述。

用法

const button = page.getByRole('button').describe('Subscribe button');
console.log(button.description()); // "Subscribe button"

const input = page.getByRole('textbox');
console.log(input.description()); // null

null | string #

dispatchEvent

新增于：v1.14

locator.dispatchEvent

以编程方式在匹配元素上分派事件。

用法

await locator.dispatchEvent('click');

参数

type string #

DOM 事件类型："click"、"dragstart" 等。
eventInit EvaluationArgument (可选)#

可选的事件特定初始化属性。
options Object (可选)
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

详情

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

在底层，它会根据给定的 type 创建一个事件实例，使用 eventInit 属性对其进行初始化，并在元素上分发该事件。事件默认是 composed（组合的）、cancelable（可取消的）并会冒泡。

由于 eventInit 是事件特定的，请参考事件文档以获取初始属性列表。

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

const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await locator.dispatchEvent('dragstart', { dataTransfer });

dragTo

新增于: v1.18

locator.dragTo

将源元素拖向目标元素并放下。

用法

const source = page.locator('#source');
const target = page.locator('#target');

await source.dragTo(target);
// or specify exact positions relative to the top-left corners of the elements:
await source.dragTo(target, {
  sourcePosition: { x: 34, y: 7 },
  targetPosition: { x: 10, y: 20 },
});

参数

target Locator #

要拖动到的元素的定位器。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- sourcePosition Object (可选)#
  - x 数字
  - y 数字
  在此点（相对于元素内边距框的左上角）点击源元素。如果未指定，则使用元素的某个可见点。
- steps number (可选)Added in: v1.57#
  
  默认为 1。发送 n 个插值的 mousemove 事件以表示从 mousedown 到 mouseup 的拖动过程。当设置为 1 时，在目标位置发出单个 mousemove 事件。
- targetPosition Object (可选)#
  - x 数字
  - y 数字
  在此点（相对于元素内边距框的左上角）拖放到目标元素。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而不执行它。

Promise<void>#

详情

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

evaluate

新增于：v1.14

locator.evaluate

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

用法

向 pageFunction 传递参数

const result = await page.getByTestId('myId').evaluate((element, [x, y]) => {
  return element.textContent + ' ' + x * y;
}, [7, 8]);
console.log(result); // prints "myId text 56"

参数

pageFunction function | string #
要在页面上下文中执行的函数。
arg EvaluationArgument (可选)#

传递给 pageFunction 的可选参数。
options Object (可选)
- timeout number (可选)#
  
  在评估前等待定位器的最长时间（以毫秒为单位）。注意，定位器解析后，评估本身不受超时限制。默认为 0 - 即无超时。

Promise<Serializable>#

详情

返回 pageFunction 的返回值，该函数以匹配的元素作为第一个参数，并以 arg 作为第二个参数调用。

如果 pageFunction 返回一个 Promise，此方法将等待 Promise 解析并返回其值。

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

evaluateAll

新增于：v1.14

locator.evaluateAll

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

用法

const locator = page.locator('div');
const moreThanTen = await locator.evaluateAll((divs, min) => divs.length > min, 10);

参数

pageFunction function | string #
要在页面上下文中执行的函数。
arg EvaluationArgument (可选)#

传递给 pageFunction 的可选参数。

Promise<Serializable>#

详情

返回 pageFunction 的返回值，该函数以所有匹配元素的数组作为第一个参数，并以 arg 作为第二个参数调用。

如果 pageFunction 返回一个 Promise，此方法将等待 Promise 解析并返回其值。

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

evaluateHandle

新增于：v1.14

locator.evaluateHandle

在页面中执行 JavaScript 代码，以匹配的元素作为参数，并返回一个包含结果的 JSHandle。

用法

await locator.evaluateHandle(pageFunction);
await locator.evaluateHandle(pageFunction, arg, options);

参数

pageFunction function | string #

要在页面上下文中执行的函数。
arg EvaluationArgument (可选)#

传递给 pageFunction 的可选参数。
options Object (可选)
- timeout number (可选)#
  
  在评估前等待定位器的最长时间（以毫秒为单位）。注意，定位器解析后，评估本身不受超时限制。默认为 0 - 即无超时。

Promise<JSHandle>#

详情

将 pageFunction 的返回值作为 JSHandle 返回，该函数以匹配的元素作为第一个参数，并以 arg 作为第二个参数调用。

locator.evaluate() 和 locator.evaluateHandle() 的唯一区别是 locator.evaluateHandle() 返回 JSHandle。

如果 pageFunction 返回一个 Promise，此方法将等待 Promise 解析并返回其值。

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

更多详细信息，请参阅 page.evaluateHandle()。

fill

新增于：v1.14

locator.fill

设置输入字段的值。

用法

await page.getByRole('textbox').fill('example value');

参数

value string #

要为 <input>、<textarea> 或 [contenteditable] 元素设置的值。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

详情

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

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

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

filter

新增于: v1.22

locator.filter

此方法根据选项缩小现有定位器，例如按文本过滤。它可以链式调用以多次过滤。

用法

const rowLocator = page.locator('tr');
// ...
await rowLocator
    .filter({ hasText: 'text in column 1' })
    .filter({ has: page.getByRole('button', { name: 'column 2 button' }) })
    .screenshot();

参数

options Object (可选)
- 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 定位器 （可选）新增于：v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器查询的。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- hasNotText string | RegExp (optional)新增于：v1.33#
  
  匹配那些不包含指定文本（可能在子元素或后代元素中）的元素。当传入一个 string 时，匹配不区分大小写并搜索子字符串。
- hasText string | RegExp (可选)#
  匹配包含指定文本的元素（可能在子元素或后代元素中）。当传入一个 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。
- visible boolean (可选)添加于: v1.51#
  
  仅匹配可见或不可见元素。

Locator #

first

新增于：v1.14

locator.first

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

用法

locator.first();

Locator #

focus

新增于：v1.14

locator.focus

在匹配的元素上调用 focus。

用法

await locator.focus();
await locator.focus(options);

参数

options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

frameLocator

新增于: v1.17

locator.frameLocator

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

用法

const locator = page.frameLocator('iframe').getByText('Submit');
await locator.click();

参数

selector string #
用于解析 DOM 元素的选取器。

FrameLocator #

getAttribute

新增于：v1.14

locator.getAttribute

返回匹配元素的属性值。

断言属性

如果您需要对元素的属性进行断言，建议优先使用 expect(locator).toHaveAttribute() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

await locator.getAttribute(name);
await locator.getAttribute(name, options);

参数

name string #
要获取值的属性名称。
options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<null | string>#

getByAltText

新增于：v1.27

locator.getByAltText

允许根据元素的 alt 文本定位元素。

用法

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

<img alt='Playwright logo'>

await page.getByAltText('Playwright logo').click();

参数

text string | RegExp #
用于定位元素的文本。
options Object (可选)
- exact boolean (可选)#
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

getByLabel

新增于：v1.27

locator.getByLabel

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

用法

例如，此方法将在以下 DOM 中通过标签“用户名”和“密码”找到输入

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">

await page.getByLabel('Username').fill('john');
await page.getByLabel('Password').fill('secret');

参数

text string | RegExp #
用于定位元素的文本。
options Object (可选)
- exact boolean (可选)#
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

getByPlaceholder

新增于：v1.27

locator.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

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

您可以按占位符文本定位输入框后填充它

await page
    .getByPlaceholder('name@example.com')
    .fill('playwright@microsoft.com');

参数

text string | RegExp #
用于定位元素的文本。
options Object (可选)
- exact boolean (可选)#
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

getByRole

新增于：v1.27

locator.getByRole

允许根据元素的 ARIA 角色、ARIA 属性和可访问名称来定位元素。

用法

考虑以下 DOM 结构。

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

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

await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();

await page.getByRole('checkbox', { name: 'Subscribe' }).check();

await page.getByRole('button', { name: /submit/i }).click();

参数

role "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 Object (可选)
- checked boolean (可选)#
  通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。
  
  了解更多关于 aria-checked 的信息。
- disabled boolean (可选)#
  通常由 aria-disabled 或 disabled 设置的属性。
  
  注意
  与大多数其他属性不同，disabled 在 DOM 层次结构中是继承的。了解更多关于 aria-disabled 的信息。
- exact 布尔值 （可选）新增于: v1.28#
  
  是否对 name 进行精确匹配：区分大小写且全字符串匹配。默认为 false。当 name 为正则表达式时将被忽略。注意，精确匹配仍然会去除首尾空格。
- expanded boolean (可选)#
  通常由 aria-expanded 设置的属性。
  
  了解更多关于 aria-expanded 的信息。
- includeHidden boolean (可选)#
  控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（由 ARIA 定义）由角色选择器匹配。
  
  了解更多关于 aria-hidden 的信息。
- level number (可选)#
  通常用于角色 heading、listitem、row、treeitem 的数字属性，<h1>-<h6> 元素具有默认值。
  
  了解更多关于 aria-level 的信息。
- name string | RegExp (可选)#
  用于匹配可访问名称 (accessible name) 的选项。默认情况下，匹配是不区分大小写的并搜索子字符串，请使用 exact 来控制此行为。
  
  了解更多关于可访问名称的信息。
- pressed boolean (可选)#
  通常由 aria-pressed 设置的属性。
  
  了解更多关于 aria-pressed 的信息。
- selected boolean (可选)#
  通常由 aria-selected 设置的属性。
  
  了解更多关于 aria-selected 的信息。

Locator #

详情

角色选择器 不替代 可访问性审计和合规性测试，而是提供有关 ARIA 指南的早期反馈。

许多 HTML 元素具有隐式定义的角色，可被角色选择器识别。你可以在此处找到所有支持的角色。ARIA 指南不建议通过设置 role 和/或 aria-* 属性为默认值来重复隐式角色和属性。

getByTestId

新增于：v1.27

locator.getByTestId

按测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

您可以按其测试 ID 定位元素

await page.getByTestId('directions').click();

参数

testId string | RegExp #
用于定位元素的 ID。

Locator #

详情

默认情况下，data-testid 属性用作测试 ID。如有必要，请使用 selectors.setTestIdAttribute() 配置不同的测试 ID 属性。

// Set custom test id attribute from @playwright/test config:
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    testIdAttribute: 'data-pw'
  },
});

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', { exact: true });

// Matches both <div>s
page.getByText(/Hello/);

// Matches second <div>
page.getByText(/^hello$/i);

参数

text string | RegExp #
用于定位元素的文本。
options Object (可选)
- exact boolean (可选)#
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

详情

按文本匹配始终会规范化空格，即使是精确匹配也是如此。例如，它会将多个空格转换为一个空格，将换行符转换为空格，并忽略前导和尾随空格。

类型为 button 和 submit 的输入元素通过其 value 而不是文本内容进行匹配。例如，通过文本 "登录" 定位匹配 <input type=button value="登录">。

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 | RegExp #
用于定位元素的文本。
options Object (可选)
- exact boolean (可选)#
  是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

highlight

新增于: v1.20

locator.highlight

高亮显示屏幕上的对应元素。用于调试，请不要提交使用 locator.highlight() 的代码。

用法

await locator.highlight();

Promise<void>#

hover

新增于：v1.14

locator.hover

将鼠标悬停在匹配的元素上。

用法

await page.getByRole('link').hover();

参数

options Object (可选)
- force boolean (可选)#
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter 布尔值 （可选）新增于: v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x 数字
  - y 数字
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而不执行它。请注意，键盘 modifiers 将被按下，无论 trial 如何，以便允许测试在这些键按下时才可见的元素。

Promise<void>#

详情

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

等待元素的可操作性检查，除非设置了 force 选项。
如果需要，将元素滚动到视图中。
使用 page.mouse 将鼠标悬停在元素的中心，或指定的 position。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤在指定的 timeout 内未完成时，该方法会抛出 TimeoutError。将超时设置为零可禁用此限制。

innerHTML 新增于：v1.14

locator.innerHTML

返回 `element.innerHTML`。

用法

await locator.innerHTML();
await locator.innerHTML(options);

参数

options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<string>#

innerText 新增于：v1.14

locator.innerText

返回 element.innerText。

断言文本

如果您需要对页面上的文本进行断言，建议优先使用带有 useInnerText 选项的 expect(locator).toHaveText() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

await locator.innerText();
await locator.innerText(options);

参数

options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<string>#

inputValue 新增于：v1.14

locator.inputValue

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

断言值

如果您需要对输入值进行断言，建议优先使用 expect(locator).toHaveValue() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const value = await page.getByRole('textbox').inputValue();

参数

options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<string>#

详情

抛出非 input、textarea 或 select 的元素。但是，如果元素位于具有相关控件的 <label> 元素内，则返回该控件的值。

isChecked 新增于：v1.14

locator.isChecked

返回元素是否已选中。如果元素不是复选框或单选输入，则抛出异常。

断言选中状态

如果您需要断言复选框已选中，建议优先使用 expect(locator).toBeChecked() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const checked = await page.getByRole('checkbox').isChecked();

参数

options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<boolean>#

isDisabled 新增于：v1.14

locator.isDisabled

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

断言禁用状态

如果您需要断言元素已禁用，建议优先使用 expect(locator).toBeDisabled() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const disabled = await page.getByRole('button').isDisabled();

参数

options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<boolean>#

isEditable 新增于：v1.14

locator.isEditable

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

断言可编辑状态

如果您需要断言元素是可编辑的，建议优先使用 expect(locator).toBeEditable() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const editable = await page.getByRole('textbox').isEditable();

参数

options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<boolean>#

isEnabled 新增于：v1.14

locator.isEnabled

返回元素是否启用。

断言启用状态

如果您需要断言元素已启用，建议优先使用 expect(locator).toBeEnabled() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const enabled = await page.getByRole('button').isEnabled();

参数

options Object (可选)
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<boolean>#

isHidden 新增于：v1.14

locator.isHidden

返回元素是否被隐藏，与可见 (visible) 相反。

断言可见性

如果您需要断言元素是隐藏的，建议优先使用 expect(locator).toBeHidden() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const hidden = await page.getByRole('button').isHidden();

参数

options Object (可选)
- timeout number (可选)#
  已弃用
  此选项被忽略。locator.isHidden() 不会等待元素变为隐藏，而是立即返回。

Promise<boolean>#

isVisible 新增于：v1.14

locator.isVisible

返回元素是否可见。

断言可见性

如果您需要断言元素是可见的，建议优先使用 expect(locator).toBeVisible() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

const visible = await page.getByRole('button').isVisible();

参数

options Object (可选)
- timeout number (可选)#
  已弃用
  此选项被忽略。locator.isVisible() 不会等待元素变为可见，而是立即返回。

Promise<boolean>#

last

新增于：v1.14

locator.last

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

用法

const banana = await page.getByRole('listitem').last();

Locator #

locator

新增于：v1.14

locator.locator

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

了解更多关于定位器.

用法

locator.locator(selectorOrLocator);
locator.locator(selectorOrLocator, options);

参数

selectorOrLocator string | Locator #
用于解析 DOM 元素的选择器或定位器。
options Object (可选)
- 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 定位器 （可选）新增于：v1.33#
  
  匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器查询的。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。
  
  请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
- hasNotText string | RegExp (optional)新增于：v1.33#
  
  匹配那些不包含指定文本（可能在子元素或后代元素中）的元素。当传入一个 string 时，匹配不区分大小写并搜索子字符串。
- hasText string | RegExp (可选)#
  匹配包含指定文本的元素（可能在子元素或后代元素中）。当传入一个 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

Locator #

normalize 新增于: v1.59

locator.normalize

返回一个新的定位器，该定位器使用引用匹配元素的最佳实践，优先选择测试 ID、Aria 角色和其他面向用户的属性，而非 CSS 选择器。这对于将实现细节选择器转换为更具弹性、人类可读的定位器非常有用。

用法

await locator.normalize();

Promise<Locator>#

nth

新增于：v1.14

locator.nth

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

用法

const banana = await page.getByRole('listitem').nth(2);

参数

index number #

Locator #

or 新增于：v1.33

locator.or

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

请注意，当两个定位器都匹配到某些内容时，生成的定位器将有多个匹配项，这可能会导致违反定位器严格性 (locator strictness)。

用法

考虑一个场景，你想点击一个“新邮件”按钮，但有时会弹出一个安全设置对话框。在这种情况下，你可以等待“新邮件”按钮，或者一个对话框并相应地操作。

注意

如果“新邮件”按钮和安全对话框同时出现在屏幕上，“或 (or)”定位器将匹配它们两者，可能会抛出 "严格模式违规 (strict mode violation)" 错误。在这种情况下，您可以使用 locator.first() 只匹配其中一个。

const newEmail = page.getByRole('button', { name: 'New' });
const dialog = page.getByText('Confirm security settings');
await expect(newEmail.or(dialog).first()).toBeVisible();
if (await dialog.isVisible())
  await page.getByRole('button', { name: 'Dismiss' }).click();
await newEmail.click();

参数

locator Locator #
要匹配的替代定位器。

Locator #

page

新增于：v1.19

locator.page

此定位器所属的页面。

用法

locator.page();

Page #

press

新增于：v1.14

locator.press

聚焦匹配元素并按下按键组合。

用法

await page.getByRole('textbox').press('Backspace');

参数

key string #
要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。
options Object (可选)
- delay number (可选)#
  keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。
- noWaitAfter boolean (可选)#
  已弃用
  此选项将来默认为 true。
  
  发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

详情

聚焦元素，然后使用 keyboard.down() 和 keyboard.up()。

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"。当与修饰符一起指定时，修饰符在按下后续键时被按下并保持。

pressSequentially 新增于: v1.38

locator.pressSequentially

提示

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

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

要按特殊键，如 Control 或 ArrowDown，请使用 locator.press()。

用法

await locator.pressSequentially('Hello'); // Types instantly
await locator.pressSequentially('World', { delay: 100 }); // Types slower, like a user

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

const locator = page.getByLabel('Password');
await locator.pressSequentially('my password');
await locator.press('Enter');

参数

text string #
要顺序按入聚焦元素的字符字符串。
options Object (可选)
- delay number (可选)#
  按键之间等待的时间，以毫秒为单位。默认为 0。
- noWaitAfter boolean (可选)#
  已弃用
  此选项无效。
  
  此选项无效。
- timeout number (可选)#
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

screenshot

新增于：v1.14

locator.screenshot

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

用法

await page.getByRole('link').screenshot();

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

await page.getByRole('link').screenshot({ animations: 'disabled', path: 'link.png' });

参数

options Object (可选)
- animations "disabled" | "allow" (可选)#
  设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。动画的处理方式因其持续时间而异
  - 有限动画会快进到完成，因此它们会触发 transitionend 事件。
  - 无限动画会取消到初始状态，然后在截图后重新播放。
  默认为 "allow"，保持动画不变。
- caret "hide" | "initial" (可选)#
  设置为 "hide" 时，截图将隐藏文本插入符号。设置为 "initial" 时，文本插入符号行为不会更改。默认为 "hide"。
- mask Array<Locator> (可选)#
  
  指定截图时需要遮盖的定位器。被遮盖的元素将覆盖一个粉色框 #FF00FF（可通过 maskColor 自定义），该框会完全遮住元素的边界框。遮罩同样适用于不可见元素，请参阅仅匹配可见元素以禁用此行为。
- maskColor 字符串 (可选)添加于：v1.35#
  
  指定遮盖元素的覆盖框颜色，采用 CSS 颜色格式。默认颜色为粉红色 #FF00FF。
- omitBackground boolean (可选)#
  
  隐藏默认的白色背景并允许捕获透明截图。不适用于 jpeg 图像。默认为 false。
- path string (可选)#
  
  保存图像的文件路径。截图类型将根据文件扩展名自动推断。如果 path 是相对路径，则相对于当前工作目录进行解析。如果未提供路径，图像将不会保存到磁盘。
- quality number (可选)#
  
  图像质量，介于 0-100 之间。不适用于 png 图像。
- scale "css" | "device" (可选)#
  
  设置为 "css" 时，截屏将具有页面上每个 CSS 像素的单个像素。对于高 DPI 设备，这将保持截屏较小。使用 "device" 选项将产生每个设备像素的单个像素，因此高 DPI 设备的截屏将大两倍或更大。
  
  默认为 "device"。
- style 字符串 (可选)新增于: v1.41#
  
  在截屏时应用的样式表文本。您可以在此处隐藏动态元素、使元素不可见或更改其属性，以帮助您创建可重复的截屏。此样式表会穿透 Shadow DOM 并应用于内部框架。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- type "png" | "jpeg" (可选)#
  
  指定截图类型，默认为 png。

Promise<Buffer>#

详情

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

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

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

scrollIntoViewIfNeeded

新增于：v1.14

locator.scrollIntoViewIfNeeded

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

有关其他滚动方式，请参阅滚动。

用法

await locator.scrollIntoViewIfNeeded();
await locator.scrollIntoViewIfNeeded(options);

参数

options Object (可选)
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

selectOption

新增于：v1.14

locator.selectOption

在 <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
element.selectOption('blue');

// single selection matching the label
element.selectOption({ label: 'Blue' });

// multiple selection for red, green and blue options
element.selectOption(['red', 'green', 'blue']);

参数

values null | string | ElementHandle | Array<string> | Object | Array<ElementHandle> | Array<Object>#
- value 字符串 (可选)
  
  按 option.value 匹配。可选。
- label 字符串 (可选)
  
  按 option.label 匹配。可选。
- index 数字 (可选)
  
  按索引匹配。可选。
要选择的选项。如果 <select> 具有 multiple 属性，则选择所有匹配的选项，否则仅选择与传入选项之一匹配的第一个选项。字符串值同时匹配值和标签。当所有指定的属性都匹配时，认为选项匹配。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<Array<string>>#

详情

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

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

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

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

selectText

新增于：v1.14

locator.selectText

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

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

用法

await locator.selectText();
await locator.selectText(options);

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

setChecked

新增于: v1.15

locator.setChecked

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

用法

await page.getByRole('checkbox').setChecked(true);

参数

checked boolean #

是否选中或取消选中复选框。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x 数字
  - y 数字
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而不执行它。

Promise<void>#

详情

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

确保匹配的元素是复选框或单选输入。如果不是，此方法将抛出错误。
如果元素已经处于正确的选中状态，此方法将立即返回。
等待匹配元素的可操作性检查，除非设置了 force 选项。如果在检查期间元素被分离，整个操作将会重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 单击元素的中心。
确保元素现在已选中或未选中。如果不是，此方法将抛出异常。

如果在指定的 timeout 内所有步骤未完成，该方法会抛出 TimeoutError。传入零值将禁用此超时。

setInputFiles

新增于：v1.14

locator.setInputFiles

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

用法

// Select one file
await page.getByLabel('Upload file').setInputFiles(path.join(__dirname, 'myfile.pdf'));

// Select multiple files
await page.getByLabel('Upload files').setInputFiles([
  path.join(__dirname, 'file1.txt'),
  path.join(__dirname, 'file2.txt'),
]);

// Select a directory
await page.getByLabel('Upload directory').setInputFiles(path.join(__dirname, 'mydir'));

// Remove all the selected files
await page.getByLabel('Upload file').setInputFiles([]);

// Upload buffer from memory
await page.getByLabel('Upload file').setInputFiles({
  name: 'file.txt',
  mimeType: 'text/plain',
  buffer: Buffer.from('this is test')
});

参数

files string | Array<string> | Object | Array<Object>#
- name string
  
  文件名
- mimeType string
  
  文件类型
- buffer Buffer
  
  文件内容
options Object (可选)
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

详情

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

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

tap

新增于：v1.14

locator.tap

在与定位器匹配的元素上执行点击（tap）手势。有关通过手动分发触摸事件来模拟其他手势的示例，请参阅模拟旧版触摸事件页面。

用法

await locator.tap();
await locator.tap(options);

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x 数字
  - y 数字
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而不执行它。请注意，键盘 modifiers 将被按下，无论 trial 如何，以便允许测试在这些键按下时才可见的元素。

Promise<void>#

详情

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

等待元素的可操作性检查，除非设置了 force 选项。
如果需要，将元素滚动到视图中。
使用 page.touchscreen 点击元素的中心，或点击指定的 position。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

如果在指定的 timeout 内所有步骤未完成，该方法会抛出 TimeoutError。传入零值将禁用此超时。

注意

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

textContent

新增于：v1.14

locator.textContent

返回 node.textContent。

断言文本

如果您需要对页面上的文本进行断言，建议优先使用 expect(locator).toHaveText() 以避免测试不稳定。更多详细信息，请参阅断言指南。

用法

await locator.textContent();
await locator.textContent(options);

参数

options Object (可选)
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<null | string>#

toString

Added in: v1.57

locator.toString

返回定位器的人类可读描述，如果存在的话使用 locator.description()；否则，根据定位器的选择器生成一个字符串。

用法

locator.toString();

string #

uncheck

新增于：v1.14

locator.uncheck

确保复选框或单选元素未选中。

用法

await page.getByRole('checkbox').uncheck();

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x 数字
  - y 数字
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而不执行它。

Promise<void>#

详情

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

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

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

如果在指定的 timeout 内所有步骤未完成，该方法会抛出 TimeoutError。传入零值将禁用此超时。

waitFor

添加于：v1.16

locator.waitFor

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

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

用法

const orderSent = page.locator('#order-sent');
await orderSent.waitFor();

参数

options Object (可选)
- state "attached" | "detached" | "visible" | "hidden" (可选)#
  
  默认为 'visible'。可以是以下之一：
  - 'attached' - 等待元素出现在 DOM 中。
  - 'detached' - 等待元素不在 DOM 中。
  - 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空的边界框，不被视为可见。
  - 'hidden' - 等待元素从 DOM 中分离，或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

已弃用

elementHandle

新增于：v1.14

locator.elementHandle

不推荐

始终优先使用 Locator 和 Web 断言，而不是 ElementHandle，因为后者本质上容易产生竞态条件。

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

用法

await locator.elementHandle();
await locator.elementHandle(options);

参数

options Object (可选)
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<ElementHandle>#

elementHandles

新增于：v1.14

locator.elementHandles

不推荐

始终优先使用 Locator 和 Web 断言，而不是 ElementHandle，因为后者本质上容易产生竞态条件。

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

用法

await locator.elementHandles();

Promise<Array<ElementHandle>>#

type

新增于：v1.14

locator.type

已弃用

在大多数情况下，您应该使用 locator.fill() 代替。只有当页面上有特殊的键盘处理时，您才需要一个接一个地按下按键——在这种情况下，请使用 locator.pressSequentially()。

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

要按特殊键，如 Control 或 ArrowDown，请使用 locator.press()。

用法

参数

text string #

要输入到聚焦元素的文本。
options Object (可选)
- delay number (可选)#
  
  按键之间等待的时间，以毫秒为单位。默认为 0。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout number (可选)#
  
  最大时间（以毫秒为单位）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

Promise<void>#

方法​

all​

allInnerTexts​

allTextContents​

and​

ariaSnapshot​

blur​

boundingBox​

check​

clear​

click​

contentFrame​

count​

dblclick​

describe​

description​

dispatchEvent​

dragTo​

evaluate​

evaluateAll​

evaluateHandle​

fill​

filter​

first​

focus​

frameLocator​

getAttribute​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

highlight​

hover​

last​

locator​

nth​

page​

press​

screenshot​

scrollIntoViewIfNeeded​

selectOption​

selectText​

setChecked​

setInputFiles​

tap​

textContent​

toString​

uncheck​

waitFor​

已弃用​

elementHandle​

elementHandles​

type​

方法

all

allInnerTexts

allTextContents

and

ariaSnapshot

blur

boundingBox

check

clear

click

contentFrame

count

dblclick

describe

description

dispatchEvent

dragTo

evaluate

evaluateAll

evaluateHandle

fill

filter

first

focus

frameLocator

getAttribute

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

highlight

hover

last

locator

nth

page

press

screenshot

scrollIntoViewIfNeeded

selectOption

selectText

setChecked

setInputFiles

tap

textContent

toString

uncheck

waitFor

已弃用

elementHandle

elementHandles

type