useToggle

Boolean state with convenient toggle, on, and off helper functions.

import { useToggle } from "@allem-sdk/hooks";

Parameters

PropTypeDefaultDescription
initialValuebooleanfalseInitial toggle state

Returns

PropertyTypeDescription
valuebooleanCurrent state
toggle() => voidFlip the value
on() => voidSet to true
off() => voidSet to false

Usage

const { value: isOpen, toggle, on, off } = useToggle();

<button onClick={toggle}>
  {isOpen ? "Close" : "Open"}
</button>

{isOpen && <Panel onClose={off} />}