API reference for SfScrollService

import {SfCommonModule} from "@progress/sitefinity-component-framework";


description: Provides methods for scrolling of elements

Constructors

  • Parameters

    • window: any
    • zone: NgZone

    Returns SfScrollService

Properties

scrollCompleted: Subject<boolean> = ...

Emits when scrolling is completed

Methods

  • Calculates the offset The offset is used in order not to stick the field to the very top of the viewport

    Returns number

  • Scrolls to an element with or without animation and for a particular duration

    Parameters

    • element: any
    • shouldAnimate: boolean = false
    • durationMS: number = SCROLL_DURATION

    Returns void

  • Scrolls to a point

    Parameters

    • point: number
    • durationMS: number = SCROLL_DURATION

    Returns void

  • Scrolls to an element

    Parameters

    • shouldAnimate: boolean = true
    • durationMS: number = SCROLL_DURATION

    Returns void

  • Sets the window element

    Parameters

    • window: Window

    Returns void

Generated using TypeDoc