Options
All
  • Public
  • Public/Protected
  • All
Menu

@lemehovskiy/scroller-utils

Index

Functions

Functions

getAdjustedTriggerOffset

  • getAdjustedTriggerOffset(elementOffset: { bottom: number; top: number }, windowHeight: number, documentHeight: number): { endOffset: number; startOffset: number }
  • remarks

    This method adjusts offset triggers in cases when element offset triggers can't reach the start or end position

    Parameters

    • elementOffset: { bottom: number; top: number }
      • bottom: number
      • top: number
    • windowHeight: number
    • documentHeight: number

    Returns { endOffset: number; startOffset: number }

    • endOffset: number
    • startOffset: number

getBodyHeight

  • getBodyHeight(): number

getConvertedTriggerToPx

  • getConvertedTriggerToPx(value: string, height: number): number

getConvertedTriggersToPx

  • getConvertedTriggersToPx(triggers: TriggerType[], height: number): number[]

getProgress

  • getProgress(scrollTop: number, windowHeight: number, scrollTriggerOffsetPxStart: number, elementOffsetTop: number, scrollLength: number): number
  • remarks

    This method returns the current progress value

    Parameters

    • scrollTop: number
    • windowHeight: number
    • scrollTriggerOffsetPxStart: number
    • elementOffsetTop: number
    • scrollLength: number

    Returns number

getProgressLength

  • getProgressLength(elementHeight: number, windowHeight: number, scrollTriggerStartOffset: number, scrollTriggerEndOffset: number): number
  • remarks

    This method returns the progress length in pixels

    Parameters

    • elementHeight: number
    • windowHeight: number
    • scrollTriggerStartOffset: number
    • scrollTriggerEndOffset: number

    Returns number

getResizeValues

  • getResizeValues(scrollTop: number, windowHeight: number, bodyHeight: number, elementViewportOffsetTop: number, elementHeight: number, scrollTriggerOffset: { end: string | number; start: string | number }, autoAdjustScrollOffset: boolean): { elementTriggerOffsetBottom: number; elementTriggerOffsetTop: number; progressLength: number; scrollTriggerOffsetEnd: number; scrollTriggerOffsetStart: number }
  • remarks

    This method returns new values after resizing the window

    Parameters

    • scrollTop: number
    • windowHeight: number
    • bodyHeight: number
    • elementViewportOffsetTop: number
    • elementHeight: number
    • scrollTriggerOffset: { end: string | number; start: string | number }
      • end: string | number
      • start: string | number
    • autoAdjustScrollOffset: boolean

    Returns { elementTriggerOffsetBottom: number; elementTriggerOffsetTop: number; progressLength: number; scrollTriggerOffsetEnd: number; scrollTriggerOffsetStart: number }

    • elementTriggerOffsetBottom: number
    • elementTriggerOffsetTop: number
    • progressLength: number
    • scrollTriggerOffsetEnd: number
    • scrollTriggerOffsetStart: number

getScrollTop

  • getScrollTop(): number

getTriggers

  • getTriggers(scrollTriggerOffsetRaw: { end: string | number; start: string | number }, scrollTop: number, elementViewportOffsetTop: number, elementHeight: number, windowHeight: number, bodyHeight: number, autoAdjustScrollOffset: boolean): { elementTriggerOffsetBottom: number; elementTriggerOffsetTop: number; scrollTriggerOffsetEnd: number; scrollTriggerOffsetStart: number }
  • remarks

    This method returns element and scroll triggers offset

    Parameters

    • scrollTriggerOffsetRaw: { end: string | number; start: string | number }
      • end: string | number
      • start: string | number
    • scrollTop: number
    • elementViewportOffsetTop: number
    • elementHeight: number
    • windowHeight: number
    • bodyHeight: number
    • autoAdjustScrollOffset: boolean

    Returns { elementTriggerOffsetBottom: number; elementTriggerOffsetTop: number; scrollTriggerOffsetEnd: number; scrollTriggerOffsetStart: number }

    • elementTriggerOffsetBottom: number
    • elementTriggerOffsetTop: number
    • scrollTriggerOffsetEnd: number
    • scrollTriggerOffsetStart: number

getWindowHeight

  • getWindowHeight(): number

Generated using TypeDoc