useCounter

v0.0.1testeddemo

A composable that provides a counter with increment, decrement, set, get, and reset functions

Examples

const { count, increment } = useCounter(0);

const { count, increment, decrement, set, get, reset } = useCounter(0, { min: 0, max: 10 });

Loading demo…

export function useCounter(
  initialValue: MaybeRefOrGetter<number> = 0,
  options: UseCounterOptions ={ ... }

Parameter	Type	Default	Description
`initialValue`?	`MaybeRefOrGetter<number>`	`0`	The initial value of the counter
`options`?	`UseCounterOptions`	`{}`	The options for the counter

UseConterReturnThe counter object

Property	Type	Default	Description
`count`	`Ref<number>`	—	—
`increment`	`(delta?: number) => void`	—	—
`decrement`	`(delta?: number) => void`	—	—
`set`	`(value: number) => void`	—	—
`get`	`() => number`	—	—
`reset`	`(value?: number) => void`	—	—