@codecademy/gamut
72.2.472.2.5-alpha.212edd.0
dist/Overlay/index.d.ts~
dist/Overlay/index.d.tsModified+3−2
Index: package/dist/Overlay/index.d.ts
===================================================================
--- package/dist/Overlay/index.d.ts
+++ package/dist/Overlay/index.d.ts
@@ -25,10 +25,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 `zIndices` token or a raw number (escape
+ * hatch). Defaults to `zIndices.modal`; a portaled side panel should pass
+ * `zIndices.flyout` to sit below modals.
*/
zIndex?: number;
};
export declare const Overlay: React.FC<OverlayProps>;