useBoolean

Generic boolean state with stable toggle, enable and disable actions.

HooksState@gaudi/design-system/hooks/state/use-booleanView in Storybook Source

Keeps on/off state without disclosure-specific ARIA. Values and functional updates are normalized to booleans; the initial value is also the server value.

Usage

import { useBoolean } from '@gaudi/design-system/hooks';
const { value, toggle, setTrue, setFalse } = useBoolean(false);

Examples

Playground

Storybook

API

1 option

2 return values

Accessibility

Use aria-pressed on toggle buttons or checked on switches. Use useDisclosure for a control that reveals a region.

Notes

Covers the boolean useToggle use case with one API.

useDisclosureOpen, close and toggle state for overlays and disclosures.useControllableStateState that works controlled or uncontrolled, like native inputs.useCountdownA pausable countdown or count-up that stops at its target.useCounterA number with increment, decrement, set and reset actions.useDebounceCallbackA debounced function with cancel and flush.useDebounceValueA value that updates only after it stops changing.