use-boolean

PreviousNext

A hook to toggle a boolean value

Docs
hookshook

Preview

Loading preview…
registry/hooks/use-boolean.ts
import { useMemo } from 'react'
import useToggle from '@/registry/hooks/use-toggle'

export function useBoolean(defaultValue: boolean = false) {
  const [state, actions] = useToggle(defaultValue)

  return [
    state,
    useMemo(
      () => ({
        set: (value: boolean) => actions.set(value),
        setTrue: () => actions.set(true),
        setFalse: () => actions.set(false),
        toggle: () => actions.toggle(),
      }),
      [actions],
    ),
  ] as const
}

Installation

npx shadcn@latest add @hooks/use-boolean

Usage

import { UseBoolean } from "@/hooks/use-boolean"
const value = UseBoolean()