跳至主要内容

定位器

定位器是 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();

返回值

allInnerTexts​

新增于: v1.14 locator.allInnerTexts

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

断言文本

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

用法

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

返回值

allTextContents​

新增于: v1.14 locator.allTextContents

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

断言文本

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

用法

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

返回值

and​

新增于: v1.34 locator.and

创建一个匹配此定位器和参数定位器二者的定位器。

用法

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

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

参数

  • locator Locator#

    要匹配的附加定位器。

返回值

blur​

新增于: v1.28 locator.blur

在元素上调用 blur。

用法

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

参数

返回值

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

参数

返回值

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

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

    • timeout 数字 (可选)#

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

    • trial 布尔值 (可选)#

      当设置时，此方法仅执行 可操作性 检查并跳过操作。 默认值为 false。 有助于在元素准备就绪以进行操作而不执行操作时等待。

返回值

细节

执行以下步骤

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

如果元素在操作过程中的任何时刻与 DOM 脱离，此方法将抛出异常。

如果所有步骤组合起来在指定的 timeout 内未完成，此方法将抛出一个 TimeoutError。 传递零超时将禁用此功能。

clear​

新增于: v1.28 locator.clear

清除输入字段。

用法

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

参数

返回值

细节

此方法等待 可操作性 检查，聚焦元素，清除它并在清除后触发 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 数字 (可选)#

      默认值为 1。 请参阅 UIEvent.detail。

    • delay 数字 (可选)#

      在 mousedown 和 mouseup 之间等待的时间（以毫秒为单位）。 默认值为 0。

    • force 布尔值 (可选)#

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

    • modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项将在将来默认设置为 true。

      启动导航的操作正在等待这些导航发生，并等待页面开始加载。 您可以通过设置此标志来选择不等待。 您只需要在特殊情况下使用此选项，例如导航到不可访问的页面。 默认值为 false。

    • position 对象 (可选)#

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

    • timeout 数字 (可选)#

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

    • trial 布尔值 (可选)#

      当设置时，此方法仅执行 可操作性 检查并跳过操作。 默认值为 false。 有助于在元素准备就绪以进行操作而不执行操作时等待。 请注意，键盘 modifiers 将无论 trial 如何都会被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

细节

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

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

返回值

count​

新增于: v1.14 locator.count

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

断言计数

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

用法

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

返回值

dblclick​

新增于: v1.14 locator.dblclick

双击元素。

用法

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

参数

  • options Object (可选)

    • button "left" | "right" | "middle" (可选)#

      默认值为 left。

    • delay 数字 (可选)#

      在 mousedown 和 mouseup 之间等待的时间（以毫秒为单位）。 默认值为 0。

    • force 布尔值 (可选)#

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

    • modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)#

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

    • timeout 数字 (可选)#

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

    • trial 布尔值 (可选)#

      当设置时，此方法仅执行 可操作性 检查并跳过操作。 默认值为 false。 有助于在元素准备就绪以进行操作而不执行操作时等待。 请注意，键盘 modifiers 将无论 trial 如何都会被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

细节

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

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

如果元素在操作过程中的任何时刻与 DOM 脱离，此方法将抛出异常。

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

注意

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

dispatchEvent​

新增于: v1.14 locator.dispatchEvent

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

用法

await locator.dispatchEvent('click');

参数

返回值

细节

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

在幕后，它根据给定的type创建事件实例，用eventInit属性对其进行初始化，并在元素上分派它。事件默认情况下是composed、cancelable和冒泡的。

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

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

// Note you can only create DataTransfer in Chromium and Firefox
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 定位器#

    要拖动到的元素的定位器。

  • options Object (可选)

    • force 布尔值 (可选)#

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • sourcePosition 对象 (可选)#

      相对于元素填充框的左上角，在该点单击源元素。如果未指定，则使用元素的某个可见点。

    • targetPosition 对象 (可选)#

      相对于元素填充框的左上角，在该点将目标元素放下。如果未指定，则使用元素的某个可见点。

    • timeout 数字 (可选)#

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

    • trial 布尔值 (可选)#

      当设置时，此方法仅执行 可操作性 检查并跳过操作。 默认值为 false。 有助于在元素准备就绪以进行操作而不执行操作时等待。

