ElementHandle

继承自: JSHandle

ElementHandle 表示页面中的一个 DOM 元素。可以通过 page.$() 方法创建 ElementHandle。

不推荐使用

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

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

ElementHandle 可以防止 DOM 元素被垃圾回收，除非通过 jsHandle.dispose() 方法释放句柄。当元素所在的框架发生导航时，ElementHandle 会自动释放。

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

而使用 locator 时，每次使用 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 number
  
  元素的 x 坐标（像素）
- y number
  
  元素的 y 坐标（像素）
- width number
  
  元素的宽度（像素）
- height number
  
  元素的高度（像素）

contentFrame

Added before v1.9

elementHandle.contentFrame

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

用法

await elementHandle.contentFrame();

返回值

Promise<null | Frame>#

ownerFrame

Added before v1.9

elementHandle.ownerFrame

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

用法

await elementHandle.ownerFrame();

返回值

Promise<null | Frame>#

waitForElementState

v1.9 之前版本添加

elementHandle.waitForElementState

当元素满足指定状态时返回。

根据状态参数的不同，该方法会等待某个可操作性检查通过。在等待过程中如果元素被分离，此方法会抛出异常（除非等待的是"hidden"状态）。

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

如果元素在超时毫秒内未满足条件，该方法将抛出异常。

用法

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

参数

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

需要等待的状态，详见上述说明
options Object (可选)
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为0表示无超时。默认值可通过配置文件中的actionTimeout选项，或使用browserContext.setDefaultTimeout()和page.setDefaultTimeout()方法修改

返回值

Promise<void>#

已弃用

$

添加于: v1.9

elementHandle.$

不推荐使用

建议改用基于定位器的 page.locator() 方法。了解更多关于定位器的信息。

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

用法

await elementHandle.$(selector);

参数

selector string #

要查询的选择器。

返回值

Promise<null | ElementHandle>#

$$

添加于: v1.9

elementHandle.$$

不推荐

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

该方法在 ElementHandle 的子节点树中查找所有匹配指定选择器的元素。如果没有元素匹配选择器，则返回空数组。

用法

await elementHandle.$$(selector);

参数

selector string #

要查询的选择器。

返回值

Promise<Array<ElementHandle>>#

$eval

添加于: v1.9

elementHandle.$eval

不推荐使用

此方法不会等待元素通过可操作性检查，因此可能导致测试不稳定。建议改用 locator.evaluate()、其他 Locator 辅助方法或基于网页优先的断言。

返回 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 string #

要查询的选择器。
pageFunction function(Element) | string #

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

传递给 pageFunction 的可选参数。

返回值

Promise<Serializable>#

$$eval

添加于: v1.9

elementHandle.$$eval

不推荐

在大多数情况下，locator.evaluateAll()、其他 Locator 辅助方法和基于网页优先的断言能更好地完成任务。

返回 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 string #

要查询的选择器。
pageFunction function(Array<Element>) | string #

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

传递给 pageFunction 的可选参数。

返回值

Promise<Serializable>#

check

v1.9 之前添加

elementHandle.check

不推荐使用

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

该方法通过以下步骤勾选元素：

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

如果在操作过程中元素从 DOM 中分离，该方法会抛出异常。

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

用法

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

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选) v1.11 新增#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。
- trial boolean (可选) 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 Object (可选)
- button "left" | "right" | "middle" (可选)#
  
  默认为 left。
- clickCount number (可选)#
  
  默认为 1。参见 UIEvent.detail。
- delay number (可选)#
  
  mousedown 和 mouseup 之间的等待时间（毫秒）。默认为 0。
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键状态。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter boolean (可选)#
  
  已弃用
  未来此选项将默认为 true。
  
  触发导航的操作会等待这些导航发生和页面开始加载。可以通过设置此标志来跳过等待。仅在特殊情况下（如导航到不可访问的页面）需要此选项。默认为 false。
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距框左上角的点击位置。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法修改。
- trial boolean (可选) v1.11 版本新增#
  
  当设置为 true 时，该方法仅执行可操作性检查并跳过实际操作。默认为 false。可用于等待元素准备好操作而不实际执行操作。

返回值

Promise<void>#

dblclick

v1.9 版本前添加

elementHandle.dblclick

不推荐使用

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

该方法通过以下步骤双击元素：

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

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

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

备注

elementHandle.dblclick() 会触发两次 click 事件和一次 dblclick 事件。

用法

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

参数

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

