PXD
v0.2.1-dev

useCarousel

Drives a carousel’s index, looping and autoplay state without rendering anything.

Exports

function useCarousel(options?: CarouselOptions): {
  index: Readonly<Ref<number>>
  isAtFirst: ComputedRef<boolean>
  isAtLast: ComputedRef<boolean>
  isAutoPlayPaused: Readonly<Ref<boolean>>
  progressKey: Readonly<Ref<number>>
  next: () => Promise<number | null>
  prev: () => Promise<number | null>
  goTo: (index: number) => Promise<number | null>
  pause: () => void
  resume: () => void
  stop: () => void
}

Types

interface CarouselMove {
  from: number
  to: number
  direction: 1 | -1
  wrapped: boolean
}

interface CarouselOptions {
  count?: MaybeRefOrGetter<number>
  defaultIndex?: number
  loop?: MaybeRefOrGetter<boolean>
  autoplay?: MaybeRefOrGetter<boolean>
  interval?: MaybeRefOrGetter<number>
  transition?: (move: CarouselMove) => void | Promise<void>
  onChange?: (index: number) => void
}

Params

NameTypeDescription
options.countMaybeRefOrGetter<number>Number of slides
options.defaultIndexnumberIndex used on the first render; later values are ignored, call goTo instead
options.loopMaybeRefOrGetter<boolean>Wrap around at both ends; defaults to true
options.autoplayMaybeRefOrGetter<boolean>Advance on an interval; defaults to false
options.intervalMaybeRefOrGetter<number>Autoplay interval in milliseconds; defaults to 3000
options.transition(move: CarouselMove) => void | Promise<void>Runs before the index is committed; resolve it when the visual transition ends
options.onChange(index: number) => voidCalled after the index is committed

Source

Source