返回值

细节

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

evaluate​

新增于: v1.14 locator.evaluate

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

用法

const tweets = page.locator('.tweet .retweets');
expect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');

参数

返回值

细节

返回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的返回值，该函数以所有匹配元素的数组作为第一个参数调用，并将arg作为第二个参数调用。

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

如果pageFunction抛出或拒绝，则此方法将抛出。

evaluateHandle​

新增于: v1.14 locator.evaluateHandle

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

用法

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

参数

返回值

细节

返回 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');

参数

返回值

细节

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

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，则此方法会抛出错误。但是，如果元素位于具有关联 control 的 <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>。

返回值

first​

新增于: v1.14 locator.first

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

用法

locator.first();

返回值

focus​

新增于: v1.14 locator.focus

对匹配的元素调用 focus。

用法

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

参数

返回值

frameLocator​

新增于：v1.17 locator.frameLocator

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

用法

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

参数

  • selector string#

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

返回值

getAttribute​

新增于: v1.14 locator.getAttribute

返回匹配元素的属性值。

断言属性

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

用法

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

参数

返回值

getByAltText​

新增于：v1.27 locator.getByAltText

允许通过其替代文本定位元素。

用法

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

<img alt='Playwright logo'>
await page.getByAltText('Playwright logo').click();

参数

  • text string | RegExp#

    用于定位元素的文本。

  • options Object (可选)

    • exact boolean (可选)#

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

返回值

getByLabel​

新增于：v1.27 locator.getByLabel

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

用法

例如，此方法将在以下 DOM 中通过标签“Username”和“Password”找到输入

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
await page.getByLabel('Username').fill('john');
await page.getByLabel('Password').fill('secret');

参数

  • text string | RegExp#

    用于定位元素的文本。

  • options Object (可选)

    • exact boolean (可选)#

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

返回值

getByPlaceholder​

新增于：v1.27 locator.getByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

<input type="email" placeholder="[email protected]" />

您可以通过占位符文本找到输入框后，在其中输入内容。

await page
    .getByPlaceholder('[email protected]')
    .fill('[email protected]');

参数

  • text 字符串 | 正则表达式#

    用于定位元素的文本。

  • options Object (可选)

    • exact 布尔值 (可选)#

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

返回值

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 布尔值 (可选)#

      通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。

      了解更多关于 aria-checked 的内容。

    • disabled 布尔值 (可选)#

      通常由 aria-disabled 或 disabled 设置的属性。

      注意

      与大多数其他属性不同，disabled 会通过 DOM 层次结构继承。了解更多关于 aria-disabled 的内容。

    • exact 布尔值 (可选)新增于: v1.28#

      是否 名称 是精确匹配的：区分大小写和整字符串。默认为 false。当 名称 是正则表达式时会被忽略。请注意，精确匹配仍然会修剪空格。

    • expanded 布尔值 (可选)#

      通常由 aria-expanded 设置的属性。

      了解更多关于 aria-expanded 的内容。

    • includeHidden 布尔值 (可选)#

      控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（由 ARIA 定义）会由角色选择器匹配。

      了解更多关于 aria-hidden 的内容。

    • level 数字 (可选)#

      通常对于角色 heading、listitem、row、treeitem 存在的数字属性，<h1>-<h6> 元素有默认值。

      了解更多关于 aria-level 的内容。

    • name 字符串 | 正则表达式 (可选)#

      用于匹配 可访问名称 的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 exact 来控制此行为。

      了解更多关于 可访问名称 的内容。

    • pressed 布尔值 (可选)#

      通常由 aria-pressed 设置的属性。

      了解更多关于 aria-pressed 的内容。

    • selected 布尔值 (可选)#

      通常由 aria-selected 设置的属性。

      了解更多关于 aria-selected 的内容。

返回值

细节

角色选择器 **不能替代** 可访问性审核和一致性测试，而是提供关于 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();

参数

返回值

细节

