useDisclosure

useDisclosure(options?): UseDisclosureReturn

Defined in: src/hooks/useDisclosure/useDisclosure.ts:32

Manage an open/closed state with stable open, close, toggle callbacks.

Supports both controlled (driven by an open prop) and uncontrolled (managed internally with defaultOpen) modes. Built on top of useControlledState so the same controlled / uncontrolled rules apply — including the development warning when switching modes mid-life.

Parameters

options?

UseDisclosureOptions = {}

Returns

UseDisclosureReturn

Example

const { isOpen, open, close, toggle } = useDisclosure();

return (
  <>
    <Button onClick={open}>Open</Button>
    <Dialog open={isOpen} onClose={close}>...</Dialog>
  </>
);