@codecademy/gamut

72.2.472.2.5-alpha.a75830.0
dist/Overlay/index.d.ts
~dist/Overlay/index.d.tsModified
+5−3
Index: package/dist/Overlay/index.d.ts
===================================================================
--- package/dist/Overlay/index.d.ts
+++ package/dist/Overlay/index.d.ts
@@ -1,4 +1,5 @@
+import { ZIndexType } from '@codecademy/gamut-styles';
 import * as React from 'react';
 export type OverlayProps = {
     children: React.ReactElement<any>;
     className?: string;
@@ -25,10 +26,11 @@
     shroud?: boolean;
     /** Whether the overlay allows scroll */
     allowScroll?: boolean;
     /**
-     * z-index for the Overlay. Defaults to 3 to appear above common UI elements
-     * like headers . Can be overridden when needed for custom stacking orders.
+     * Stacking layer for the Overlay. Pass a `zIndexes` token or a raw number (escape
+     * hatch). Defaults to `"modal"`; a portaled side panel should pass
+     * `"flyout"` to sit below modals.
      */
-    zIndex?: number;
+    zIndex?: ZIndexType;
 };
 export declare const Overlay: React.FC<OverlayProps>;