Locator

定位符 (Locators) 是 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<数组<Locator>>#

allInnerTexts

新增于: v1.14

locator.allInnerTexts

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

断言文本

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

用法

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

返回值

Promise<数组<string>>#

allTextContents

新增于: v1.14

locator.allTextContents

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

断言文本

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

用法

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

返回值

Promise<数组<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 (可选)
- ref boolean (可选)新增于: v1.52#
  
  为每个元素生成符号引用。在捕获快照后，可以使用 aria-ref=<ref> 定位符立即对该元素执行操作。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<string>#

详情

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

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

对象的键是元素的角色和可选的无障碍名称（accessible names）。
值是文本内容或子元素数组。
通用静态文本可以用 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 (可选)#
  
  是否绕过可操作性 (actionability) 检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距（padding box）左上角的坐标点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性 (actionability) 检查，跳过实际操作。默认为 false。可用于等待元素准备好执行操作，而不实际执行。

返回值

Promise<void>#

详情

执行以下步骤

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

如果在操作过程中元素从 DOM 中分离，此方法会抛出错误。

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

clear

新增于: v1.28

locator.clear

清空输入字段。

用法

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

参数

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

返回值

Promise<void>#

详情

此方法会等待可操作性 (actionability) 检查通过，然后聚焦元素，清空内容，并在清空后触发 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 (可选)#
  
  是否绕过可操作性 (actionability) 检查。默认为 false。
- modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项将来会默认为 true。
  
  启动导航的操作会等待这些导航发生以及页面开始加载。您可以通过设置此标志来选择不等待。仅在导航到不可访问页面等特殊情况下才需要此选项。默认为 false。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距（padding box）左上角的坐标点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性 (actionability) 检查，跳过实际操作。默认为 false。可用于等待元素准备好执行操作，而不实际执行。请注意，无论是否设置 trial，键盘 modifiers 都会被按下，以便测试只有按下这些键才可见的元素。

返回值

Promise<void>#

详情

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

等待元素上的可操作性 (actionability) 检查通过，除非设置了 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 (可选)#
  
  是否绕过可操作性 (actionability) 检查。默认为 false。
- modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距（padding box）左上角的坐标点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性 (actionability) 检查，跳过实际操作。默认为 false。可用于等待元素准备好执行操作，而不实际执行。请注意，无论是否设置 trial，键盘 modifiers 都会被按下，以便测试只有按下这些键才可见的元素。

返回值

Promise<void>#

详情

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

等待元素上的可操作性 (actionability) 检查通过，除非设置了 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 且会冒泡 (bubble)。

由于 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 (可选)#
  
  是否绕过可操作性 (actionability) 检查。默认为 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 (可选)#
  
  设置后，此方法仅执行可操作性 (actionability) 检查，跳过实际操作。默认为 false。可用于等待元素准备好执行操作，而不实际执行。

返回值

Promise<void>#

详情

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

evaluate

新增于: v1.14

locator.evaluate

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

用法

参数

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 (可选)#
  
  是否绕过可操作性 (actionability) 检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<void>#

详情

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

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

要发送细粒度的键盘事件，请使用 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 (可选)#
  
  将方法的搜索结果缩小到包含匹配此相对定位器的元素的那些结果。例如，包含 text=Playwright 的 article 匹配 <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 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.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

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

用法

例如，考虑以下 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 boolean (可选)新增于: 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 (可选)#
  
  匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 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 匹配，而不是文本内容。例如，通过文本 "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 (可选)#
  
  是否绕过可操作性 (actionability) 检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)新增于: v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距（padding box）左上角的坐标点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。
- trial boolean (可选)#
  
  设置后，此方法仅执行可操作性 (actionability) 检查，跳过实际操作。默认为 false。可用于等待元素准备好执行操作，而不实际执行。请注意，无论是否设置 trial，键盘 modifiers 都会被按下，以便测试只有按下这些键才可见的元素。

返回值

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

返回元素是否被禁用，与启用相对。

断言禁用状态

