@aic-kits/react 0.28.7 → 0.29.2

package/dist/theme/common/index.d.ts

@@ -32,5 +32,6 @@ export * from './shadows';
 export * from './sizes';
 export * from './spaces';
 export * from './text';
+export * from './zIndex';
 export type GlobalTheme = ReturnType<typeof getGlobalTheme>;
 export type { Scale, ColorPalette, GradientColorPalette };

package/dist/theme/common/zIndex.d.ts

@@ -0,0 +1,22 @@
+import { ZIndexRegistry } from '../../utils/zIndexRegistry';
+/**
+ * A singleton instance of ZIndexRegistry to manage z-index across the entire application.
+ * Using a single instance ensures that all components reference the same stacking system.
+ */
+export declare const zIndexRegistry: ZIndexRegistry;
+/**
+ * A constant object defining the stacking layers for the application.
+ * Each layer is assigned a unique identifier that can be used to reference it in the z-index registry.
+ */
+export declare const StackingLayers: {
+    readonly PageContent: "PageContent";
+    readonly Carousel: "Carousel";
+    readonly Restrict: "Restrict";
+    readonly Floating: "Floating";
+    readonly Tooltip: "Tooltip";
+    readonly AppFooter: "AppFooter";
+    readonly AppHeader: "AppHeader";
+    readonly Dropdown: "Dropdown";
+    readonly Modal: "Modal";
+    readonly Notification: "Notification";
+};

package/dist/theme/getTheme.d.ts

@@ -1,4 +1,4 @@
-import { BorderWidths, Radii, ColorPalette, Spaces, Fonts, Sizes, getFontSizes, getLineHeights, getFontWeights } from './common';
+import { BorderWidths, Radii, ColorPalette, Spaces, Fonts, Sizes, getFontSizes, getLineHeights, getFontWeights, zIndexRegistry } from './common';
 import { ComponentsTheme } from './components';
 export interface Theme {
     spaces: Spaces;
@@ -7,6 +7,7 @@ export interface Theme {
     radii: Radii;
     borderWidths: BorderWidths;
     fonts: Fonts;
+    zIndex: typeof zIndexRegistry;
     __hd__: {
         text: {
             fontSizes: ReturnType<typeof getFontSizes>;

package/dist/utils/zIndexRegistry.d.ts

@@ -0,0 +1,54 @@
+/**
+ * A class to manage z-index relationships between different components.
+ * It uses a topological sort algorithm to calculate the correct z-index values.
+ */
+export declare class ZIndexRegistry {
+    private dependencies;
+    private zIndexes;
+    private nodes;
+    private baseZIndex;
+    private step;
+    /**
+     * @param baseZIndex The starting z-index value. Default is 10.
+     * @param step The distance between z-index values. Default is 10.
+     */
+    constructor({ baseZIndex, step }?: {
+        baseZIndex?: number | undefined;
+        step?: number | undefined;
+    });
+    /**
+     * Register a stacking relationship between two components.
+     * @param belowId The ID of the component below.
+     * @param aboveId The ID of the component above.
+     */
+    register(belowId: string, aboveId: string): void;
+    /**
+     * Deregister a stacking relationship that already exists.
+     * This is useful when you need to override or insert a layer between two default layers.
+     * @param belowId The ID of the component below in the relationship to delete.
+     * @param aboveId The ID of the component above in the relationship to delete.
+     * @example
+     * // Assume the default is: registry.register('Tooltip', 'Modal');
+     * // Now we want to insert 'MyLayer' in between.
+     *
+     * // 1. Delete the old relationship
+     * registry.deregister('Tooltip', 'Modal');
+     *
+     * // 2. Add new relationships
+     * registry.register('Tooltip', 'MyLayer');
+     * registry.register('MyLayer', 'Modal');
+     */
+    deregister(belowId: string, aboveId: string): void;
+    /**
+     * Get the z-index for a registered component.
+     * If the z-index has not been calculated, it will perform a topological sort.
+     * @param id The ID of the component.
+     * @returns The calculated z-index.
+     */
+    getZIndex(id: string): number;
+    /**
+     * Perform a topological sort and calculate all the z-index values.
+     * @private
+     */
+    private _calculateZIndexes;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aic-kits/react",
-  "version": "0.28.7",
+  "version": "0.29.2",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -28,8 +28,10 @@
   },
   "dependencies": {
     "@phosphor-icons/react": "^2.1.7",
+    "@types/ua-parser-js": "^0.7.39",
     "@vimeo/player": "^2.27.1",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "ua-parser-js": "^2.0.3"
   },
   "peerDependencies": {
     "react": "^19.0.0",
@@ -53,5 +55,5 @@
     "vite-plugin-dts": "^4.3.0",
     "vitest": "^2.1.8"
   },
-  "gitHead": "851c22aea09486d3f0a2ded184a5a635b66e576a"
+  "gitHead": "671061b5b8a901f3b9e55036721bfc0e81df33fa"
 }