默认情况下，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 字符串 | 正则表达式#

    用于定位元素的文本。

  • options Object (可选)

    • exact 布尔值 (可选)#

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

返回值

细节

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

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

getByTitle​

新增于：v1.27 locator.getByTitle

允许通过其标题属性定位元素。

用法

考虑以下 DOM 结构。

<span title='Issues count'>25 issues</span>

您可以通过标题文本定位后，检查问题数量。

await expect(page.getByTitle('Issues count')).toHaveText('25 issues');

参数

  • text 字符串 | 正则表达式#

    用于定位元素的文本。

  • options Object (可选)

    • exact 布尔值 (可选)#

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

返回值

highlight​

添加于：v1.20 locator.highlight

突出显示屏幕上的对应元素。这对于调试很有用，不要提交使用 locator.highlight() 的代码。

用法

await locator.highlight();

返回值

hover​

新增于: v1.14 locator.hover

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

用法

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

参数

  • options Object (可选)

    • force 布尔值 (可选)#

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

    • modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#

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

    • noWaitAfter 布尔值 (可选)新增于: v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)#

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

    • timeout 数字 (可选)#

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

    • trial 布尔值 (可选)#

      当设置时，此方法仅执行 可操作性 检查并跳过操作。 默认值为 false。 有助于在元素准备就绪以进行操作而不执行操作时等待。 请注意，键盘 modifiers 将无论 trial 如何都会被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

细节

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

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

如果元素在操作过程中的任何时刻与 DOM 脱离，此方法将抛出异常。

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

innerHTML​

新增于: v1.14 locator.innerHTML

返回element.innerHTML。

用法

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

参数

返回值

innerText​

新增于: v1.14 locator.innerText

返回element.innerText。

断言文本

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

用法

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

参数

返回值

inputValue​

新增于: v1.14 locator.inputValue

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

断言值

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

用法

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

参数

返回值

细节

抛出不是输入、文本区域或下拉菜单的元素。但是，如果元素在具有关联的<label>元素内control，则返回控制的值。

isChecked​

新增于: v1.14 locator.isChecked

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

断言选中状态

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

用法

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

参数

返回值

isDisabled​

新增于: v1.14 locator.isDisabled

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

断言禁用状态

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

用法

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

参数

返回值

isEditable​

新增于: v1.14 locator.isEditable

返回元素是否可编辑。

断言可编辑状态

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

用法

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

参数

返回值

isEnabled​

新增于: v1.14 locator.isEnabled

返回元素是否已启用。

断言已启用状态

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

用法

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

参数

返回值

isHidden​

新增于: v1.14 locator.isHidden

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

断言可见性

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

用法

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

参数

返回值

isVisible​

新增于: v1.14 locator.isVisible

返回元素是否可见。

断言可见性

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

用法

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

参数

返回值

last​

新增于: v1.14 locator.last

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

用法

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

返回值

locator​

新增于: v1.14 locator.locator

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

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

用法

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

参数

  • selectorOrLocator 字符串 | 定位器#

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

  • options Object (可选)

    • has 定位器 (可选)#

      将方法的结果缩小到那些包含与该相对定位器匹配的元素的结果。例如，包含 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，匹配是不区分大小写的，并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

nth​

新增于: v1.14 locator.nth

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

用法

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

参数

返回值

or​

新增于：v1.33 locator.or

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

请注意，当两个定位器都匹配某些内容时，结果定位器将具有多个匹配项，并违反定位器严格性指南。

用法

假设您想点击“新建电子邮件”按钮，但有时会出现安全设置对话框。在这种情况下，您可以等待“新建电子邮件”按钮或对话框，并采取相应措施。

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

参数

  • locator 定位器#

    要匹配的备用定位器。

返回值

page​

添加时间：v1.19 locator.page

此定位器所属的页面。

用法

locator.page();

返回值

press​

新增于: v1.14 locator.press

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

用法

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

