@patreon/studio/module/components/OverlayStackProvider/index.d.ts

Patreon Studio Design System

import React from 'react';
/**
 * Provider for overlay nesting context
 */
export declare function OverlayStackProvider({ children }: {
    children: React.ReactNode;
}): React.JSX.Element;
/**
 * Hook to manage stacked overlays, returns a isTopOverlay flag which is enabled the overlay
 * is the top most overlay.
 */
export declare function useOverlayStack(id: string, open: boolean): {
    isTopOverlay: boolean;
};
/**
 * Component to register an overlay with the overlay stack context, should only be used
 * in class components where the useOverlayStack hook can't be used directly.
 * @deprecated please use useOverlayStack hook where possible instead of this component.
 */
export declare function OverlayStackComponent({ id, isOpen }: {
    id: string;
    isOpen: boolean;
}): null;