useCounter

API Reference

useCounter

Provides a count that can be incremented and decremented.

function useCounter(initialCount: number = 0): { count: number; increment: () => void; decrement: () => void; }

Parameters

ParameterTypeDefault Value
initialCountinitialCount: number = 00

Returns

{ count: number; increment: () => void; decrement: () => void; }

Examples

  • useCounter
    import { useCounter } from 'hooks'
    
    export default function Example({ initialCount = 0 }: { initialCount: number }) {
      const { count, increment, decrement } = useCounter(initialCount)
    
      return (
        <div>
          <button onClick={decrement}>-</button>
          <button onClick={increment}>+</button>
          <span>Count: {count}</span>
        </div>
      )
    }