Function scrollTo

Scrolls the given scrollable element to the given to target.

Returns null if there's an ongoing scroll that is not cancellable.

Note that if to is an element or a query selector string, then it must be a descendant of the scrollable element.

Throws

LisnUsageError If the target coordinates are invalid.

scrollTo(
to: string | Element | TargetCoordinates,
userOptions?: ScrollToOptions,
): null | ScrollAction
Parameters
- to: string | Element | TargetCoordinates
  If this is an element, then its top-left position is used as the target coordinates. If it is a string, then it is treated as a selector for an element using querySelector.
- OptionaluserOptions: ScrollToOptions
Returns null | ScrollAction
null if there's an ongoing scroll that is not cancellable, otherwise a ScrollAction.
- Defined in packages/lisn.js/src/ts/utils/scroll.ts:285