参数

  • key 字符串#

    要按下的键名称或要生成的字符，例如 ArrowLeft 或 a。

  • options Object (可选)

    • delay 数字 (可选)#

      keydown 和 keyup 之间等待的时间，以毫秒为单位。默认为 0。

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项将在将来默认设置为 true。

      启动导航的操作正在等待这些导航发生，并等待页面开始加载。 您可以通过设置此标志来选择不等待。 您只需要在特殊情况下使用此选项，例如导航到不可访问的页面。 默认值为 false。

    • timeout 数字 (可选)#

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

返回值

细节

聚焦元素，然后使用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 字符串#

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

  • options Object (可选)

    • delay 数字 (可选)#

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • timeout 数字 (可选)#

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

返回值

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 string (可选)添加于：v1.41#

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

    • timeout number (可选)#

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

    • type "png" | "jpeg" (可选)#

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

返回值

细节

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

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

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

scrollIntoViewIfNeeded​

新增于: v1.14 locator.scrollIntoViewIfNeeded

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

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

用法

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

参数

返回值

selectOption​

新增于: v1.14 locator.selectOption

选择 <select> 中的选项或选项。

用法

<select multiple>
  <option value="red">Red</div>
  <option value="green">Green</div>
  <option value="blue">Blue</div>
</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 string (可选)

      按 option.value 匹配。可选。

    • label string (可选)

      按 option.label 匹配。可选。

    • index number (可选)

      按索引匹配。可选。

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

返回值

细节

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

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

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

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

selectText​

新增于: v1.14 locator.selectText

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

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

用法

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

参数

返回值

setChecked​

添加于：v1.15 locator.setChecked

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

用法

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

参数

  • checked boolean#

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

  • options Object (可选)

    • force boolean (可选)#

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

    • noWaitAfter boolean (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)#

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

    • timeout 数字 (可选)#

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

    • trial 布尔值 (可选)#

      当设置时，此方法仅执行 可操作性 检查并跳过操作。 默认值为 false。 有助于在元素准备就绪以进行操作而不执行操作时等待。

返回值

细节

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

  1. 确保匹配的元素是复选框或单选按钮。如果不是，此方法将抛出异常。
  2. 如果元素已经处于正确的选中状态，此方法将立即返回。
  3. 等待对匹配元素进行可操作性检查，除非设置了force选项。如果元素在检查过程中被分离，则整个操作将重试。
  4. 如果需要，将元素滚动到视图中。
  5. 使用 page.mouse 点击元素的中心。
  6. 确保元素现在已选中或未选中。如果不是，此方法将抛出异常。

当所有步骤组合在指定的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')
});

参数

返回值

细节

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

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

tap​

新增于: v1.14 locator.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 对象 (可选)#

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

    • timeout 数字 (可选)#

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

    • trial 布尔值 (可选)#

      当设置时，此方法仅执行 可操作性 检查并跳过操作。 默认值为 false。 有助于在元素准备就绪以进行操作而不执行操作时等待。 请注意，键盘 modifiers 将无论 trial 如何都会被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

细节

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

  1. 等待对元素进行可操作性检查，除非设置了force选项。
  2. 如果需要，将元素滚动到视图中。
  3. 使用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);

参数

返回值

uncheck​

新增于: v1.14 locator.uncheck

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

用法

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

参数

  • options Object (可选)

    • force 布尔值 (可选)#

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

    • noWaitAfter 布尔值 (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • position 对象 (可选)#

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

    • timeout 数字 (可选)#

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

    • trial 布尔值 (可选)#

      当设置时，此方法仅执行 可操作性 检查并跳过操作。 默认值为 false。 有助于在元素准备就绪以进行操作而不执行操作时等待。

返回值

细节

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

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

如果元素在操作过程中的任何时刻与 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() 方法更改。

返回值

已弃用​

elementHandle​

新增于: v1.14 locator.elementHandle
不建议

始终优先使用 定位器 和网页断言而不是 ElementHandle，因为后者本质上是竞争性的。

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

用法

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

参数

返回值

elementHandles​

新增于: v1.14 locator.elementHandles
不建议

始终优先使用 定位器 和网页断言而不是 ElementHandle，因为后者本质上是竞争性的。

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

用法

await locator.elementHandles();

返回值

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

返回值