Scrolls the page to the given element.
The alignment parameters can be overridden, see below.
A reference of the possible values for the alignment parameters is available at https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
Examples
await scrollTo('Get Started')
await scrollTo(link('Get Started'))
await scrollTo('Get Started', { blockAlignment: 'center', inlineAlignment: 'center' })
Parameters
| Name |
Type |
Description |
selector |
selector | string |
A selector of an element to scroll to. |
options |
Object |
Default: {}. |
options.waitForNavigation |
boolean |
Wait for navigation after the goto. Default navigationTimeout is 30 seconds to override pass { navigationTimeout: 10000 } in options parameter. Default: true. |
options.waitForEvents |
Array |
Events available to wait for [‘DOMContentLoaded’, ‘loadEventFired’, ‘networkAlmostIdle’, ‘networkIdle’, ‘firstPaint’, ‘firstContentfulPaint’, ‘firstMeaningfulPaint’, ‘targetNavigated’] Default: []. |
options.navigationTimeout |
number |
Navigation timeout value in milliseconds for navigation after click. Default: 30000. |
options.waitForStart |
number |
Time to wait for navigation to start. Accepts value in milliseconds. Default: 100. |
options.blockAlignment |
string |
Defines vertical alignment. One of start, center, end or nearest. Default: 'nearest'. |
options.inlineAlignment |
string |
Defines horizontal alignment. One of start, center, end or nearest. Default: 'nearest'. |
Returns