4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
76 lines
1.5 KiB
Markdown
76 lines
1.5 KiB
Markdown
---
|
|
category: Sensors
|
|
---
|
|
|
|
# useSwipe
|
|
|
|
Reactive swipe detection based on [`TouchEvents`](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent).
|
|
|
|
## Usage
|
|
|
|
```vue
|
|
<script setup lang="ts">
|
|
import { useSwipe } from '@vueuse/core'
|
|
import { useTemplateRef } from 'vue'
|
|
|
|
const el = useTemplateRef('el')
|
|
const { isSwiping, direction } = useSwipe(el)
|
|
</script>
|
|
|
|
<template>
|
|
<div ref="el">
|
|
Swipe here
|
|
</div>
|
|
</template>
|
|
```
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
export type UseSwipeDirection = "up" | "down" | "left" | "right" | "none"
|
|
export interface UseSwipeOptions extends ConfigurableWindow {
|
|
/**
|
|
* Register events as passive
|
|
*
|
|
* @default true
|
|
*/
|
|
passive?: boolean
|
|
/**
|
|
* @default 50
|
|
*/
|
|
threshold?: number
|
|
/**
|
|
* Callback on swipe start
|
|
*/
|
|
onSwipeStart?: (e: TouchEvent) => void
|
|
/**
|
|
* Callback on swipe moves
|
|
*/
|
|
onSwipe?: (e: TouchEvent) => void
|
|
/**
|
|
* Callback on swipe ends
|
|
*/
|
|
onSwipeEnd?: (e: TouchEvent, direction: UseSwipeDirection) => void
|
|
}
|
|
export interface UseSwipeReturn {
|
|
isSwiping: ShallowRef<boolean>
|
|
direction: ComputedRef<UseSwipeDirection>
|
|
coordsStart: Readonly<Position>
|
|
coordsEnd: Readonly<Position>
|
|
lengthX: ComputedRef<number>
|
|
lengthY: ComputedRef<number>
|
|
stop: () => void
|
|
}
|
|
/**
|
|
* Reactive swipe detection.
|
|
*
|
|
* @see https://vueuse.org/useSwipe
|
|
* @param target
|
|
* @param options
|
|
*/
|
|
export declare function useSwipe(
|
|
target: MaybeRefOrGetter<EventTarget | null | undefined>,
|
|
options?: UseSwipeOptions,
|
|
): UseSwipeReturn
|
|
```
|