ElementHandle

extends: JSHandle

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

不推荐

不推荐使用 ElementHandle，请改用 Locator 对象和 Web 优先断言。

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

ElementHandle 会阻止 DOM 元素被垃圾回收，除非通过 jsHandle.dispose() 释放句柄。当其源 frame 被导航时，ElementHandle 会自动释放。

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

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

在下面的示例中，句柄指向页面上的特定 DOM 元素。如果该元素更改了文本或被 React 用于渲染完全不同的组件，该句柄仍然指向该 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。边界框是相对于主 frame 视口计算的 - 这通常与浏览器窗口相同。

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

子 frame 中的元素返回相对于主 frame 的边界框，这与 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

添加于 v1.9 之前

elementHandle.contentFrame

返回引用 iframe 节点的 element handle 的内容 frame，否则返回 null。

用法

await elementHandle.contentFrame();

返回值

Promise<null | Frame>#

ownerFrame

添加于 v1.9 之前

elementHandle.ownerFrame

返回包含给定元素的 frame。

用法

await elementHandle.ownerFrame();

返回值

Promise<null | Frame>#

waitForElementState

添加于 v1.9 之前

elementHandle.waitForElementState

当元素满足指定的 state 时返回。

根据 state 参数，此方法会等待其中一个可操作性检查通过。如果元素在等待时被 detached，此方法将抛出错误，除非等待的是 "hidden" 状态。

"visible" 等待元素变为可见。
"hidden" 等待元素变为不可见或未 attached。请注意，等待 hidden 状态时，如果元素 detached，不会抛出错误。
"stable" 等待元素变为可见且稳定。
"enabled" 等待元素变为可用。
"disabled" 等待元素变为不可用。
"editable" 等待元素变为可编辑。

如果元素在指定的 timeout 毫秒内不满足条件，此方法将抛出错误。

用法

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.$

不推荐

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

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

用法

await elementHandle.$(selector);

参数

selector string #

要查询的选择器。

返回值

Promise<null | ElementHandle>#

$$

添加于: v1.9

elementHandle.$$

不推荐

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

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

用法

await elementHandle.$$(selector);

参数

selector string #

要查询的选择器。

返回值

Promise<Array<ElementHandle>>#

$eval

添加于: v1.9

elementHandle.$eval

不推荐

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

返回 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 辅助方法和 Web 优先断言能更好地完成任务。

返回 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 的 locator.check()。了解更多关于 locators 的信息。

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

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

如果在操作期间元素从 DOM 中 detached，此方法将抛出错误。

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

用法

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

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已废弃
  此选项无效。
  
  此选项无效。
- position Object (可选)添加于: v1.11#
  - x number
  - y number
  相对于元素 padding box 左上角使用的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0，表示没有超时。可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来更改默认值。
- trial boolean (可选)添加于: v1.11#
  
  设置后，此方法只执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备好进行操作但又不实际执行操作非常有用。

返回值

Promise<void>#

click

添加于 v1.9 之前

elementHandle.click

不推荐

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

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

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

如果在操作期间元素从 DOM 中 detached，此方法将抛出错误。

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

用法

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
  相对于元素 padding box 左上角使用的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0，表示没有超时。可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来更改默认值。
- trial boolean (可选)添加于: v1.11#
  
  设置后，此方法只执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备好进行操作但又不实际执行操作非常有用。

返回值

Promise<void>#

dblclick

添加于 v1.9 之前

elementHandle.dblclick

不推荐

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

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

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

如果在操作期间元素从 DOM 中 detached，此方法将抛出错误。

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

注意

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
  相对于元素 padding box 左上角使用的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0，表示没有超时。可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来更改默认值。
- trial boolean (可选)添加于: v1.11#
  
  设置后，此方法只执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备好进行操作但又不实际执行操作非常有用。

返回值

Promise<void>#

dispatchEvent

添加于 v1.9 之前

elementHandle.dispatchEvent

不推荐

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

以下代码片段在元素上派发 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>#

fill

添加于 v1.9 之前

elementHandle.fill

不推荐

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

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

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

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

用法

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

参数

value 字符串 #

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

返回值

Promise<void>#

focus

添加于 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 | 字符串>#

hover

添加于 v1.9 之前

elementHandle.hover

不推荐

改用基于定位器的 locator.hover() 方法。阅读关于定位器的更多信息。

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

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

如果在操作期间元素从 DOM 中 detached，此方法将抛出错误。

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

