useCounter

API Reference

useCounter

Provides a count that can be incremented and decremented.

Parameters

ParameterTypeDefault Value
initialCount?number0

Returns

PropertyTypeModifiers
countnumber
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>
      )
    }