Skip to content

useDisclosure

function useDisclosure(props?: UseDisclosureProps): {
isOpen: boolean;
onClose: () => void;
onOpen: () => void;
onToggle: () => void;
setOpen: Dispatch<SetStateAction<boolean>>;
};

useDisclosure is a custom hook used to help handle common open, close, or toggle scenarios. It can be used to control feedback component such as Modal, AlertDialog, Drawer, etc.

Parameter Type
props? UseDisclosureProps
{
isOpen: boolean;
onClose: () => void;
onOpen: () => void;
onToggle: () => void;
setOpen: Dispatch<SetStateAction<boolean>>;
}
Name Type
isOpen boolean
onClose() () => void
onOpen() () => void
onToggle() () => void
setOpen Dispatch<SetStateAction<boolean>>