useToggle

Manages boolean toggle state with convenience methods.

Signature

function useToggle(initialValue?: boolean): UseToggleReturn

Parameters

Parameter	Type	Default	Description
initialValue	boolean	false	Initial toggle state

Return Type

UseToggleReturn

Property	Type	Description
value	boolean	Current state
on	() => void	Set to true
off	() => void	Set to false
toggle	() => void	Flip current state
set	(value: boolean) => void	Set to specific value

Example

const { value: isOpen, on: open, off: close, toggle } = useToggle(false)

<Button onClick={open}>Open</Button>
<Button onClick={toggle}>Toggle</Button>
{isOpen && <Modal onClose={close} />}

See also

• useToggle (Conceptual)