Promise<void>#

dispatchEvent

v1.9 版本前添加

elementHandle.dispatchEvent

不推荐使用

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

以下代码片段会在元素上触发 click 事件。无论元素是否可见，都会触发 click 事件。这等同于调用 element.click()。

用法

await elementHandle.dispatchEvent('click');

在底层实现中，它会根据给定的事件类型创建事件实例，使用eventInit属性初始化该事件，并在元素上触发。默认情况下，事件是 composed（可组合）、cancelable（可取消）且会冒泡的。

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

如果需要传递动态对象到事件中，也可以指定 JSHandle 作为属性值：

// 注意：DataTransfer 只能在 Chromium 和 Firefox 中创建
const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await elementHandle.dispatchEvent('dragstart', { dataTransfer });

参数

type string #

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

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

返回值

Promise<void>#

fill

v1.9 版本前添加

elementHandle.fill

不推荐使用

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

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

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

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

用法

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

参数

value string #

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

返回值

Promise<void>#

focus

Added before v1.9

elementHandle.focus

不推荐使用

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

在元素上调用 focus 方法。

用法

await elementHandle.focus();

返回值

Promise<void>#

getAttribute

Added before v1.9

elementHandle.getAttribute

不推荐使用

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

返回元素的属性值。

用法

await elementHandle.getAttribute(name);

参数

name string #

要获取值的属性名称。

返回值

Promise<null | string>#

hover

v1.9 之前版本添加

elementHandle.hover

不推荐使用

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

该方法通过以下步骤悬停在元素上：

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

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

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

用法

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

参数

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

返回值

Promise<void>#

innerHTML

Added before v1.9

elementHandle.innerHTML

不推荐使用

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

返回元素的 element.innerHTML。

用法

await elementHandle.innerHTML();

返回值

Promise<string>#

innerText

Added before v1.9

elementHandle.innerText

不推荐使用

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

返回元素的 element.innerText。

用法

await elementHandle.innerText();

返回值

Promise<string>#

inputValue

Added in: v1.13

elementHandle.inputValue

不推荐使用

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

返回所选 <input>、<textarea> 或 <select> 元素的 input.value 值。

对于非输入元素会抛出异常。但如果元素位于具有关联控件的 <label> 元素内，则返回该控件的值。

用法

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

参数

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

返回值

Promise<string>#

isChecked

Added before v1.9

elementHandle.isChecked

不推荐使用

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

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

用法

await elementHandle.isChecked();

返回值

Promise<boolean>#

isDisabled

Added before v1.9

elementHandle.isDisabled

不推荐使用

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

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

用法

await elementHandle.isDisabled();

返回值

Promise<boolean>#

isEditable

Added before v1.9

elementHandle.isEditable

不推荐使用

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

返回元素是否处于可编辑状态。

用法

await elementHandle.isEditable();

返回值

Promise<boolean>#

isEnabled

Added before v1.9

elementHandle.isEnabled

不推荐使用

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

返回元素是否处于启用状态。

用法

await elementHandle.isEnabled();

返回值

Promise<boolean>#

isHidden

Added before v1.9

elementHandle.isHidden

不推荐使用

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

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

用法

await elementHandle.isHidden();

返回值

Promise<boolean>#

isVisible

Added before v1.9

elementHandle.isVisible

不推荐使用

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

返回元素是否可见。

用法

await elementHandle.isVisible();

返回值

Promise<boolean>#

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

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

Promise<void>#

screenshot

v1.9 之前添加

elementHandle.screenshot

不推荐

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

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

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

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

用法

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

参数

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。

Promise<Buffer>#

scrollIntoViewIfNeeded

v1.9 版本前添加

elementHandle.scrollIntoViewIfNeeded

不推荐使用

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

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

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

查看滚动了解其他滚动方式。

用法

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

参数

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

返回值

Promise<void>#

selectOption

v1.9 之前版本添加

elementHandle.selectOption

不推荐使用

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

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

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

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

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

用法

// 匹配值或标签的单选
handle.selectOption('blue');

// 匹配标签的单选
handle.selectOption({ label: 'Blue' });

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

返回值

Promise<Array<string>>#

selectText

v1.9 版本前添加

elementHandle.selectText

不推荐使用

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

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

如果元素位于 <label> 标签内且该标签关联了控件，则会聚焦并选中控件中的文本。

用法

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

参数

