click

Click on elements with precise control over mouse buttons, click counts, and modifiers

Method Signature

await opensteer.click(options: ClickOptions): Promise<ActionResult>

Clicks on an element in the browser. Supports left, right, middle clicks, double-clicks, and modifier keys.

Parameters

options · ClickOptions · required

Configuration for the click action

Show ClickOptions properties

description · string

Natural language description of the element to click. 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.

button · 'left' | 'right' | 'middle' · default: "'left'"

Which mouse button to use for the click.

clickCount · number · default: "1"

Number of times to click (e.g., 2 for double-click).

modifiers · Array<'Alt' | 'Control' | 'Meta' | 'Shift'>

Modifier keys to hold during the click.

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 (“click”)

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 Click

// Click using AI-powered element detection
await opensteer.click({
  description: 'Submit button'
})

Click with Selector

// Click using CSS selector
await opensteer.click({
  selector: '#submit-btn',
  description: 'Submit button'
})

Right Click

// Right-click to open context menu
await opensteer.click({
  description: 'File item',
  button: 'right'
})

Double Click

// Double-click to select word
await opensteer.click({
  description: 'Text editor',
  clickCount: 2
})

Click with Modifiers

// Ctrl+Click for multi-select
await opensteer.click({
  description: 'List item 3',
  modifiers: ['Control']
})

// Shift+Click to select range
await opensteer.click({
  description: 'Last item',
  modifiers: ['Shift']
})

Click with Element Counter

// Use element counter from snapshot
await opensteer.click({
  element: 42,
  description: 'Login button'
})

Related methods

• hover - Hover over elements without clicking
• input - Fill text into input fields
• select - Select dropdown options