@behivetech/templates.sidebar-layout 0.0.0-stage → 0.4.3

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# SidebarLayout
 
-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.
+A dumb CSS Grid skeleton with sidebar, topbar, and content regions. It has no
+opinion on what the sidebar or topbar contain — the elements passed in are
+responsible for their own `grid-area: sidebar` / `grid-area: topbar`
+placement (e.g. via `@behivetech/atoms.sidebar`).
+
+Sidebar width, topbar height, and content max-width are configurable via CSS
+custom properties, each with a sensible default:
+
+- `--sidebar-layout-sidebar-width` (default `13.75rem`)
+- `--sidebar-layout-topbar-height` (default `3.5rem`)
+- `--sidebar-layout-content-max-width` (default `75rem`)
+
+## Usage
+
+```jsx
+import { SidebarLayout } from "@behivetech/templates.sidebar-layout";
+import { Sidebar } from "@behivetech/atoms.sidebar";
+import { NavItem } from "@behivetech/atoms.nav-item";
+
+function Example() {
+  return (
+    <SidebarLayout
+      sidebar={
+        <Sidebar>
+          <NavItem href="#" active>
+            Pages
+          </NavItem>
+          <NavItem href="#">Media</NavItem>
+        </Sidebar>
+      }
+      topbar={<header style={{ padding: "0.75rem 1rem" }}>Topbar</header>}
+    >
+      Page content
+    </SidebarLayout>
+  );
+}
+```

package/dist/index.cjs

@@ -0,0 +1,179 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// ../../../../node_modules/.pnpm/classnames@2.5.1/node_modules/classnames/index.js
+var require_classnames = __commonJS({
+  "../../../../node_modules/.pnpm/classnames@2.5.1/node_modules/classnames/index.js"(exports2, module2) {
+    "use strict";
+    (function() {
+      "use strict";
+      var hasOwn = {}.hasOwnProperty;
+      function classNames() {
+        var classes = "";
+        for (var i = 0; i < arguments.length; i++) {
+          var arg = arguments[i];
+          if (arg) {
+            classes = appendClass(classes, parseValue(arg));
+          }
+        }
+        return classes;
+      }
+      function parseValue(arg) {
+        if (typeof arg === "string" || typeof arg === "number") {
+          return arg;
+        }
+        if (typeof arg !== "object") {
+          return "";
+        }
+        if (Array.isArray(arg)) {
+          return classNames.apply(null, arg);
+        }
+        if (arg.toString !== Object.prototype.toString && !arg.toString.toString().includes("[native code]")) {
+          return arg.toString();
+        }
+        var classes = "";
+        for (var key in arg) {
+          if (hasOwn.call(arg, key) && arg[key]) {
+            classes = appendClass(classes, key);
+          }
+        }
+        return classes;
+      }
+      function appendClass(value, newClass) {
+        if (!newClass) {
+          return value;
+        }
+        if (value) {
+          return value + " " + newClass;
+        }
+        return value + newClass;
+      }
+      if (typeof module2 !== "undefined" && module2.exports) {
+        classNames.default = classNames;
+        module2.exports = classNames;
+      } else if (typeof define === "function" && typeof define.amd === "object" && define.amd) {
+        define("classnames", [], function() {
+          return classNames;
+        });
+      } else {
+        window.classNames = classNames;
+      }
+    })();
+  }
+});
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  SidebarLayout: () => SidebarLayout
+});
+module.exports = __toCommonJS(index_exports);
+
+// ../../../../packages/registry/class-names/dist/index.js
+var import_classnames = __toESM(require_classnames(), 1);
+var getClassName = ({
+  className,
+  modifiers = {},
+  rootClass,
+  styles = {}
+}) => {
+  function getModifiers() {
+    const updatedModifiers = {};
+    const modifierKeys = Object.keys(modifiers);
+    if (modifierKeys.length) {
+      modifierKeys.forEach((modKey) => {
+        const classKey = `${rootClass}--${modKey}`;
+        const newClassName = styles[classKey] || classKey;
+        updatedModifiers[newClassName] = modifiers[modKey] ?? false;
+      });
+    }
+    return updatedModifiers;
+  }
+  function getChildClass(childClassName) {
+    const classKey = `${rootClass}__${childClassName}`;
+    return styles[classKey] || classKey;
+  }
+  function getRootStyles() {
+    return (0, import_classnames.default)(
+      className,
+      {
+        ...getModifiers()
+      },
+      styles[rootClass] || rootClass
+    );
+  }
+  return [getRootStyles(), getChildClass];
+};
+
+// sidebar-layout.module.scss
+var sidebar_layout_module_default = {
+  "BHT__SidebarLayout": "BHT__SidebarLayout",
+  "BHT__SidebarLayout__main": "BHT__SidebarLayout__main",
+  "BHT__SidebarLayout__content": "BHT__SidebarLayout__content",
+  "BHT__SidebarLayout__inner": "BHT__SidebarLayout__inner"
+};
+
+// sidebar-layout.tsx
+var import_jsx_runtime = require("react/jsx-runtime");
+var SidebarLayout = ({
+  className,
+  sidebar,
+  topbar,
+  children,
+  ...rest
+}) => {
+  const [rootClass, getChildClass] = getClassName({
+    className,
+    rootClass: "BHT__SidebarLayout",
+    styles: sidebar_layout_module_default
+  });
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)("div", { ...rest, className: rootClass, children: [
+    sidebar,
+    /* @__PURE__ */ (0, import_jsx_runtime.jsxs)("div", { className: getChildClass("main"), children: [
+      topbar,
+      /* @__PURE__ */ (0, import_jsx_runtime.jsx)("main", { className: getChildClass("content"), children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)("div", { className: getChildClass("inner"), children }) })
+    ] })
+  ] });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SidebarLayout
+});
+/*! Bundled license information:
+
+classnames/index.js:
+  (*!
+  	Copyright (c) 2018 Jed Watson.
+  	Licensed under the MIT License (MIT), see
+  	http://jedwatson.github.io/classnames
+  *)
+*/

