useCycleList

v0.0.15testeddemo

Cycle through a list of items, with `next`/`prev`/`shift`/`go` controls. Supports a reactive list — the index is kept valid when the list changes.

Examples

const { state, next, prev } = useCycleList(['a', 'b', 'c']);
next(); // state.value === 'b'

const { index } = useCycleList(['a', 'b', 'c']);
index.value = 2; // jump directly to 'c'

Loading demo…

export function useCycleList<T>(
  list: MaybeRefOrGetter<T[]>,
  options: UseCycleListOptions<T> ={ ... }

T

Parameter	Type	Default	Description
`list`	`MaybeRefOrGetter<T[]>`	—	The list to cycle through (can be reactive)
`options`?	`UseCycleListOptions<T>`	`{}`	Options

UseCycleListReturn<T>State and controls