Documentation Index
Fetch the complete documentation index at: https://mintlify.com/steerlabs/opensteer/llms.txt
Use this file to discover all available pages before exploring further.
Method Signature
await opensteer.scroll(options?: ScrollOptions): Promise<ActionResult>
Parameters
Configuration for the scroll action. Optional - defaults to scrolling the page down by 600 pixels.Show ScrollOptions properties
direction
'up' | 'down' | 'left' | 'right'
default:"'down'"
Direction to scroll.
Number of pixels to scroll. Negative values are converted to absolute.
Natural language description of the element to scroll. If not provided, scrolls the entire page.
Counter number from snapshot HTML to identify the exact element to scroll.
CSS selector to identify the element to scroll.
wait
false | ActionWaitOptions
Post-action wait configuration. Set to false to disable waiting, or provide options to customize wait behavior.
Returns
Show ActionResult properties
The action method name (“scroll”)
The namespace identifier for this session
Whether the element path was successfully persisted for future use
Path to the file where element path is stored
The actual selector used to find the element
Examples
Scroll Page Down
// Scroll the page down by default amount (600px)
await opensteer.scroll()
// Or explicitly specify
await opensteer.scroll({
direction: 'down'
})
Scroll Page Up
// Scroll the page up
await opensteer.scroll({
direction: 'up'
})
// Scroll down by 1000 pixels
await opensteer.scroll({
direction: 'down',
amount: 1000
})
// Scroll right
await opensteer.scroll({
direction: 'right',
amount: 500
})
// Scroll left
await opensteer.scroll({
direction: 'left',
amount: 500
})
// Scroll a scrollable container
await opensteer.scroll({
description: 'Chat messages container',
direction: 'down',
amount: 300
})
// Scroll element using CSS selector
await opensteer.scroll({
selector: '.sidebar',
description: 'Sidebar',
direction: 'down'
})
Scroll to Load More Content
// Infinite scroll pattern
for (let i = 0; i < 5; i++) {
await opensteer.scroll({
direction: 'down',
amount: 1000
})
// Wait for content to load
await new Promise(resolve => setTimeout(resolve, 1000))
}
// Scroll sidebar to reveal element
await opensteer.scroll({
description: 'Navigation sidebar',
direction: 'down',
amount: 400
})
// Then interact with revealed element
await opensteer.click({
description: 'Settings link'
})
// Use element counter from snapshot
await opensteer.scroll({
element: 35,
description: 'Results container',
direction: 'down',
amount: 500
})
Important Notes
When no description, element, or selector is provided, the entire page is scrolled. This is useful for general page navigation.
The default scroll amount is 600 pixels, which typically moves the viewport by about one screen height on most displays.
- click - Click on elements (may auto-scroll to element)
- hover - Hover over elements
- snapshot - Capture page content after scrolling