如果您需要断言元素被禁用，请首选 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] 的角色，则此方法会抛出错误。

断言可编辑状态

如果您需要断言元素是可编辑的，请首选 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

返回元素是否隐藏，与可见相对。

断言可见性

如果您需要断言元素是隐藏的，请首选 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 (可选)#
  
  将方法的搜索结果缩小到包含匹配此相对定位器的元素的那些结果。例如，包含 text=Playwright 的 article 匹配 <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 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

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

请注意，当两个定位器都匹配到元素时，结果定位器将会有多个匹配项，可能导致定位器严格模式违规。

用法

考虑一种情况，您想点击“新邮件”按钮，但有时会显示一个安全设置对话框。在这种情况下，您可以等待“新邮件”按钮或对话框，并根据情况采取相应行动。

注意

如果“新邮件”按钮和安全对话框都出现在屏幕上，“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 Animations。动画根据其持续时间进行不同的处理：
  - 有限动画被快进至完成，因此它们会触发 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 string (可选)添加于: v1.41#
  
  应用于截图时的样式表文本。你可以在这里隐藏动态元素、使元素不可见或改变它们的属性，以便创建可重复的截图。此样式表会穿透 Shadow DOM 并应用于内部框架。
- timeout 数字 (可选)#
  
  最大等待时间（毫秒）。默认为 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 数字 (可选)#
  
  最大等待时间（毫秒）。默认为 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 | Array<字符串> | Object | Array<ElementHandle> | Array<Object>#
- value 字符串 (可选)
  
  根据 option.value 匹配。可选。
- label 字符串 (可选)
  
  根据 option.label 匹配。可选。
- index 数字 (可选)
  
  根据索引匹配。可选。
要选择的选项。如果 <select> 具有 multiple 属性，则会选择所有匹配的选项，否则只选择与传入选项之一匹配的第一个选项。字符串值既匹配 value 也匹配 label。如果所有指定属性都匹配，则认为选项匹配。
options Object (可选)
- force 布尔值 (可选)#
  
  是否绕过可操作性 (actionability) 检查。默认为 false。
- noWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout 数字 (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<Array<字符串>>#

详情

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

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

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

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

selectText

新增于: v1.14

locator.selectText

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

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

用法

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

参数

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

返回值

Promise<void>#

详情

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

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

如果所有步骤在指定的超时时间内未能完成，此方法将抛出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 字符串 | Array<字符串> | Object | Array<Object>#
- name 字符串
  
  文件名
- mimeType 字符串
  
  文件类型
- buffer Buffer
  
  文件内容
options Object (可选)
- noWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- timeout 数字 (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。

返回值

Promise<void>#

详情

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

此方法要求定位器 (Locator) 指向一个输入元素 (input element)。但是，如果元素位于具有关联控件的 <label> 元素内，则会改为指向该控件。

tap

新增于: v1.14

locator.tap

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

用法

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

参数

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

返回值

Promise<void>#

详情

此方法通过执行以下步骤轻触元素

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

如果在操作过程中元素从 DOM 中分离，此方法会抛出错误。

如果所有步骤在指定的超时时间内未能完成，此方法将抛出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 布尔值 (可选)#
  
  是否绕过可操作性 (actionability) 检查。默认为 false。
- noWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距（padding box）左上角的坐标点。如果未指定，则使用元素的某个可见点。
- timeout 数字 (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 不超时。默认值可以通过配置文件中的 actionTimeout 选项修改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法设置。
- trial 布尔值 (可选)#
  
  设置后，此方法仅执行可操作性 (actionability) 检查，跳过实际操作。默认为 false。可用于等待元素准备好执行操作，而不实际执行。

返回值

Promise<void>#

详情

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

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

如果在操作过程中元素从 DOM 中分离，此方法会抛出错误。

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

waitFor

添加于: v1.16

locator.waitFor

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

如果目标元素已满足条件，则方法立即返回。否则，将等待最多超时时间（以毫秒为单位），直到满足条件。

用法

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