package/dist/index.css

@@ -0,0 +1,22 @@
+/* esbuild-sass-plugin:css-chunksidebar-layout.module.scss */
+.BHT__SidebarLayout {
+  display: grid;
+  grid-template-columns: var(--sidebar-layout-sidebar-width, 13.75rem) 1fr;
+  grid-template-rows: var(--sidebar-layout-topbar-height, 3.5rem) 1fr;
+  grid-template-areas: "sidebar topbar" "sidebar content";
+  min-height: 100vh;
+}
+.BHT__SidebarLayout__main {
+  grid-column: 2;
+  display: contents;
+}
+.BHT__SidebarLayout__content {
+  grid-area: content;
+  background: var(--md-sys-color-background, var(--color-background));
+  color: var(--md-sys-color-on-background, var(--color-text-body));
+  overflow-y: auto;
+}
+.BHT__SidebarLayout__inner {
+  padding: var(--spacing-8);
+  max-width: var(--sidebar-layout-content-max-width, 75rem);
+}

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import * as react from 'react';
+import { HTMLAttributes, ReactNode } from 'react';
+
+interface SidebarLayoutProps extends HTMLAttributes<HTMLDivElement> {
+    /** Additional class names to merge with the component root element */
+    className?: string;
+    /** Sidebar region content; the element rendered here owns its own `grid-area: sidebar` placement */
+    sidebar: ReactNode;
+    /** Topbar region content; the element rendered here owns its own `grid-area: topbar` placement */
+    topbar: ReactNode;
+    /** Main content region */
+    children?: ReactNode;
+}
+/**
+ * Dumb CSS Grid skeleton with sidebar, topbar, and content regions.
+ * Composition of the actual sidebar/topbar/content is left entirely to the
+ * consumer — this only owns the grid tracks and the content scroll area.
+ */
+declare const SidebarLayout: ({ className, sidebar, topbar, children, ...rest }: SidebarLayoutProps) => react.JSX.Element;
+
+export { SidebarLayout, type SidebarLayoutProps };

package/dist/index.js

