useBoolean

A hook that elegantly manages boolean state.

Overview

A hook that elegantly manages boolean state.

Documentation and Examples

Installation

pnpm dlx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useBoolean.json

npx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useBoolean.json

yarn shadcn@latest add https://shadcn-ahooks.vercel.app/r/useBoolean.json

bun shadcn@latest add https://shadcn-ahooks.vercel.app/r/useBoolean.json

A hook that elegantly manages boolean state.

Examples

Default usage

API

const [state, { toggle, set, setTrue, setFalse }] = useBoolean(
  defaultValue?: boolean,
);

Params

| Property | Description | Type | Default | | | | - | | defaultValue | The default value of the state. Optional. | boolean | false |

Result

Property	Description	Type
toggle	Toggle state	`() => void`
set	Set state	`(value: boolean) => void`
setTrue	Set state to `true`	`() => void`
setFalse	Set state to `false`	`() => void`

useAsyncEffect

useEffect support async function.

useClickAway

Listen for click events outside the target element.

On this page

Overview Installation Examples Default usage API Params Result