Options
All
  • Public
  • Public/Protected
  • All
Menu

Module utils/composable/useScroll

Index

Functions

Functions

  • useScroll(element: any, options?: {}): { arrivedState: { bottom: boolean; left: boolean; right: boolean; top: boolean }; directions: { bottom: boolean; left: boolean; right: boolean; top: boolean }; isScrolling: <internal>.Ref<boolean>; x: <internal>.Ref<number>; y: <internal>.Ref<number> }
  • Reactive scroll.

    see

    https://vueuse.org/useScroll

    version

    v9.2.0

    Parameters

    • element: any
    • options: {} = {}

      Returns { arrivedState: { bottom: boolean; left: boolean; right: boolean; top: boolean }; directions: { bottom: boolean; left: boolean; right: boolean; top: boolean }; isScrolling: <internal>.Ref<boolean>; x: <internal>.Ref<number>; y: <internal>.Ref<number> }

      • arrivedState: { bottom: boolean; left: boolean; right: boolean; top: boolean }
        • bottom: boolean
        • left: boolean
        • right: boolean
        • top: boolean
      • directions: { bottom: boolean; left: boolean; right: boolean; top: boolean }
        • bottom: boolean
        • left: boolean
        • right: boolean
        • top: boolean
      • isScrolling: <internal>.Ref<boolean>
      • x: <internal>.Ref<number>
      • y: <internal>.Ref<number>

    Generated using TypeDoc