@@ -0,0 +1,165 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// ../../../../node_modules/.pnpm/classnames@2.5.1/node_modules/classnames/index.js
+var require_classnames = __commonJS({
+  "../../../../node_modules/.pnpm/classnames@2.5.1/node_modules/classnames/index.js"(exports, module) {
+    "use strict";
+    (function() {
+      "use strict";
+      var hasOwn = {}.hasOwnProperty;
+      function classNames() {
+        var classes = "";
+        for (var i = 0; i < arguments.length; i++) {
+          var arg = arguments[i];
+          if (arg) {
+            classes = appendClass(classes, parseValue(arg));
+          }
+        }
+        return classes;
+      }
+      function parseValue(arg) {
+        if (typeof arg === "string" || typeof arg === "number") {
+          return arg;
+        }
+        if (typeof arg !== "object") {
+          return "";
+        }
+        if (Array.isArray(arg)) {
+          return classNames.apply(null, arg);
+        }
+        if (arg.toString !== Object.prototype.toString && !arg.toString.toString().includes("[native code]")) {
+          return arg.toString();
+        }
+        var classes = "";
+        for (var key in arg) {
+          if (hasOwn.call(arg, key) && arg[key]) {
+            classes = appendClass(classes, key);
+          }
+        }
+        return classes;
+      }
+      function appendClass(value, newClass) {
+        if (!newClass) {
+          return value;
+        }
+        if (value) {
+          return value + " " + newClass;
+        }
+        return value + newClass;
+      }
+      if (typeof module !== "undefined" && module.exports) {
+        classNames.default = classNames;
+        module.exports = classNames;
+      } else if (typeof define === "function" && typeof define.amd === "object" && define.amd) {
+        define("classnames", [], function() {
+          return classNames;
+        });
+      } else {
+        window.classNames = classNames;
+      }
+    })();
+  }
+});
+
+// ../../../../packages/registry/class-names/dist/index.js
+var import_classnames = __toESM(require_classnames(), 1);
+var getClassName = ({
+  className,
+  modifiers = {},
+  rootClass,
+  styles = {}
+}) => {
+  function getModifiers() {
+    const updatedModifiers = {};
+    const modifierKeys = Object.keys(modifiers);
+    if (modifierKeys.length) {
+      modifierKeys.forEach((modKey) => {
+        const classKey = `${rootClass}--${modKey}`;
+        const newClassName = styles[classKey] || classKey;
+        updatedModifiers[newClassName] = modifiers[modKey] ?? false;
+      });
+    }
+    return updatedModifiers;
+  }
+  function getChildClass(childClassName) {
+    const classKey = `${rootClass}__${childClassName}`;
+    return styles[classKey] || classKey;
+  }
+  function getRootStyles() {
+    return (0, import_classnames.default)(
+      className,
+      {
+        ...getModifiers()
+      },
+      styles[rootClass] || rootClass
+    );
+  }
+  return [getRootStyles(), getChildClass];
+};
+
+// sidebar-layout.module.scss
+var sidebar_layout_module_default = {
+  "BHT__SidebarLayout": "BHT__SidebarLayout",
+  "BHT__SidebarLayout__main": "BHT__SidebarLayout__main",
+  "BHT__SidebarLayout__content": "BHT__SidebarLayout__content",
+  "BHT__SidebarLayout__inner": "BHT__SidebarLayout__inner"
+};
+
+// sidebar-layout.tsx
+import { jsx, jsxs } from "react/jsx-runtime";
+var SidebarLayout = ({
+  className,
+  sidebar,
+  topbar,
+  children,
+  ...rest
+}) => {
+  const [rootClass, getChildClass] = getClassName({
+    className,
+    rootClass: "BHT__SidebarLayout",
+    styles: sidebar_layout_module_default
+  });
+  return /* @__PURE__ */ jsxs("div", { ...rest, className: rootClass, children: [
+    sidebar,
+    /* @__PURE__ */ jsxs("div", { className: getChildClass("main"), children: [
+      topbar,
+      /* @__PURE__ */ jsx("main", { className: getChildClass("content"), children: /* @__PURE__ */ jsx("div", { className: getChildClass("inner"), children }) })
+    ] })
+  ] });
+};
+export {
+  SidebarLayout
+};
+/*! Bundled license information:
+
+classnames/index.js:
+  (*!
+  	Copyright (c) 2018 Jed Watson.
+  	Licensed under the MIT License (MIT), see
+  	http://jedwatson.github.io/classnames
+  *)
+*/

package/docs.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://github.com/behivetech/bht-component-registry/docs.schema.json",
+  "version": 2,
+  "generatedAt": "2026-10-23T16:58:30.650Z",
+  "docs": [
+    {
+      "displayName": "SidebarLayout",
+      "description": "Dumb CSS Grid skeleton with sidebar, topbar, and content regions.\nComposition of the actual sidebar/topbar/content is left entirely to the\nconsumer — this only owns the grid tracks and the content scroll area.",
+      "extendsNative": true,
+      "props": [
+        {
+          "name": "sidebar",
+          "type": "ReactNode",
+          "required": true,
+          "defaultValue": null,
+          "description": "Sidebar region content; the element rendered here owns its own `grid-area: sidebar` placement"
+        },
+        {
+          "name": "topbar",
+          "type": "ReactNode",
+          "required": true,
+          "defaultValue": null,
+          "description": "Topbar region content; the element rendered here owns its own `grid-area: topbar` placement"
+        },
+        {
+          "name": "children",
+          "type": "ReactNode",
+          "required": false,
+          "defaultValue": null,
+          "description": "Main content region"
+        },
+        {
+          "name": "className",
+          "type": "string",
+          "required": false,
+          "defaultValue": null,
+          "description": "Additional class names to merge with the component root element"
+        }
+      ]
+    }
+  ],
+  "functions": []
+}

