Options
All
  • Public
  • Public/Protected
  • All
Menu

Module utils/composable/usePointerSwipe

Index

Functions

  • usePointerSwipe(target: any, options?: {}): { direction: { [_refBrand]: true; value: SwipeDirection }; distanceX: <internal>.ComputedRef<number>; distanceY: <internal>.ComputedRef<number>; isSwiping: { [_refBrand]: true; value: boolean }; posEnd: { x: number; y: number }; posStart: { x: number; y: number }; stop: (() => void) }
  • Reactive swipe detection based on PointerEvents.

    see

    https://vueuse.org/usePointerSwipe

    version

    v7.3.0

    Parameters

    • target: any
    • options: {} = {}

      Returns { direction: { [_refBrand]: true; value: SwipeDirection }; distanceX: <internal>.ComputedRef<number>; distanceY: <internal>.ComputedRef<number>; isSwiping: { [_refBrand]: true; value: boolean }; posEnd: { x: number; y: number }; posStart: { x: number; y: number }; stop: (() => void) }

      • direction: { [_refBrand]: true; value: SwipeDirection }
        • Readonly [_refBrand]: true
        • Readonly value: SwipeDirection
      • distanceX: <internal>.ComputedRef<number>
      • distanceY: <internal>.ComputedRef<number>
      • isSwiping: { [_refBrand]: true; value: boolean }
        • Readonly [_refBrand]: true
        • Readonly value: boolean
      • posEnd: { x: number; y: number }
        • x: number
        • y: number
      • posStart: { x: number; y: number }
        • x: number
        • y: number
      • stop: (() => void)
          • (): void
          • Returns void

    Generated using TypeDoc