usePointerSwipe
Reactive swipe detection based on PointerEvents.
Demo
Swipe
Usage
<script setup>
import { ref } from 'vue'
import { usePointerSwipe } from '@vueuse/core'
const el = ref(null)
const { isSwiping, direction } = usePointerSwipe(el)
</script>
<template>
<div ref="el">
Swipe here
</div>
</template>
<script setup>
import { ref } from 'vue'
import { usePointerSwipe } from '@vueuse/core'
const el = ref(null)
const { isSwiping, direction } = usePointerSwipe(el)
</script>
<template>
<div ref="el">
Swipe here
</div>
</template>
Type Declarations
Show Type Declarations
export interface PointerSwipeOptions {
/**
* @default 50
*/
threshold?: number
/**
* Callback on swipe start
*/
onSwipeStart?: (e: PointerEvent) => void
/**
* Callback on swipe move
*/
onSwipe?: (e: PointerEvent) => void
/**
* Callback on swipe end
*/
onSwipeEnd?: (e: PointerEvent, direction: SwipeDirection) => void
/**
* Pointer types that listen to.
*
* @default ['mouse', 'touch', 'pen']
*/
pointerTypes?: PointerType[]
}
export interface PointerSwipeReturn {
readonly isSwiping: Ref<boolean>
direction: Readonly<Ref<SwipeDirection | null>>
readonly posStart: Position
readonly posEnd: Position
distanceX: Readonly<Ref<number>>
distanceY: Readonly<Ref<number>>
stop: () => void
}
/**
* Reactive swipe detection based on PointerEvents.
*
* @see https://vueuse.org/usePointerSwipe
* @param target
* @param options
*/
export declare function usePointerSwipe(
target: MaybeRef<HTMLElement | null | undefined>,
options?: PointerSwipeOptions
): PointerSwipeReturn
export interface PointerSwipeOptions {
/**
* @default 50
*/
threshold?: number
/**
* Callback on swipe start
*/
onSwipeStart?: (e: PointerEvent) => void
/**
* Callback on swipe move
*/
onSwipe?: (e: PointerEvent) => void
/**
* Callback on swipe end
*/
onSwipeEnd?: (e: PointerEvent, direction: SwipeDirection) => void
/**
* Pointer types that listen to.
*
* @default ['mouse', 'touch', 'pen']
*/
pointerTypes?: PointerType[]
}
export interface PointerSwipeReturn {
readonly isSwiping: Ref<boolean>
direction: Readonly<Ref<SwipeDirection | null>>
readonly posStart: Position
readonly posEnd: Position
distanceX: Readonly<Ref<number>>
distanceY: Readonly<Ref<number>>
stop: () => void
}
/**
* Reactive swipe detection based on PointerEvents.
*
* @see https://vueuse.org/usePointerSwipe
* @param target
* @param options
*/
export declare function usePointerSwipe(
target: MaybeRef<HTMLElement | null | undefined>,
options?: PointerSwipeOptions
): PointerSwipeReturn
Source
Contributors
Anthony Fu
Jeffrey Li
MinatoHikari
Ilya Komichev
lstoeferle