npm - @layout-lib/react - Versions diffs - 0.1.0 - Mend

@layout-lib/react 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 Amézir Messaoud
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,67 @@
+# @layout-lib/react
+A responsive design grid overlay for development, for React, Next and Vite.
+The config is versioned in your repo, the overlay follows your real breakpoints, and it leaves your production bundle untouched.
+```bash
+npm install -D @layout-lib/react
+# or: pnpm add -D @layout-lib/react
+# or: yarn add -D @layout-lib/react
+```
+```tsx
+import { LayoutGrid } from "@layout-lib/react";
+export function App() {
+  return (
+    <>
+      <LayoutGrid />
+      {/* your app */}
+    </>
+  );
+}
+```
+<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>G</kbd> shows or hides the grid.
+<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> folds the settings panel.
+## Next.js (App Router)
+The package already carries the `"use client"` directive, so a server component renders it as is.
+```tsx
+// app/layout.tsx
+import { LayoutGrid } from "@layout-lib/react";
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <body>
+        <LayoutGrid />
+        {children}
+      </body>
+    </html>
+  );
+}
+```
+## Driving it from your code
+```tsx
+import { useLayoutOverlay } from "@layout-lib/react";
+const overlay = useLayoutOverlay({ panel: false });
+overlay?.toggle();
+overlay?.updateActiveGrid({ columns: 6 }); // only the current breakpoint
+overlay?.exportConfig(); // the TypeScript file, as a string
+```
+## In production
+The component only runs in development, and the core is pulled in through a dynamic import: the main chunk of a production build contains not a line of the overlay. Pass `enabled` to force the behaviour either way.
+Options, breakpoint config and the full API are documented at the root of the repo: https://github.com/amezir/layout-lib
+MIT.

package/dist/index.cjs ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ "use client";
2	+ "use strict";"use client";var c=Object.create;var a=Object.defineProperty;var v=Object.getOwnPropertyDescriptor;var f=Object.getOwnPropertyNames;var d=Object.getPrototypeOf,L=Object.prototype.hasOwnProperty;var m=(e,t)=>{for(var r in t)a(e,r,{get:t[r],enumerable:!0})},s=(e,t,r,l)=>{if(t&&typeof t=="object"\|\|typeof t=="function")for(let o of f(t))!L.call(e,o)&&o!==r&&a(e,o,{get:()=>t[o],enumerable:!(l=v(t,o))\|\|l.enumerable});return e};var P=(e,t,r)=>(r=e!=null?c(d(e)):{},s(t\|\|!e\|\|!e.__esModule?a(r,"default",{value:e,enumerable:!0}):r,e)),x=e=>s(a({},"__esModule",{value:!0}),e);var N={};m(N,{LayoutGrid:()=>b,useLayoutOverlay:()=>p});module.exports=x(N);var n=require("react"),G=()=>{try{return process.env.NODE_ENV!=="production"}catch{return!1}};function p({enabled:e=G(),container:t,...r}={}){let[l,o]=(0,n.useState)(null),y=JSON.stringify(r);return(0,n.useEffect)(()=>{if(!e)return;let u=null,i=!1;return import("@layout-lib/core").then(({createOverlay:O})=>{i\|\|(u=O({...JSON.parse(y),container:t}),o(u))}),()=>{i=!0,u?.destroy(),o(null)}},[e,y,t]),l}function b(e){return p(e),null}0&&(module.exports={LayoutGrid,useLayoutOverlay});

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,13 @@
+import { OverlayOptions, LayoutOverlay } from '@layout-lib/core';
+export { Breakpoint, GridConfig, LayoutOverlay, OverlayOptions, OverlayState, PanelPalette, PanelTheme } from '@layout-lib/core';
+interface LayoutGridProps extends OverlayOptions {
+    /** Defaults to `true` in development and `false` in production builds. */
+    enabled?: boolean;
+}
+/** Mounts the overlay while the component is rendered, and returns its handle. */
+declare function useLayoutOverlay({ enabled, container, ...options }?: LayoutGridProps): LayoutOverlay | null;
+/** Drop-in overlay. Renders nothing; the grid lives in its own shadow root. */
+declare function LayoutGrid(props: LayoutGridProps): null;
+export { LayoutGrid, type LayoutGridProps, useLayoutOverlay };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,13 @@
+import { OverlayOptions, LayoutOverlay } from '@layout-lib/core';
+export { Breakpoint, GridConfig, LayoutOverlay, OverlayOptions, OverlayState, PanelPalette, PanelTheme } from '@layout-lib/core';
+interface LayoutGridProps extends OverlayOptions {
+    /** Defaults to `true` in development and `false` in production builds. */
+    enabled?: boolean;
+}
+/** Mounts the overlay while the component is rendered, and returns its handle. */
+declare function useLayoutOverlay({ enabled, container, ...options }?: LayoutGridProps): LayoutOverlay | null;
+/** Drop-in overlay. Renders nothing; the grid lives in its own shadow root. */
+declare function LayoutGrid(props: LayoutGridProps): null;
+export { LayoutGrid, type LayoutGridProps, useLayoutOverlay };

package/dist/index.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ "use client";
2	+ "use client";import{useEffect as i,useState as s}from"react";var p=()=>{try{return process.env.NODE_ENV!=="production"}catch{return!1}};function O({enabled:e=p(),container:r,...n}={}){let[u,o]=s(null),l=JSON.stringify(n);return i(()=>{if(!e)return;let t=null,a=!1;return import("@layout-lib/core").then(({createOverlay:y})=>{a\|\|(t=y({...JSON.parse(l),container:r}),o(t))}),()=>{a=!0,t?.destroy(),o(null)}},[e,l,r]),u}function v(e){return O(e),null}export{v as LayoutGrid,O as useLayoutOverlay};

package/package.json ADDED Viewed

@@ -0,0 +1,57 @@
+{
+  "name": "@layout-lib/react",
+  "version": "0.1.0",
+  "description": "Responsive layout grid overlay for React, Next.js and Vite.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@layout-lib/core": "0.1.0"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "devDependencies": {
+    "@types/react": "^19.0.1",
+    "react": "^19.0.0"
+  },
+  "keywords": [
+    "react",
+    "nextjs",
+    "grid",
+    "overlay",
+    "layout",
+    "responsive"
+  ],
+  "license": "MIT",
+  "author": "Amézir Messaoud (https://github.com/amezir)",
+  "homepage": "https://github.com/amezir/layout-lib#readme",
+  "bugs": {
+    "url": "https://github.com/amezir/layout-lib/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/amezir/layout-lib.git",
+    "directory": "packages/react"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}