Github

Use Toggle

PreviousNext

A hook for managing boolean toggle state.

Installation

pnpm dlx shadcn@latest add https://components.sudarshandhakal.com.np/r/use-toggle.json

Usage

import { useToggle } from "@/hooks/use-toggle"
function MyComponent() {
  const { value, toggle, setTrue, setFalse } = useToggle(false)

  return (
    <div>
      <p>Value: {value ? "ON" : "OFF"}</p>
      <button onClick={toggle}>Toggle</button>
      <button onClick={setTrue}>Set True</button>
      <button onClick={setFalse}>Set False</button>
    </div>
  )
}

API

Returns

  • value - Current boolean value
  • toggle - Function to toggle the value
  • setTrue - Function to set value to true
  • setFalse - Function to set value to false
  • setValue - Function to set value to any boolean