Back to Hooks

useCounter

packages/hooks/src/useCounter/index.en-US.md

3.9.71.3 KB
Original Source

useCounter

A hook that manage counter.

Examples

Default usage

<code src="./demo/demo1.tsx" />

API

typescript
const [current, {
  inc,
  dec,
  set,
  reset
}] = useCounter(initialValue, { min, max });

Result

PropertyDescriptionType
currentCurrent valuenumber
incIncrement, default delta is 1(delta?: number) => void
decDecrement, default delta is 1(delta?: number) => void
setSet current value(value: number | ((c: number) => number)) => void
resetReset current value to initial value() => void

Params

PropertyDescriptionTypeDefault
initialValueInitial countnumber0
minMin countnumber-
maxMax countnumber-