For AI agents: a documentation index is available at /llms.txt
Skip to main content

ScrollOptions

Properties

PropertyTypeDescription
selector?stringThe DOM selector of the element on the page you want to scroll to
throughPage?booleanScrolls through the entire document in viewport-sized steps to trigger lazy-loaded content, then returns to the top. Cannot be combined with selector, x, or y. Default false
timeout?numberHow long to wait for the element to appear before timing out, overriding any defaults. Default timeout is 30 seconds, or 30000.
visible?booleanWhether or not to scroll to the element only if it's visible Default false
wait?booleanWhether or not to wait for the element, then scroll to it Default true
x?numberThe X coordinate, in pixels, to scroll to
y?numberThe Y coordinate, in pixels, to scroll to