@oaknational/oak-components 1.0.2 → 1.1.0

package/dist/types.d.ts

@@ -656,13 +656,14 @@ type TypographyStyleProps = {
 };
 
 declare const oakZIndexTokens: {
-    behind: number;
-    neutral: number;
-    "in-front": number;
-    "mobile-filters": number;
-    "fixed-header": number;
-    "modal-close-button": number;
-    "modal-dialog": number;
+    readonly behind: -1;
+    readonly neutral: 0;
+    readonly "in-front": 1;
+    readonly "mobile-filters": 2;
+    readonly "fixed-header": 100;
+    readonly "modal-close-button": 150;
+    readonly "modal-dialog": 300;
+    readonly banner: number;
 };
 type OakZIndexToken = keyof typeof oakZIndexTokens | null;
 
@@ -2181,6 +2182,9 @@ type OakModalProps = {
      *
      * Defaults to token: `modal-dialog`
      *
+     * 🚨 This prop is intended for use by consumers that do not use
+     * the internal system of z-index tokens.
+     *
      * NB *The modal is rendered inside a portal so it will not respect the stacking context of its parent component*.
      */
     zIndex?: number;
@@ -3064,7 +3068,10 @@ type OakCookieBannerProps = {
     /**
      * Optional z-index override of the banner.
      *
-     * Defaults to token: `in-front`
+     * Defaults to token: `banner`
+     *
+     * 🚨 This prop is intended for use by consumers that do not use
+     * the internal system of z-index tokens.
      */
     zIndex?: number;
 };
@@ -3225,6 +3232,9 @@ declare const OakCookieSettingsModal: ({ isOpen, onClose, onReject, onConfirm, o
 type OakCookieConsentProps = Pick<OakCookieSettingsModalProps, "policyURL"> & Pick<OakCookieBannerProps, "isFixed" | "innerMaxWidth"> & {
     /**
      * Optional stacking context for the entire consent UI
+     *
+     * 🚨 This prop is intended for use by consumers that do not use
+     * the internal system of z-index tokens.
      */
     zIndex?: number;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oaknational/oak-components",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "licence": "MIT",
   "description": "Shared components for Oak applications",
   "main": "dist/cjs/index.js",