Skip to main content

hooks/use-toggle

Interfaces​

UseToggleResult​

Defined in: hooks/use-toggle.ts:3

Properties​

value​

value: boolean

Defined in: hooks/use-toggle.ts:5

The current boolean value.

toggle​

toggle: (next?) => void

Defined in: hooks/use-toggle.ts:7

Flip the value, or set it explicitly when passed a boolean.

Parameters​
next?​

boolean

Returns​

void

setOn​

setOn: () => void

Defined in: hooks/use-toggle.ts:9

Set the value to true.

Returns​

void

setOff​

setOff: () => void

Defined in: hooks/use-toggle.ts:11

Set the value to false.

Returns​

void

Functions​

useToggle()​

useToggle(initialValue?): UseToggleResult

Defined in: hooks/use-toggle.ts:21

Boolean state with stable toggle/set helpers — the common open/closed, on/off pattern.

Parameters​

initialValue?​

boolean = false

Returns​

UseToggleResult

Example​

const { value: isOpen, toggle, setOff } = useToggle()