ElementHandle

继承自: JSHandle

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

不推荐使用

不推荐使用元素句柄，请改用 Locator 对象和 web-first 断言。

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

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

元素句柄实例可以用作 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

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

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

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

假设页面是静态的，则可以安全地使用 bounding box 坐标来执行输入。例如，以下代码片段应单击元素的中心。

用法

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 节点的元素句柄的内容框架，否则返回 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 参数，此方法等待其中一项可操作性检查通过。当元素在等待时分离时，此方法会抛出错误，除非等待 "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 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-first 断言。

返回 pageFunction 的返回值。

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

如果 pageFunction 返回一个 Promise，则 elementHandle.$eval() 将等待 promise resolve 并返回其值。

用法

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-first 断言效果更好。

返回 pageFunction 的返回值。

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

如果 pageFunction 返回一个 Promise，则 elementHandle.$$eval() 将等待 promise resolve 并返回其值。

用法

<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 中分离，则此方法将抛出错误。

当所有步骤在指定的 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 的 locator.click()。阅读更多关于 locators 的信息。

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

等待元素的可操作性检查通过，除非设置了 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 中添加#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，但不执行操作。

返回值

Promise<void>#

dblclick

在 v1.9 之前添加

elementHandle.dblclick

不推荐使用

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

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

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

如果元素在操作期间的任何时刻从 DOM 中分离，则此方法将抛出错误。

当所有步骤在指定的 timeout 内未完成时，此方法将抛出 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 的 locator.dispatchEvent()。阅读更多关于 locators 的信息。

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

用法

await elementHandle.dispatchEvent('click');

在幕后，它基于给定的 type 创建一个事件实例，使用 eventInit 属性初始化它，并在元素上派发它。默认情况下，事件是 composed、cancelable 和 bubble。

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

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

// Note you can only create DataTransfer in Chromium and 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 的 locator.fill()。阅读更多关于 locators 的信息。

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

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

要发送细粒度的键盘事件，请使用 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

在 v1.9 之前添加

elementHandle.focus

不推荐使用

请使用基于 locator 的 locator.focus() 代替。阅读更多关于 locator 的信息。

调用元素上的 focus。

用法

await elementHandle.focus();

返回值

Promise<void>#

getAttribute

在 v1.9 之前添加

elementHandle.getAttribute

不推荐使用

请使用基于 locator 的 locator.getAttribute() 代替。阅读更多关于 locator 的信息。

返回元素属性值。

用法

await elementHandle.getAttribute(name);

参数

name string #

要获取值的属性名称。

返回值

Promise<null | string>#

hover

在 v1.9 之前添加

elementHandle.hover

不推荐使用

请使用基于 locator 的 locator.hover() 代替。阅读更多关于 locator 的信息。

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

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

如果元素在操作期间的任何时刻从 DOM 中分离，则此方法将抛出错误。

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

用法

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
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- timeout number (可选)#
  
  最大等待时间，以毫秒为单位。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。
- trial boolean (可选)在 v1.11 中添加#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，但不执行操作。

返回值

Promise<void>#

innerHTML

在 v1.9 之前添加

elementHandle.innerHTML

不推荐使用

请使用基于 locator 的 locator.innerHTML() 代替。阅读更多关于 locator 的信息。

返回 element.innerHTML。

用法

await elementHandle.innerHTML();

返回值

Promise<string>#

innerText

在 v1.9 之前添加

elementHandle.innerText

不推荐使用

请使用基于 locator 的 locator.innerText() 代替。阅读更多关于 locator 的信息。

返回 element.innerText。

用法

await elementHandle.innerText();

返回值

Promise<string>#

inputValue

添加于: v1.13

elementHandle.inputValue

不推荐使用

请使用基于 locator 的 locator.inputValue() 代替。阅读更多关于 locator 的信息。

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

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

用法

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

参数

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

返回值

Promise<string>#

isChecked

在 v1.9 之前添加

elementHandle.isChecked

不推荐使用

请使用基于 locator 的 locator.isChecked() 代替。阅读更多关于 locator 的信息。

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

用法

await elementHandle.isChecked();

返回值

Promise<boolean>#

isDisabled

在 v1.9 之前添加

elementHandle.isDisabled

不推荐使用

请使用基于 locator 的 locator.isDisabled() 代替。阅读更多关于 locator 的信息。

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

用法

await elementHandle.isDisabled();

返回值

Promise<boolean>#

isEditable

在 v1.9 之前添加

elementHandle.isEditable

不推荐使用

请使用基于 locator 的 locator.isEditable() 代替。阅读更多关于 locator 的信息。

返回元素是否可编辑。

用法

await elementHandle.isEditable();

返回值

Promise<boolean>#

isEnabled

在 v1.9 之前添加

elementHandle.isEnabled

不推荐使用

请使用基于 locator 的 locator.isEnabled() 代替。阅读更多关于 locator 的信息。

返回元素是否启用。

用法

await elementHandle.isEnabled();

返回值

Promise<boolean>#

isHidden

在 v1.9 之前添加

elementHandle.isHidden

不推荐使用

请使用基于 locator 的 locator.isHidden() 代替。阅读更多关于 locator 的信息。

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

用法

await elementHandle.isHidden();

返回值

Promise<boolean>#

isVisible

在 v1.9 之前添加

elementHandle.isVisible

不推荐使用

请使用基于 locator 的 locator.isVisible() 代替。阅读更多关于 locator 的信息。

返回元素是否可见。

用法

await elementHandle.isVisible();

返回值

Promise<boolean>#

press

在 v1.9 之前添加

elementHandle.press

不推荐使用

请使用基于 locator 的 locator.press() 代替。阅读更多关于 locator 的信息。

聚焦元素，然后使用 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 的 locator.screenshot() 代替。阅读更多关于 locator 的信息。

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

此方法等待可操作性检查，然后在截取屏幕截图之前将元素滚动到视图中。如果元素从 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 Array<Locator> (可选)#
  
  指定在截取屏幕截图时应被遮罩的 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 的 locator.scrollIntoViewIfNeeded() 代替。阅读更多关于 locator 的信息。

此方法等待可操作性检查，然后尝试将元素滚动到视图中，除非它完全可见，如 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 的 locator.selectOption() 代替。阅读更多关于 locator 的信息。

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

如果目标元素不是 <select> 元素，则此方法会抛出错误。但是，如果元素位于具有关联 control 的 <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 | 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 的 locator.selectText() 代替。阅读更多关于 locator 的信息。

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

如果元素位于具有关联 control 的 <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 的 locator.setChecked() 代替。阅读更多关于 locator 的信息。

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

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

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

用法

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

设置文件输入的值为这些文件路径或文件。如果某些 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.tap()。阅读更多关于定位器的信息。

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

等待元素的可操作性检查 actionability，除非设置了 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()。阅读更多关于定位器的信息。

此方法通过执行以下步骤来检查元素

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

如果元素在操作期间的任何时刻从 DOM 中分离，则此方法将抛出错误。

当所有步骤在指定的 timeout 期间未完成时，此方法将抛出 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');
// 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 时，调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将抛出异常。
- 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