Class ViewportScroller

Manages the scroll position.

Index

Constructors

Accessors

Methods

scrollToAnchor scrollToElement scrollToPosition scrollToTop

Constructors

constructor

new ViewportScroller(viewport?: () => Element): ViewportScroller
Creates a new viewport scroller.
Parameters
- viewport: () => Element = ...
  A function that returns the element used as viewport.
Returns ViewportScroller
- Defined in src/Web/Html/ViewportScroller.ts:31

Accessors

scrollOffset

get scrollOffset(): number
The top offset used when scrolling to an element.

Returns number
- Defined in src/Web/Html/ViewportScroller.ts:38

Methods

scrollToAnchor

scrollToAnchor(anchor: string, options?: Partial): void
Scrolls to the specified anchor.
Parameters
- anchor: string
  The identifier or name of an elment.
- options: Partial = {}
  Value indicating whether scrolling is instant or animates smoothly.
Returns void
- Defined in src/Web/Html/ViewportScroller.ts:56

scrollToElement

scrollToElement(element: Element, options?: Partial): void
Scrolls to the specified element.
Parameters
- element: Element
  The element to scroll to.
- options: Partial = {}
  Value indicating whether scrolling is instant or animates smoothly.
Returns void
- Defined in src/Web/Html/ViewportScroller.ts:66

scrollToPosition

scrollToPosition(x: number, y: number, options?: Partial): void
Scrolls to the specified position.
Parameters
- x: number
  The pixel along the horizontal axis.
- y: number
  The pixel along the vertical axis.
- options: Partial = {}
  Value indicating whether scrolling is instant or animates smoothly.
Returns void
- Defined in src/Web/Html/ViewportScroller.ts:78

scrollToTop

scrollToTop(options?: Partial): void
Scrolls to the top.
Parameters
- options: Partial = {}
  Value indicating whether scrolling is instant or animates smoothly.
Returns void
- Defined in src/Web/Html/ViewportScroller.ts:86