hover

Hover over elements to trigger hover states, tooltips, and dropdown menus

Method Signature

await opensteer.hover(options: HoverOptions): Promise<ActionResult>

Moves the mouse cursor over an element without clicking. Useful for triggering hover effects, tooltips, and dropdown menus.

Parameters

options · HoverOptions · required

Configuration for the hover action

Show HoverOptions properties

description · string

Natural language description of the element to hover over. Used for AI-powered element resolution when element or selector are not provided.

element · number

Counter number from snapshot HTML to identify the exact element.

selector · string

CSS selector to identify the element.

force · boolean · default: "false"

Whether to bypass actionability checks and force the hover action.

position · { x: number, y: number }

A specific point within the element to hover over, relative to the top-left corner.

wait · false | ActionWaitOptions

Post-action wait configuration. Set to false to disable waiting, or provide options to customize wait behavior.

Returns

ActionResult · Promise<ActionResult>

Show ActionResult properties

method · string

The action method name (“hover”)

namespace · string

The namespace identifier for this session

persisted · boolean

Whether the element path was successfully persisted for future use

pathFile · string | null

Path to the file where element path is stored

selectorUsed · string | null

The actual selector used to find the element

Examples

Basic Hover

// Hover to reveal dropdown menu
await opensteer.hover({
  description: 'Settings menu'
})

Hover with Selector

// Hover using CSS selector
await opensteer.hover({
  selector: '.profile-avatar',
  description: 'User avatar'
})

Show Tooltip

// Hover to display tooltip
await opensteer.hover({
  description: 'Help icon'
})

// Extract tooltip text
const tooltip = await opensteer.getElementText({
  description: 'Tooltip'
})

Navigate Nested Menus

// Hover over parent menu
await opensteer.hover({
  description: 'File menu'
})

// Hover over submenu
await opensteer.hover({
  description: 'Export submenu'
})

// Click final option
await opensteer.click({
  description: 'Export as PDF'
})

Hover at Specific Position

// Hover at a specific point within the element
await opensteer.hover({
  description: 'Image preview',
  position: { x: 100, y: 50 }
})

Force Hover

// Force hover even if element is not immediately actionable
await opensteer.hover({
  description: 'Hidden menu trigger',
  force: true
})

Hover with Element Counter

// Use element counter from snapshot
await opensteer.hover({
  element: 23,
  description: 'Navigation item'
})

Related methods

• click - Click on elements
• scroll - Scroll elements into view before hovering
• input - Fill text into inputs