useCounter

utilities

test coverage

Last changed: 28 days ago

Hook that manages a counter

import { useCounter } from '@siberiacancode/reactuse';

Usage

const { count, dec, inc, reset, set } = useCounter(5);
// or
const { count, dec, inc, reset, set } = useCounter({ initialValue: 5, min: 0, max: 10 });

Demo

source

Api

Parameters

Name	Type	Default	Note
initialValue?	number	0	The initial number value
options.min?	number	Number.NEGATIVE_INFINITY	The min of count value
options.max?	number	Number.POSITIVE_INFINITY	The max of count value

Returns

UseCounterReturn

Parameters

Name	Type	Default	Note
params.initialValue?	number	0	The initial number value
params.min?	number	Number.NEGATIVE_INFINITY	The min of count value
params.max?	number	Number.POSITIVE_INFINITY	The max of count value

Returns

UseCounterReturn

Source

Source • Demo

Contributors

debabin

hywax