reablocks/dist/utils/Overlay/GlobalOverlay/GlobalOverlay.d.ts

Component library for React

import { FC } from 'react';

export interface GlobalOverlayProps {
    /**
     * The children to be rendered within the global overlay.
     */
    children?: any;
    /**
     * If true, the global overlay is open.
     */
    open: boolean;
    /**
     * If true, the global overlay will close when the backdrop is clicked.
     */
    closeOnBackdropClick?: boolean;
    /**
     * If true, the global overlay will have a backdrop.
     */
    hasBackdrop?: boolean;
    /**
     * The CSS class name to be applied to the backdrop of the global overlay.
     */
    backdropClassName?: string;
    /**
     * If true, the global overlay will close when the escape key is pressed.
     */
    closeOnEscape?: boolean;
    /**
     * A function that is called when the global overlay is closed.
     */
    onClose?: () => void;
}
export declare const GlobalOverlay: FC<GlobalOverlayProps>;