ElementHandle

扩展：JSHandle

ElementHandle 表示页面内的 DOM 元素。可以使用 page.$() 方法创建 ElementHandles。

不建议使用

不建议使用 ElementHandle，请改用 Locator 对象和 Web-first 断言。

const hrefElement = await page.$('a');
await hrefElement.click();

除非使用 jsHandle.dispose() 处置句柄，否则 ElementHandle 会阻止 DOM 元素被垃圾回收。当其源框架被导航时，ElementHandles 会自动处置。

ElementHandle 实例可以用作 page.$eval() 和 page.evaluate() 方法的参数。

Locator 和 ElementHandle 之间的区别在于，ElementHandle 指向特定元素，而 Locator 捕获如何检索元素的逻辑。

在下面的示例中，handle 指向页面上的特定 DOM 元素。如果该元素更改文本或被 React 用于渲染完全不同的组件，handle 仍然指向该 DOM 元素。这可能导致意外行为。

const handle = await page.$('text=Submit');
// ...
await handle.hover();
await handle.click();

使用定位器时，每次使用 element 时，都会使用选择器在页面中找到最新的 DOM 元素。因此，在下面的代码段中，底层 DOM 元素将被定位两次。

const locator = page.getByText('Submit');
// ...
await locator.hover();
await locator.click();

方法

boundingBox

在 v1.9 之前添加

elementHandle.boundingBox

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

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

来自子框架的元素返回相对于主框架的边界框，这与 Element.getBoundingClientRect 不同。

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

用法

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

返回值

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

contentFrame

在 v1.9 之前添加

elementHandle.contentFrame

对于引用 iframe 节点的元素句柄，返回内容框架，否则返回 null

用法

await elementHandle.contentFrame();

返回值

Promise<null | Frame>#

ownerFrame

在 v1.9 之前添加

elementHandle.ownerFrame

返回包含给定元素的框架。

用法

await elementHandle.ownerFrame();

返回值

Promise<null | Frame>#

waitForElementState

在 v1.9 之前添加

elementHandle.waitForElementState

当元素满足 state 时返回。

根据 state 参数，此方法等待其中一个 actionability 检查通过。除非等待 "hidden" 状态，否则此方法会在等待时元素分离时抛出异常。

"visible" 等待元素变为可见。
"hidden" 等待元素变为不可见或未附加。请注意，当元素分离时，等待隐藏不会抛出异常。
"stable" 等待元素同时可见和稳定。
"enabled" 等待元素变为启用。
"disabled" 等待元素变为禁用。
"editable" 等待元素变为可编辑。

如果元素在 timeout 毫秒内未满足条件，则此方法将抛出异常。

用法

await elementHandle.waitForElementState(state);
await elementHandle.waitForElementState(state, options);

参数

state "visible" | "hidden" | "stable" | "enabled" | "disabled" | "editable"#

要等待的状态，有关详细信息，请参见下文。
options 对象 （可选）
- timeout 数字 （可选）#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

返回值

Promise<void>#

已弃用

$

在以下版本中添加：v1.9

elementHandle.$

不建议使用

请改用基于定位器的 page.locator()。详细了解定位器。

此方法在 ElementHandle 的子树中查找与指定选择器匹配的元素。如果没有任何元素与选择器匹配，则返回 null。

用法

await elementHandle.$(selector);

参数

selector 字符串 #

要查询的选择器。

返回值

Promise<null | ElementHandle>#

$$

在以下版本中添加：v1.9

elementHandle.$$

不建议使用

请改用基于定位器的 page.locator()。详细了解定位器。

此方法查找 ElementHandle 子树中与指定选择器匹配的所有元素。如果没有任何元素与选择器匹配，则返回空数组。

用法

await elementHandle.$$(selector);

参数

selector 字符串 #

要查询的选择器。

返回值

Promise<Array<ElementHandle>>#

$eval

在以下版本中添加：v1.9

elementHandle.$eval

不建议使用

此方法不会等待元素通过可操作性检查，因此可能导致测试不稳定。请改用 locator.evaluate()、其他 Locator 辅助方法或 Web-first 断言。

返回 pageFunction 的返回值。

此方法在 ElementHandle 的子树中查找与指定选择器匹配的元素，并将其作为第一个参数传递给 pageFunction。如果没有任何元素匹配选择器，则此方法会抛出错误。