用法

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

参数

options Object (可选)
- force 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- modifiers 数组<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (可选)#
  
  要按下的修饰键。确保在操作期间只按下这些修饰键，然后恢复当前的修饰键状态。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- noWaitAfter 布尔值 (可选)添加于: v1.28#
  
  已废弃
  此选项无效。
  
  此选项无效。
- position 对象 (可选)#
  - x number
  - y number
  相对于元素 padding box 左上角使用的点。如果未指定，则使用元素的某个可见点。
- timeout 数字 (可选)#
  
  最大等待时间（毫秒）。默认为 0，表示没有超时。可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来更改默认值。
- trial boolean (可选)添加于: 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。

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

用法

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

参数

options Object (可选)
- 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() 方法。阅读关于定位器的更多信息。

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

用法

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() 方法。阅读关于定位器的更多信息。

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

用法

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 Object (可选)
- delay 数字 (可选)#
  
  keydown 和 keyup 事件之间等待的时间，单位为毫秒。默认为 0。
- noWaitAfter 布尔值 (可选)#
  
  已废弃
  此选项将来会默认为 true。
  
  发起导航的操作会等待这些导航发生并等待页面开始加载。你可以通过设置此标志来选择不等待。只有在导航到不可访问的页面等特殊情况下，才需要此选项。默认为 false。
- timeout 数字 (可选)#
  
  最大等待时间（毫秒）。默认为 0，表示没有超时。可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来更改默认值。

返回值

Promise<void>#

screenshot

添加于 v1.9 之前

elementHandle.screenshot

不推荐

改用基于定位器的 locator.screenshot() 方法。阅读关于定位器的更多信息。

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

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

返回包含捕获截图的 Buffer。

用法

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 数组<Locator> (可选)#
  
  指定在截图时应该被遮罩（masked）的定位器。被遮罩的元素将覆盖一层粉色框 #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 Object (可选)
- 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 Object (可选)
- 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 Object (可选)
- force 布尔值 (可选)添加于: v1.13#
  
  是否绕过可操作性检查。默认为 false。
- timeout 数字 (可选)#
  
  最大等待时间（毫秒）。默认为 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 布尔值 #

是否选中或取消选中复选框。
options Object (可选)
- force 布尔值 (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter 布尔值 (可选)#
  
  已废弃
  此选项无效。
  
  此选项无效。
- position Object (可选)#
  - x number
  - y number
  相对于元素 padding box 左上角使用的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0，表示没有超时。可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来更改默认值。
- trial boolean (可选)#
  
  设置后，此方法只执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备好进行操作但又不实际执行操作非常有用。

返回值

Promise<void>#

setInputFiles

添加于 v1.9 之前

elementHandle.setInputFiles

不推荐

请改用基于 locator 的 locator.setInputFiles()。阅读关于 locators 的更多信息。

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

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

用法

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 的 locator.tap()。阅读关于 locators 的更多信息。

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

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

如果在操作期间元素从 DOM 中 detached，此方法将抛出错误。

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

注意

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
  相对于元素 padding box 左上角使用的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0，表示没有超时。可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来更改默认值。
- trial boolean (可选)添加于: v1.11#
  
  设置后，此方法只执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备好进行操作但又不实际执行操作非常有用。

返回值

Promise<void>#

textContent

添加于 v1.9 之前

elementHandle.textContent

不推荐

请改用基于 locator 的 locator.textContent()。阅读关于 locators 的更多信息。

返回 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 的 locator.uncheck()。阅读关于 locators 的更多信息。

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

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

如果在操作期间元素从 DOM 中 detached，此方法将抛出错误。

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

用法

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

参数

options Object (可选)
- force boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- noWaitAfter boolean (可选)#
  
  已废弃
  此选项无效。
  
  此选项无效。
- position Object (可选)添加于: v1.11#
  - x number
  - y number
  相对于元素 padding box 左上角使用的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间（毫秒）。默认为 0，表示没有超时。可以通过配置中的 actionTimeout 选项，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法来更改默认值。
- trial boolean (可选)添加于: v1.11#
  
  设置后，此方法只执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备好进行操作但又不实际执行操作非常有用。

返回值

Promise<void>#

waitForSelector

添加于 v1.9 之前

elementHandle.waitForSelector

不推荐

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

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

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

用法

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 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 时，要求 selector 必须解析为单个元素。如果给定的 selector 解析出多个元素，则调用将抛出异常。
- 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