PXD
v0.2.1-dev

useHold

Tracks a press-and-hold gesture: progress, confirmation and cancellation.

Exports

function useHold(options?: HoldOptions): {
  status: Readonly<Ref<HoldStatus>>
  progress: Readonly<Ref<number>>
  start: () => void
  pause: () => void
  resume: () => void
  stop: () => void
}

Types

type HoldStatus = 'idle' | 'loading' | 'confirmed' | 'canceled'

interface HoldOptions {
  duration?: MaybeRefOrGetter<number | undefined>
  enabled?: MaybeRefOrGetter<boolean | undefined>
  onConfirm?: () => void
  onCancel?: (progress: number) => void
}

Params

NameTypeDescription
options.durationMaybeRefOrGetter<number | undefined>Hold duration in milliseconds; defaults to 2000
options.enabledMaybeRefOrGetter<boolean | undefined>Whether start can begin a hold; defaults to true
options.onConfirm() => voidCalled once the hold reaches the duration
options.onCancel(progress: number) => voidCalled when the hold ends before it reaches the duration

Source

Source