options Object (可选)
- force boolean (可选) v1.13 版本新增#
  
  是否绕过可操作性检查。默认为 false。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时限制。默认值可通过配置文件中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 和 page.setDefaultTimeout() 方法设置。

返回值

Promise<void>#

setChecked

添加于: v1.15

elementHandle.setChecked

不推荐

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

该方法通过以下步骤勾选或取消勾选元素：

确保元素是复选框或单选按钮。如果不是，该方法会抛出异常。
如果元素已经处于目标勾选状态，该方法立即返回。
除非设置了 force 选项，否则等待匹配元素通过可操作性检查。如果在检查过程中元素被分离，整个操作会重试。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素的中心点。
确保元素现在已被勾选或取消勾选。如果没有，该方法会抛出异常。

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

用法

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

参数

checked boolean #

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

Promise<void>#

setInputFiles

v1.9 版本前添加

elementHandle.setInputFiles

不推荐使用

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

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

此方法期望 ElementHandle 指向一个 input 元素。但如果该元素位于具有关联控件的 <label> 元素内，则会定位到该控件。

用法

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

参数

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

返回值

Promise<void>#

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 Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前按下的修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效
  
  此选项无效
- position Object (可选)#
  - x number
  - y number
  相对于元素内边距框左上角的点。如果未指定，则使用元素的某个可见点
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法
- trial boolean (可选) v1.11 版本添加#
  
  设置时，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好执行操作而不实际执行它

Promise<void>#

textContent

v1.9 版本前添加

elementHandle.textContent

不推荐使用

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

返回节点的 node.textContent 值。

用法

await elementHandle.textContent();

返回值

Promise<null | string>#

type

v1.9 版本前添加

elementHandle.type

已弃用

在大多数情况下，你应该使用 locator.fill() 替代。只有当页面有特殊键盘处理逻辑时才需要逐个按键——此时请使用 locator.pressSequentially()。

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

如需按下特殊键（如 Control 或 ArrowDown），请使用 elementHandle.press()。

用法

参数

text string #

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

返回值

Promise<void>#

uncheck

v1.9 版本前添加

elementHandle.uncheck

不推荐使用

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

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

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

如果在操作过程中元素从 DOM 中分离，该方法会抛出异常。

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

用法

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

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- position Object (可选) v1.11 版本添加#
  - x number
  - y number
  相对于元素内边距框左上角的点击位置。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项修改，或使用 browserContext.setDefaultTimeout() 和 page.setDefaultTimeout() 方法设置。
- trial boolean (可选) v1.11 版本添加#
  
  当设置时，该方法仅执行可操作性检查并跳过实际操作。默认为 false。适用于等待元素准备好执行操作而不实际执行的情况。

返回值

Promise<void>#

waitForSelector

v1.9 之前添加

elementHandle.waitForSelector

不推荐使用

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

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

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

用法

await page.setContent(`<div><span></span></div>`);
const div = await page.$('div');
// 等待相对于 div 的 'span' 选择器
const span = await div.waitForSelector('span', { state: 'attached' });

备注

此方法不适用于跨页面导航，请改用 page.waitForSelector()。

参数

selector string #

要查询的选择器。
options Object (可选)
- state "attached" | "detached" | "visible" | "hidden" (可选)#
  
  默认为 'visible'。可选值：
  - 'attached' - 等待元素存在于 DOM 中。
  - 'detached' - 等待元素不存在于 DOM 中。
  - 'visible' - 等待元素具有非空边界框且没有 visibility:hidden。注意：没有内容或 display:none 的元素具有空边界框，不被视为可见。
  - 'hidden' - 等待元素从 DOM 中分离，或具有空边界框或 visibility:hidden。这是 'visible' 的反向选项。
- strict boolean (可选) v1.15 新增#
  
  为 true 时，要求选择器必须解析为单个元素。如果选择器解析到多个元素，调用将抛出异常。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法修改。

Promise<null | ElementHandle>#

方法​

boundingBox​

contentFrame​

ownerFrame​

waitForElementState​

已弃用​

$​

$$​

$eval​

$$eval​

check​

click​

dblclick​

dispatchEvent​

fill​

focus​

getAttribute​

hover​

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

dblclick

dispatchEvent

fill

focus

getAttribute

hover

innerHTML

innerText

inputValue

isChecked

isDisabled

isEditable

isEnabled

isHidden

isVisible

press

screenshot

scrollIntoViewIfNeeded

selectOption

selectText

setChecked

setInputFiles

tap

textContent

type

uncheck

waitForSelector