@vela-ui/react/dist/hooks/use-disclosure.d.ts

Vela UI React components

import * as React from 'react';

interface UseDisclosureProps {
    isOpen?: boolean;
    defaultOpen?: boolean;
    onClose?(): void;
    onOpen?(): void;
}
/**
 * `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.
 *
 * @see Docs https://chakra-ui.com/docs/hooks/use-disclosure
 * @see Source https://github.com/chakra-ui/chakra-ui/blob/main/packages/react/src/hooks/use-disclosure.ts
 */
declare function useDisclosure(props?: UseDisclosureProps): {
    isOpen: boolean;
    onOpen: () => void;
    onClose: () => void;
    onOpenChange: () => void;
    setOpen: React.Dispatch<React.SetStateAction<boolean>>;
};
type UseDisclosureReturn = ReturnType<typeof useDisclosure>;

export { type UseDisclosureProps, type UseDisclosureReturn, useDisclosure };