package/index.ts

@@ -0,0 +1,2 @@
+export { SidebarLayout } from "./sidebar-layout.js";
+export type { SidebarLayoutProps } from "./sidebar-layout.js";

package/package.json

@@ -1,6 +1,59 @@
 {
   "name": "@behivetech/templates.sidebar-layout",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.4.3",
+  "license": "MIT",
+  "type": "module",
+  "private": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./styles.css": "./dist/index.css"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "index.ts",
+    "sidebar-layout.tsx",
+    "sidebar-layout.module.scss",
+    "*.example.tsx",
+    "docs.json"
+  ],
+  "registry": {
+    "status": "stable",
+    "tags": []
+  },
+  "peerDependencies": {
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7"
+  },
+  "devDependencies": {
+    "@types/react": "19.2.17",
+    "@types/react-dom": "19.2.3",
+    "eslint": "^9.39.5",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10",
+    "@bht-component-registry/class-names": "0.0.6",
+    "@bht-component-registry/env": "0.1.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/behivetech/bht-galaxy.git",
+    "directory": "registry/behivetech/templates/sidebar-layout"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsup && bht-registry-docgen",
+    "dev": "tsup --watch",
+    "lint": "eslint . --max-warnings 0",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run"
+  }
 }

package/sidebar-layout.example.tsx

@@ -0,0 +1,7 @@
+import { SidebarLayout } from "./sidebar-layout.js";
+
+export const BasicSidebarLayout = () => (
+  <SidebarLayout sidebar={<nav>Sidebar</nav>} topbar={<header>Topbar</header>}>
+    Page content
+  </SidebarLayout>
+);

package/sidebar-layout.module.scss

@@ -0,0 +1,26 @@
+.BHT__SidebarLayout {
+  display: grid;
+  grid-template-columns: var(--sidebar-layout-sidebar-width, 13.75rem) 1fr;
+  grid-template-rows: var(--sidebar-layout-topbar-height, 3.5rem) 1fr;
+  grid-template-areas:
+    "sidebar topbar"
+    "sidebar content";
+  min-height: 100vh;
+
+  &__main {
+    grid-column: 2;
+    display: contents;
+  }
+
+  &__content {
+    grid-area: content;
+    background: var(--md-sys-color-background, var(--color-background));
+    color: var(--md-sys-color-on-background, var(--color-text-body));
+    overflow-y: auto;
+  }
+
+  &__inner {
+    padding: var(--spacing-8);
+    max-width: var(--sidebar-layout-content-max-width, 75rem);
+  }
+}

package/sidebar-layout.tsx

@@ -0,0 +1,45 @@
+import { type HTMLAttributes, type ReactNode } from "react";
+import { getClassName } from "@bht-component-registry/class-names";
+import styles from "./sidebar-layout.module.scss";
+
+export interface SidebarLayoutProps extends HTMLAttributes<HTMLDivElement> {
+  /** Additional class names to merge with the component root element */
+  className?: string;
+  /** Sidebar region content; the element rendered here owns its own `grid-area: sidebar` placement */
+  sidebar: ReactNode;
+  /** Topbar region content; the element rendered here owns its own `grid-area: topbar` placement */
+  topbar: ReactNode;
+  /** Main content region */
+  children?: ReactNode;
+}
+
+/**
+ * Dumb CSS Grid skeleton with sidebar, topbar, and content regions.
+ * Composition of the actual sidebar/topbar/content is left entirely to the
+ * consumer — this only owns the grid tracks and the content scroll area.
+ */
+export const SidebarLayout = ({
+  className,
+  sidebar,
+  topbar,
+  children,
+  ...rest
+}: SidebarLayoutProps) => {
+  const [rootClass, getChildClass] = getClassName({
+    className,
+    rootClass: "BHT__SidebarLayout",
+    styles,
+  });
+
+  return (
+    <div {...rest} className={rootClass}>
+      {sidebar}
+      <div className={getChildClass("main")}>
+        {topbar}
+        <main className={getChildClass("content")}>
+          <div className={getChildClass("inner")}>{children}</div>
+        </main>
+      </div>
+    </div>
+  );
+};