import { OverlayProps } from '../ui/internals/Overlay';
interface OverlayOptions {
    /**
     * Optional query param to be used to control the overlay visibility.
     * When set, the overlay will be opened when the query param is set to `true` (e.g. `?myOverlay=true`)
     * and the `open` method will perform an history.push to add the query param as navigating to a new page.
     * Otherwise, the overlay will be opened as a classic in-page modal.
     **/
    queryParam: string;
}
interface OverlayHook {
    /**
     * The overlay component.
     **/
    Overlay: React.FC<OverlayProps>;
    /**
     * Function to be used to open the overlay.
     **/
    open: () => void;
    /**
     * Function to be used to close the overlay.
     **/
    close: () => void;
}
export declare function useOverlay(options?: OverlayOptions): OverlayHook;
export {};