@gridui/overlay 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,8 @@
-# Temporary Holding Version
+# @gridui/overlay
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Core family. Public API: `OverlayOpen`, `RetainedLayer`, `RetainedLayerProps`, `useOverlayState`.
+
+Import components from `@gridui/overlay` and load `@gridui/overlay/styles.css` after Theme.
+Load styles for any composed dependency used by this family. Applications own routes, labels, state persistence, and branding.
+
+See [component ownership](../../docs/component-ownership.md) and [release history](.changeset/history/).

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author WMXPY
+ * @package Overlay
+ * @namespace Root
+ * @description Index
+ */
+export type { RetainedLayerProps } from "./retained-layer/retained-layer";
+export { OverlayOpen } from "./retained-layer/retained-layer";
+export { RetainedLayer } from "./retained-layer/retained-layer";
+export { useOverlayState } from "./shared/use-overlay-state";

package/dist/index.js

@@ -0,0 +1,39 @@
+// src/retained-layer/retained-layer.tsx
+import { Activity, createContext, useContext } from "react";
+import { jsx } from "react/jsx-runtime";
+var OverlayOpen = createContext(false);
+var RetainedLayer = (props) => {
+  const { children } = props;
+  const open = useContext(OverlayOpen);
+  return /* @__PURE__ */ jsx(
+    Activity,
+    {
+      mode: !open ? "hidden" : "visible",
+      children
+    }
+  );
+};
+
+// src/shared/use-overlay-state.ts
+import { useState } from "react";
+var useOverlayState = (options) => {
+  const [
+    localOpen,
+    setLocalOpen
+  ] = useState(options.defaultOpen ?? false);
+  return {
+    open: options.open ?? localOpen,
+    onOpenChange: (open) => {
+      if (options.open === void 0) {
+        setLocalOpen(open);
+      }
+      options.onOpenChange?.(open);
+    }
+  };
+};
+export {
+  OverlayOpen,
+  RetainedLayer,
+  useOverlayState
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/retained-layer/retained-layer.tsx", "../src/shared/use-overlay-state.ts"],
+  "sourcesContent": ["/**\n * @author WMXPY\n * @package Overlay\n * @namespace RetainedLayer\n * @description Retained Layer\n */\n\nimport { Activity, createContext, type FC, type ReactNode, useContext } from \"react\";\n\nexport const OverlayOpen = createContext(false);\n\nexport type RetainedLayerProps = {\n    readonly children: ReactNode;\n};\n\nexport const RetainedLayer: FC<RetainedLayerProps> = (props: RetainedLayerProps) => {\n    const { children } = props;\n    const open = useContext(OverlayOpen);\n    return (<Activity\n        mode={!open ? \"hidden\" : \"visible\"}\n    >\n        {children}\n    </Activity>);\n};\n", "/**\n * @author WMXPY\n * @package Overlay\n * @namespace Shared\n * @description Use Overlay State\n */\n\nimport { useState } from \"react\";\n\ntype OverlayStateOptions = {\n    readonly open?: boolean | undefined;\n    readonly defaultOpen?: boolean | undefined;\n    readonly onOpenChange?: ((open: boolean) => void) | undefined;\n};\n\nexport const useOverlayState = (options: OverlayStateOptions) => {\n    const [\n        localOpen,\n        setLocalOpen,\n    ] = useState(options.defaultOpen ?? false);\n    return {\n        open: options.open ?? localOpen,\n        onOpenChange: (open: boolean): void => {\n            if (options.open === undefined) {\n                setLocalOpen(open);\n            }\n            options.onOpenChange?.(open);\n        },\n    };\n};\n"],
+  "mappings": ";AAOA,SAAS,UAAU,eAAwC,kBAAkB;AAWjE;AATL,IAAM,cAAc,cAAc,KAAK;AAMvC,IAAM,gBAAwC,CAAC,UAA8B;AAChF,QAAM,EAAE,SAAS,IAAI;AACrB,QAAM,OAAO,WAAW,WAAW;AACnC,SAAQ;AAAA,IAAC;AAAA;AAAA,MACL,MAAM,CAAC,OAAO,WAAW;AAAA,MAExB;AAAA;AAAA,EACL;AACJ;;;AChBA,SAAS,gBAAgB;AAQlB,IAAM,kBAAkB,CAAC,YAAiC;AAC7D,QAAM;AAAA,IACF;AAAA,IACA;AAAA,EACJ,IAAI,SAAS,QAAQ,eAAe,KAAK;AACzC,SAAO;AAAA,IACH,MAAM,QAAQ,QAAQ;AAAA,IACtB,cAAc,CAAC,SAAwB;AACnC,UAAI,QAAQ,SAAS,QAAW;AAC5B,qBAAa,IAAI;AAAA,MACrB;AACA,cAAQ,eAAe,IAAI;AAAA,IAC/B;AAAA,EACJ;AACJ;",
+  "names": []
+}

package/dist/retained-layer/retained-layer.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @author WMXPY
+ * @package Overlay
+ * @namespace RetainedLayer
+ * @description Retained Layer
+ */
+import { type FC, type ReactNode } from "react";
+export declare const OverlayOpen: import("react").Context<boolean>;
+export type RetainedLayerProps = {
+    readonly children: ReactNode;
+};
+export declare const RetainedLayer: FC<RetainedLayerProps>;

package/dist/shared/use-overlay-state.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @author WMXPY
+ * @package Overlay
+ * @namespace Shared
+ * @description Use Overlay State
+ */
+type OverlayStateOptions = {
+    readonly open?: boolean | undefined;
+    readonly defaultOpen?: boolean | undefined;
+    readonly onOpenChange?: ((open: boolean) => void) | undefined;
+};
+export declare const useOverlayState: (options: OverlayStateOptions) => {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+};
+export {};

package/dist/styles.css

@@ -0,0 +1,10 @@
+/*! tailwindcss v4.3.3 | MIT License | https://tailwindcss.com */
+@layer theme, base, components, utilities;
+@layer utilities {
+  .visible {
+    visibility: visible;
+  }
+  .hidden {
+    display: none;
+  }
+}

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@gridui/overlay",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "GridUI React overlay",
+  "license": "UNLICENSED",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
+  },
+  "dependencies": {
+    "@gridui/theme": "^2.1.2"
+  },
+  "devDependencies": {
+    "@gridui-internal/configuration": "0.0.0",
+    "@jest/globals": "30.5.2",
+    "@types/jest": "30.0.0",
+    "@types/node": "26.6.5",
+    "@types/react": "19.3.0",
+    "@types/react-dom": "19.3.0",
+    "jest": "30.5.2",
+    "react": "19.3.1",
+    "react-dom": "19.3.1",
+    "typescript": "6.0.3"
+  },
+  "scripts": {
+    "build": "node ../../scripts/compilation/package.ts",
+    "compile": "tsc --project tsconfig.json",
+    "test": "jest --passWithNoTests",
+    "coverage": "jest --coverage --passWithNoTests"
+  }
 }