useCounter

Category

State

Export Size

814 B

Last Changed

5 days ago

A basic counter with inc / dec / set / reset and optional min / max bounds

Demo

Basic Usage

import { useCounter } from '@reause/shared'

const { count, inc, dec, set, reset } = useCounter()

Usage with options

import { useCounter } from '@reause/shared'

const { count, inc, dec, set, reset } = useCounter(1, { min: 0, max: 16 })

Type Declarations

export interface UseCounterOptions {
    min?: number;
    max?: number;
}

export interface UseCounterReturn {
    count: number;
    inc: (delta?: number) => void;
    dec: (delta?: number) => void;
    get: () => number;
    set: (value: number) => void;
    reset: (val?: number) => number;
}

export type State<T> = StateValue<T>

export function useCounter(initialValue?: State<number>, options?: UseCounterOptions): UseCounterReturn

export function useControllableState<T>(state: State<T>, options?: UseControllableStateOptions<T>): StateTuple<T>

Source

Source · Demo

Contributors

Changelog

v0.1.0 on

84255 - fix(shared): resolve useCounter audit findings (#730)