Cookies concent notice

This site uses cookies from Google to deliver its services and to analyze traffic.
Learn more
Skip to main content
This site is no longer updated.Head to Angular.devHome
/

This is the archived documentation for Angular v17. Please visit angular.dev to see this page for the current version of Angular.

ViewportScroller

Defines a scroll position manager. Implemented by BrowserViewportScroller.

      
      abstract class ViewportScroller {
abstract setOffset(offset: [number, number] | (() => [number, number])): void
abstract getScrollPosition(): [...]
abstract scrollToPosition(position: [number, number]): void
abstract scrollToAnchor(anchor: string): void
abstract setHistoryScrollRestoration(scrollRestoration: "auto" | "manual"): void }

Provided in

  • 'root'

Methods

Configures the top offset used when scrolling to an anchor.

      
      abstract setOffset(offset: [number, number] | (() => [number, number])): void
    
Parameters
offset [number, number] | (() => [number, number])

A position in screen coordinates (a tuple with x and y values) or a function that returns the top offset position.

Returns

void

Retrieves the current scroll position.

      
      abstract getScrollPosition(): [
    number,
    number
]
    
Parameters

There are no parameters.

Returns

[ number, number ]: A position in screen coordinates (a tuple with x and y values).

Scrolls to a specified position.

      
      abstract scrollToPosition(position: [number, number]): void
    
Parameters
position [number, number]

A position in screen coordinates (a tuple with x and y values).

Returns

void

Scrolls to an anchor element.

      
      abstract scrollToAnchor(anchor: string): void
    
Parameters
anchor string

The ID of the anchor element.

Returns

void

Disables automatic scroll restoration provided by the browser. See also window.history.scrollRestoration info.

      
      abstract setHistoryScrollRestoration(scrollRestoration: "auto" | "manual"): void
    
Parameters
scrollRestoration "auto" | "manual"
Returns

void