Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
hover([options])
Warning
Use
locator.hover([options])
instead.
Hovers over the element.
Parameter | Type | Default | Description |
---|---|---|---|
options | object | null | |
options.force | boolean | false | Setting this to true will bypass the actionability checks (visible , stable , enabled ). |
options.modifiers | string[] | null | Alt , Control , Meta or Shift modifiers keys pressed during the action. If not specified, currently pressed modifiers are used. |
options.noWaitAfter | boolean | false | If set to true and a navigation occurs from performing this action, it will not wait for it to complete. |
options.position | object | null | A point to use relative to the top left corner of the element. If not supplied, a visible point of the element is used. |
options.position.x | number | 0 | The x coordinate. |
options.position.y | number | 0 | The y coordinate. |
options.timeout | number | 30000 | Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on
BrowserContext or
Page. |
options.trial | boolean | false | Setting this to true will perform the actionability checks without performing the action. |
Returns
Type | Description |
---|---|
Promise<void> | A Promise that fulfills when the hover action is finished. |
Example
import { browser } from 'k6/browser';
export const options = {
scenarios: {
browser: {
executor: 'shared-iterations',
options: {
browser: {
type: 'chromium',
},
},
},
},
};
export default async function () {
const page = await browser.newPage();
await page.goto('https://test.k6.io/browser.php');
const offScreenElement = await page.$('#off-screen');
await offScreenElement.hover();
await page.close();
}