useBoolean
A custom hook that manages a boolean state.
Installation
pnpm dlx shadcn@latest add @reactusekit/use-booleanUsage
import { useBoolean } from "@/hooks/use-boolean"
function App() {
const { value, setTrue, setFalse, toggle } = useBoolean(false)
return (
<div>
<p>Value: {value ? "true" : "false"}</p>
<button onClick={setTrue}>Set True</button>
<button onClick={setFalse}>Set False</button>
<button onClick={toggle}>Toggle</button>
</div>
)
}API Reference
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
defaultValue | boolean | false | The initial value of the boolean state |
Returns
| Name | Type | Description |
|---|---|---|
value | boolean | The current boolean value |
setValue | (value: boolean) => void | Function to set the boolean value directly |
setTrue | () => void | Function to set the value to true |
setFalse | () => void | Function to set the value to false |
toggle | () => void | Function to toggle the boolean value |