如果 pageFunction 返回一个 Promise，则 elementHandle.$eval() 会等待 Promise 解析并返回其值。

用法

const tweetHandle = await page.$('.tweet');
expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');
expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');

参数

selector 字符串 #

要查询的选择器。
pageFunction 函数(元素) | 字符串 #

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

传递给 pageFunction 的可选参数。

返回值

Promise<可序列化值>#

$$eval

在以下版本中添加：v1.9

elementHandle.$$eval

不建议使用

在大多数情况下，locator.evaluateAll()、其他 Locator 辅助方法和 Web-first 断言可以更好地完成这项工作。

返回 pageFunction 的返回值。

此方法在 ElementHandle 的子树中查找与指定选择器匹配的所有元素，并将匹配元素的数组作为第一个参数传递给 pageFunction。

如果 pageFunction 返回一个 Promise，则 elementHandle.$$eval() 会等待 Promise 解析并返回其值。

用法

<div class="feed">
  <div class="tweet">Hello!</div>
  <div class="tweet">Hi!</div>
</div>

const feedHandle = await page.$('.feed');
expect(await feedHandle.$$eval('.tweet', nodes =>
  nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!'],
);

参数

selector 字符串 #

要查询的选择器。
pageFunction 函数(数组<元素>) | 字符串 #

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

传递给 pageFunction 的可选参数。

返回值

Promise<可序列化值>#

check

在 v1.9 之前添加

elementHandle.check

不建议使用

请改用基于定位器的 locator.check()。了解更多关于定位器的信息。

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

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

如果元素在操作过程中的任何时刻与 DOM 脱钩，则此方法会抛出错误。

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

用法

await elementHandle.check();
await elementHandle.check(options);

参数

options 对象 （可选）
- force 布尔值 （可选）#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter 布尔值 （可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position 对象 （可选）新增于：v1.11#
  - x 数字
  - y 数字
  相对于元素内边距盒左上角使用的点。如果未指定，则使用元素的一些可见点。
- timeout 数字 （可选）#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 （可选）新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作，而无需执行操作。

返回值

Promise<void>#

click

在 v1.9 之前添加

elementHandle.click

不建议使用

请改用基于定位器的 locator.click()。了解更多关于定位器的信息。

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

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

如果元素在操作过程中的任何时刻与 DOM 脱钩，则此方法会抛出错误。

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

用法

await elementHandle.click();
await elementHandle.click(options);

参数

options 对象 （可选）
- 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 对象 （可选）#
  - x 数字
  - y 数字
  相对于元素内边距盒左上角使用的点。如果未指定，则使用元素的一些可见点。
- timeout 数字 （可选）#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 （可选）新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作，而无需执行操作。

返回值

Promise<void>#

双击

在 v1.9 之前添加

elementHandle.dblclick

不建议使用

请改用基于定位器的 locator.dblclick()。了解更多关于定位器的信息。

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

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

如果元素在操作过程中的任何时刻与 DOM 脱钩，则此方法会抛出错误。

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

注意

elementHandle.dblclick() 分发两个 click 事件和一个 dblclick 事件。

用法

await elementHandle.dblclick();
await elementHandle.dblclick(options);

参数

options 对象 （可选）
- 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 对象 (可选)#
  - x 数字
  - y 数字
  相对于元素内边距盒左上角使用的点。如果未指定，则使用元素的一些可见点。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 （可选）新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作，而无需执行操作。

返回值

Promise<void>#

dispatchEvent

在 v1.9 之前添加

elementHandle.dispatchEvent

不建议使用

请改用基于定位器的 locator.dispatchEvent()。了解更多关于定位器的信息。

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

用法

await elementHandle.dispatchEvent('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 elementHandle.dispatchEvent('dragstart', { dataTransfer });

参数

type 字符串 #

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

可选的特定于事件的初始化属性。

返回值

Promise<void>#

填充

在 v1.9 之前添加

elementHandle.fill

不建议使用

请改用基于定位器的 locator.fill()。了解更多关于定位器的信息。

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

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

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

用法

await elementHandle.fill(value);
await elementHandle.fill(value, options);

参数

value 字符串 #

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

返回值

Promise<void>#

聚焦

在 v1.9 之前添加

elementHandle.focus

不建议使用

请改用基于定位器的 locator.focus()。了解更多关于定位器的信息。

在元素上调用 focus。

用法

await elementHandle.focus();

返回值

Promise<void>#

getAttribute

在 v1.9 之前添加

elementHandle.getAttribute

不建议使用

请改用基于定位器的 locator.getAttribute()。了解更多关于定位器的信息。

返回元素属性值。

用法

await elementHandle.getAttribute(name);

参数

name 字符串 #

要获取其值的属性名称。

返回值

Promise<null | 字符串>#

悬停

在 v1.9 之前添加

elementHandle.hover

不建议使用

请改用基于定位器的 locator.hover()。了解更多关于定位器的信息。

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

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

如果元素在操作过程中的任何时刻与 DOM 脱钩，则此方法会抛出错误。

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

用法

await elementHandle.hover();
await elementHandle.hover(options);

参数

options 对象 （可选）
- force 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter 布尔值 (可选)新增于：v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position 对象 (可选)#
  - x 数字
  - y 数字
  相对于元素内边距盒左上角使用的点。如果未指定，则使用元素的一些可见点。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 （可选）新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作，而无需执行操作。

返回值

Promise<void>#

innerHTML

在 v1.9 之前添加

elementHandle.innerHTML

不建议使用

请改用基于定位器的 locator.innerHTML()。了解更多关于定位器的信息。

返回 element.innerHTML。

用法

await elementHandle.innerHTML();

返回值

Promise<字符串>#

innerText

在 v1.9 之前添加

elementHandle.innerText

不建议使用

请改用基于定位器的 locator.innerText()。了解更多关于定位器的信息。

返回 element.innerText。

用法

await elementHandle.innerText();

返回值

Promise<字符串>#

inputValue

新增于：v1.13

elementHandle.inputValue

不建议使用

请改用基于定位器的 locator.inputValue()。了解更多关于定位器的信息。

返回选定的 <input> 或 <textarea> 或 <select> 元素的 input.value。

对于非输入元素会抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内部，则返回该 control 的值。

用法

await elementHandle.inputValue();
await elementHandle.inputValue(options);

参数

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

返回值

Promise<字符串>#

isChecked

在 v1.9 之前添加

elementHandle.isChecked

不建议使用

请改用基于定位器的 locator.isChecked()。了解更多关于定位器的信息。

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

用法

await elementHandle.isChecked();

返回值

Promise<布尔值>#

isDisabled

在 v1.9 之前添加

elementHandle.isDisabled

不建议使用

请改用基于定位器的 locator.isDisabled()。了解更多关于定位器的信息。

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

用法

await elementHandle.isDisabled();

返回值

Promise<布尔值>#

isEditable

在 v1.9 之前添加

elementHandle.isEditable

不建议使用

请改用基于定位器的 locator.isEditable()。了解更多关于定位器的信息。

返回元素是否可编辑。

用法

await elementHandle.isEditable();

返回值

Promise<布尔值>#

isEnabled

在 v1.9 之前添加

elementHandle.isEnabled

不建议使用

请改用基于定位器的 locator.isEnabled()。了解更多关于定位器的信息。

返回元素是否启用。

用法

await elementHandle.isEnabled();

返回值

Promise<布尔值>#

isHidden

在 v1.9 之前添加

elementHandle.isHidden

不建议使用

请改用基于定位器的 locator.isHidden()。了解更多关于定位器的信息。

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

用法

await elementHandle.isHidden();

返回值

Promise<布尔值>#

isVisible

在 v1.9 之前添加

elementHandle.isVisible

不建议使用

请改用基于定位器的 locator.isVisible()。了解更多关于定位器的信息。

返回元素是否可见。

用法

await elementHandle.isVisible();

返回值

Promise<布尔值>#

press

在 v1.9 之前添加

elementHandle.press

不建议使用

请改用基于定位器的 locator.press()。了解更多关于定位器的信息。

聚焦元素，然后使用 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。

按住 Shift 将键入与 key 对应的文本（大写）。

如果 key 是单个字符，则区分大小写，因此值 a 和 A 将生成不同的文本。

也支持诸如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 之类的快捷方式。当与修饰符一起指定时，修饰符会被按下并保持按住状态，同时按下后续键。

用法

await elementHandle.press(key);
await elementHandle.press(key, options);

参数

key 字符串 #

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

返回值

Promise<void>#

screenshot

在 v1.9 之前添加

elementHandle.screenshot

不建议使用

请改用基于定位器的 locator.screenshot()。了解更多关于定位器的信息。

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

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

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

用法

await elementHandle.screenshot();
await elementHandle.screenshot(options);

参数

options 对象 （可选）
- animations "disabled" | "allow" (可选)#
  
  设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。动画根据其持续时间获得不同的处理方式
  - 有限动画被快速转发到完成，因此它们将触发 transitionend 事件。
  - 无限动画被取消到初始状态，然后在截图后播放。
  默认为 "allow"，它不会修改动画。
- caret "hide" | "initial" (可选)#
  
  当设置为 "hide" 时，截图将隐藏文本光标。当设置为 "initial" 时，文本光标行为将不会改变。默认为 "hide"。
- mask 数组<定位器> (可选)#
  
  指定在拍摄截图时应屏蔽的定位器。被屏蔽的元素将覆盖一个粉红色框 #FF00FF（由 maskColor 自定义），该框完全覆盖其边界框。
- maskColor 字符串 (可选)新增于：v1.35#
  
  指定被屏蔽元素的覆盖框颜色，使用 CSS 颜色格式。默认颜色为粉红色 #FF00FF。
- omitBackground 布尔值 (可选)#
  
  隐藏默认的白色背景，并允许捕获透明的截图。不适用于 jpeg 图片。默认为 false。
- path 字符串 (可选)#
  
  保存图像的文件路径。截图类型将根据文件扩展名推断。如果 path 是相对路径，则相对于当前工作目录解析。如果没有提供路径，则图像不会保存到磁盘。
- quality 数字 (可选)#
  
  图像质量，介于 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>#

scrollIntoViewIfNeeded

在 v1.9 之前添加

elementHandle.scrollIntoViewIfNeeded

不建议使用

请改用基于定位器的 locator.scrollIntoViewIfNeeded()。了解更多关于定位器的信息。

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

当 elementHandle 不指向连接到 Document 或 ShadowRoot 的元素时抛出异常。

有关滚动元素的其他方法，请参阅滚动。

用法

await elementHandle.scrollIntoViewIfNeeded();
await elementHandle.scrollIntoViewIfNeeded(options);

参数

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

返回值

Promise<void>#

selectOption

在 v1.9 之前添加

elementHandle.selectOption

不建议使用

请改用基于定位器的 locator.selectOption()。了解更多关于定位器的信息。

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

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

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

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

用法

// Single selection matching the value or label
handle.selectOption('blue');

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

// multiple selection
handle.selectOption(['red', 'green', 'blue']);

参数

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

返回值

Promise<数组<字符串>>#

selectText

在 v1.9 之前添加

elementHandle.selectText

不建议使用

请改用基于定位器的 locator.selectText()。了解更多关于定位器的信息。

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

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

用法

await elementHandle.selectText();
await elementHandle.selectText(options);

参数

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

返回值

Promise<void>#

setChecked

新增于：v1.15

elementHandle.setChecked

不建议使用

请改用基于定位器的 locator.setChecked()。了解更多关于定位器的信息。

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

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

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

用法

await elementHandle.setChecked(checked);
await elementHandle.setChecked(checked, options);

参数

checked 布尔值 #

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

返回值

Promise<void>#

setInputFiles

在 v1.9 之前添加

elementHandle.setInputFiles

不建议使用

请改用基于定位器的 locator.setInputFiles()。了解更多关于定位器的信息。

将文件输入的值设置为这些文件路径或文件。如果一些 filePaths 是相对路径，则它们相对于当前工作目录解析。对于空数组，清除选定的文件。对于具有 [webkitdirectory] 属性的输入，仅支持单个目录路径。

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

用法

await elementHandle.setInputFiles(files);
await elementHandle.setInputFiles(files, options);

参数

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

返回值

Promise<void>#

tap

在 v1.9 之前添加

elementHandle.tap

不建议使用

请改用基于定位器的 locator.tap()。了解更多关于定位器的信息。

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

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

如果元素在操作过程中的任何时刻与 DOM 脱钩，则此方法会抛出错误。

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

注意

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

用法

await elementHandle.tap();
await elementHandle.tap(options);

参数

options 对象 （可选）
- force 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position 对象 (可选)#
  - x 数字
  - y 数字
  相对于元素内边距盒左上角使用的点。如果未指定，则使用元素的一些可见点。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 （可选）新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作，而无需执行操作。

返回值

Promise<void>#

textContent

在 v1.9 之前添加

elementHandle.textContent

不建议使用

请改用基于定位器的 locator.textContent()。了解更多关于定位器的信息。

返回 node.textContent。

用法

await elementHandle.textContent();

返回值

Promise<null | 字符串>#

type

在 v1.9 之前添加

elementHandle.type

已弃用

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

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

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

用法

参数

text 字符串 #

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

返回值

Promise<void>#

uncheck

在 v1.9 之前添加

elementHandle.uncheck

不建议使用

请改用基于定位器的 locator.uncheck()。了解更多关于定位器的信息。

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

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

如果元素在操作过程中的任何时刻与 DOM 脱钩，则此方法会抛出错误。

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

用法

await elementHandle.uncheck();
await elementHandle.uncheck(options);

参数

options 对象 （可选）
- force 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position 对象 （可选）新增于：v1.11#
  - x 数字
  - y 数字
  相对于元素内边距盒左上角使用的点。如果未指定，则使用元素的一些可见点。
- timeout 数字 (可选)#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial 布尔值 （可选）新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好进行操作，而无需执行操作。

返回值

Promise<void>#

waitForSelector

在 v1.9 之前添加

elementHandle.waitForSelector

不建议使用

请改用断言可见性或基于定位器的 locator.waitFor()。

当选择器指定的元素满足 state 选项时，返回该元素。如果等待 hidden 或 detached，则返回 null。

等待相对于元素句柄的选择器满足状态选项（出现在 DOM 中/从 DOM 中消失，或变为可见/隐藏）。如果在调用方法时选择器已经满足条件，则方法将立即返回。如果选择器在超时毫秒内未满足条件，则函数将抛出异常。

用法

await page.setContent(`<div><span></span></div>`);
const div = await page.$('div');
// Waiting for the 'span' selector relative to the div.
const span = await div.waitForSelector('span', { state: 'attached' });

注意

此方法不适用于导航操作，请改用page.waitForSelector()。

参数

selector 字符串 #

要查询的选择器。
options 对象 （可选）
- state "attached" | "detached" | "visible" | "hidden" （可选）#
  
  默认为 'visible'。可以是以下任一值：
  - 'attached' - 等待元素出现在 DOM 中。
  - 'detached' - 等待元素不再出现在 DOM 中。
  - 'visible' - 等待元素具有非空边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空边界框，并且不被视为可见。
  - 'hidden' - 等待元素从 DOM 中分离，或具有空边界框或 visibility:hidden。这与 'visible' 选项相反。
- strict 布尔值 （可选）新增于：v1.15#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用会抛出异常。
- timeout 数字 （可选）#
  
  以毫秒为单位的最大时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或者使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

返回值

Promise<null | ElementHandle>#

方法​

boundingBox​

contentFrame​

ownerFrame​

waitForElementState​

已弃用​

$​

$$​

$eval​

$$eval​

check​

click​

双击​

dispatchEvent​

填充​

聚焦​

getAttribute​

悬停​

innerHTML​

innerText​

inputValue​

isChecked​

isDisabled​

isEditable​

isEnabled​

isHidden​

isVisible​

press​

screenshot​

scrollIntoViewIfNeeded​

selectOption​

selectText​

setChecked​

setInputFiles​

tap​

textContent​

type​

uncheck​

waitForSelector​

方法

boundingBox

contentFrame

ownerFrame

waitForElementState

已弃用

$

$$

$eval

$$eval

check

click

双击

dispatchEvent

填充

聚焦

getAttribute

悬停

innerHTML

innerText

inputValue

isChecked

isDisabled

isEditable

isEnabled

isHidden

isVisible

press

screenshot

scrollIntoViewIfNeeded

selectOption

selectText

setChecked

setInputFiles

tap

textContent

type

uncheck

waitForSelector