定位器

定位器是 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 (可选)
- 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"

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 number
  
  元素在像素中的 x 坐标。
- y number
  
  元素在像素中的 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 number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而无需执行操作时很有用。

返回值

Promise<void>#

详情

执行以下步骤

确保元素是复选框或单选输入框。如果不是，此方法将抛出错误。如果元素已被选中，则此方法立即返回。
等待元素上的可操作性检查，除非设置了 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> 元素内，则将清除控件。

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 number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- 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 number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- 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 事件。

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 #

要拖动到的元素的 Locator。
options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- sourcePosition Object (可选)#
  - x number
  - y number
  点击源元素时，相对于元素内边距框的左上角的坐标。如果未指定，则使用元素的某个可见点。
- targetPosition Object (可选)#
  - x number
  - y number
  在目标元素上放下时，相对于元素内边距框的左上角的坐标。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作而无需执行操作时很有用。

返回值

Promise<void>#

详情

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

evaluate

添加于: v1.14

locator.evaluate

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

用法

参数

pageFunction function | string #

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

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

返回值

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 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

返回值

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

详情

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

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

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

filter

添加于版本: v1.22

locator.filter

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

用法

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 (可选)#
  
  将方法的搜索结果缩小到包含与此相对 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 string | RegExp (可选)添加于版本: v1.33#
  
  匹配元素内部某处（可能在子元素或后代元素中）不包含指定文本的元素。当传递 string 时，匹配不区分大小写，并搜索子字符串。
- hasText string | RegExp (可选)#
  
  匹配元素内部某处（可能在子元素或后代元素中）包含指定文本的元素。当传递 string 时，匹配不区分大小写，并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。
- visible boolean (可选)添加于版本: v1.51#
  
  仅匹配可见或不可见元素。

返回值

Locator #

first

添加于: v1.14

locator.first

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

用法

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 时，您可以创建一个 frame locator，它将进入 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 中通过标签 “Username” 和 “Password” 找到输入框

<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

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

用法

例如，考虑以下 DOM 结构。

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

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

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

用法

考虑以下 DOM 结构。

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

您可以根据每个元素的隐式 role 定位它

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

返回值

Locator #

详情

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

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

getByTestId

添加于版本: v1.27

locator.getByTestId

通过 test id 定位元素。

用法

考虑以下 DOM 结构。

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

您可以根据元素的 test id 定位它

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

参数

testId string | RegExp #

用于定位元素的 ID。

返回值

Locator #

详情

默认情况下，data-testid 属性用作 test id。如果需要配置不同的 test id 属性，请使用 selectors.setTestIdAttribute()。

// 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 的 Input 元素会通过其 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 | 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 boolean (可选)添加于: v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- 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，则会抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则返回 control 的值。

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

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

断言禁用状态

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

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

断言可编辑状态

如果需要断言元素为可编辑状态，请优先使用 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 (可选)#
  
  将方法的搜索结果缩小到包含与此相对 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 string | RegExp (可选)添加于版本: v1.33#
  
  匹配元素内部某处（可能在子元素或后代元素中）不包含指定文本的元素。当传递 string 时，匹配不区分大小写，并搜索子字符串。
- hasText string | RegExp (可选)#
  
  匹配元素内部某处（可能在子元素或后代元素中）包含指定文本的元素。当传递 string 时，匹配不区分大小写，并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

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”定位器将同时匹配它们，可能会抛出 “严格模式违规”错误。在这种情况下，您可以使用 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 string (可选)添加于版本: 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 数字 （可选）#
  
  最大等待时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- type "png" | "jpeg" （可选）#
  
  指定屏幕截图类型，默认为 png。

返回值

Promise<Buffer>#

详情

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

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

返回包含捕获的屏幕截图的 Buffer。

scrollIntoViewIfNeeded

添加于: v1.14

locator.scrollIntoViewIfNeeded

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

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

用法

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

参数

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

返回值

Promise<数组<字符串>>#

详情

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

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

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

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

selectText

添加于: v1.14

locator.selectText

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

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

用法

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

参数

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

返回值

Promise<void>#

setChecked

添加于：v1.15

locator.setChecked

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

用法

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

参数

checked 布尔值 #

是否选中或取消选中复选框。
options Object (可选)
- force 布尔值 （可选）#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter 布尔值 （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position 对象 （可选）#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout 数字 （可选）#
  
  最大等待时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 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 字符串 | 数组<字符串> | 对象 | 数组<对象>#
- name 字符串
  
  文件名
- mimeType 字符串
  
  文件类型
- buffer Buffer
  
  文件内容
options Object (可选)
- noWaitAfter 布尔值 （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout 数字 （可选）#
  
  最大等待时间，单位为毫秒。默认为 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 布尔值 （可选）#
  
  是否绕过可操作性检查。默认为 false。
- modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> （可选）#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter 布尔值 （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position 对象 （可选）#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout 数字 （可选）#
  
  最大等待时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 （可选）#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 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 数字 （可选）#
  
  最大等待时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

返回值

Promise<null | 字符串>#

uncheck

添加于: v1.14

locator.uncheck

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

用法

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

参数

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

返回值

Promise<ElementHandle>#

elementHandles

添加于: v1.14

locator.elementHandles

不推荐使用

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

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

用法

await locator.elementHandles();

返回值

Promise<数组<ElementHandle>>#

type

添加于: v1.14

locator.type

已弃用

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

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

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

用法

参数

text 字符串 #

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

返回值

Promise<void>#

方法​

all​

allInnerTexts​

allTextContents​

and​

ariaSnapshot​

blur​

boundingBox​

check​

clear​

click​

contentFrame​

count​

dblclick​

dispatchEvent​

dragTo​

evaluate​

evaluateAll​

evaluateHandle​

fill​

filter​

first​

focus​

frameLocator​

getAttribute​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

highlight​

hover​

innerHTML​

innerText​

inputValue​

isChecked​

isDisabled​

isEditable​

isEnabled​

isHidden​

isVisible​

last​

locator​

nth​

or​

page​

press​

pressSequentially​

screenshot​

scrollIntoViewIfNeeded​

selectOption​

selectText​

setChecked​

setInputFiles​

tap​

textContent​

uncheck​

waitFor​

已弃用​

elementHandle​

elementHandles​

type​

方法

all

allInnerTexts

allTextContents

and

ariaSnapshot

blur

boundingBox

check

clear

click

contentFrame

count

dblclick

dispatchEvent

dragTo

evaluate

evaluateAll

evaluateHandle

fill

filter

first

focus

frameLocator

getAttribute

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

highlight

hover

innerHTML

innerText

inputValue

isChecked

isDisabled

isEditable

isEnabled

isHidden

isVisible

last

locator

nth

or

page

press

pressSequentially

screenshot

scrollIntoViewIfNeeded

selectOption

selectText

setChecked

setInputFiles

tap

textContent

uncheck

waitFor

已弃用

elementHandle

elementHandles

type