UNPKG

391 BTypeScriptView Raw
1export interface UseDisclosureReturn {
2 isOpen: boolean;
3 onOpen(): void;
4 onClose(): void;
5 onToggle(): void;
6}
7
8/**
9 * useDisclosure is a custom hook to help handle common `open`, `close`, or `toggle` scenarios
10 * @returns An object of `isOpen, onOpen, onClose, onToggle`
11 */
12declare function useDisclosure(defaultIsOpen?: boolean): UseDisclosureReturn;
13
14export default useDisclosure;