@behivetech/atoms.sidebar 0.0.0-stage → 0.4.3

package/README.md

@@ -1,3 +1,22 @@
-# Temporary Holding Version
+# Sidebar
 
-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, styled sidebar shell — sticky, full-height, scrollable flex
+container. It renders an `<aside>` and applies no internal structure; the
+consumer is responsible for composing whatever goes inside (logo, nav,
+`NavItem`s, etc.).
+
+## Usage
+
+```jsx
+import { Sidebar } from "@behivetech/atoms.sidebar";
+import { NavItem } from "@behivetech/atoms.nav-item";
+
+<Sidebar>
+  <div>My Logo</div>
+  <nav>
+    <NavItem href="/pages" icon="☰" active>
+      Pages
+    </NavItem>
+  </nav>
+</Sidebar>;
+```

package/dist/index.cjs

@@ -0,0 +1,164 @@
+"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, {
+  Sidebar: () => Sidebar
+});
+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.module.scss
+var sidebar_module_default = {
+  "BHT__Sidebar": "BHT__Sidebar"
+};
+
+// sidebar.tsx
+var import_jsx_runtime = require("react/jsx-runtime");
+var Sidebar = ({ className, children, ...rest }) => {
+  const [rootClass] = getClassName({
+    className,
+    rootClass: "BHT__Sidebar",
+    styles: sidebar_module_default
+  });
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)("aside", { ...rest, className: rootClass, children });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Sidebar
+});
+/*! 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,11 @@
+/* esbuild-sass-plugin:css-chunksidebar.module.scss */
+.BHT__Sidebar {
+  display: flex;
+  flex-direction: column;
+  position: sticky;
+  top: 0;
+  height: 100vh;
+  overflow-y: auto;
+  background: var(--md-sys-color-surface-container-low, var(--color-surface));
+  color: var(--md-sys-color-on-surface-variant, var(--color-text-muted));
+}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import * as react from 'react';
+import { HTMLAttributes, ReactNode } from 'react';
+
+interface SidebarProps extends HTMLAttributes<HTMLElement> {
+    /** Additional class names to merge with the component root element */
+    className?: string;
+    /** Content to render inside the sidebar */
+    children?: ReactNode;
+}
+/**
+ * Dumb, styled sidebar shell — sticky, full-height, scrollable container.
+ * Composition of logo, nav, links, etc. is left entirely to the consumer.
+ */
+declare const Sidebar: ({ className, children, ...rest }: SidebarProps) => react.JSX.Element;
+
+export { Sidebar, type SidebarProps };

package/dist/index.js

@@ -0,0 +1,150 @@
+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.module.scss
+var sidebar_module_default = {
+  "BHT__Sidebar": "BHT__Sidebar"
+};
+
+// sidebar.tsx
+import { jsx } from "react/jsx-runtime";
+var Sidebar = ({ className, children, ...rest }) => {
+  const [rootClass] = getClassName({
+    className,
+    rootClass: "BHT__Sidebar",
+    styles: sidebar_module_default
+  });
+  return /* @__PURE__ */ jsx("aside", { ...rest, className: rootClass, children });
+};
+export {
+  Sidebar
+};
+/*! 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,29 @@
+{
+  "$schema": "https://github.com/behivetech/bht-component-registry/docs.schema.json",
+  "version": 2,
+  "generatedAt": "2026-10-23T16:57:40.689Z",
+  "docs": [
+    {
+      "displayName": "Sidebar",
+      "description": "Dumb, styled sidebar shell — sticky, full-height, scrollable container.\nComposition of logo, nav, links, etc. is left entirely to the consumer.",
+      "extendsNative": true,
+      "props": [
+        {
+          "name": "children",
+          "type": "ReactNode",
+          "required": false,
+          "defaultValue": null,
+          "description": "Content to render inside the sidebar"
+        },
+        {
+          "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 { Sidebar } from "./sidebar.js";
+export type { SidebarProps } from "./sidebar.js";

package/package.json

@@ -1,6 +1,59 @@
 {
   "name": "@behivetech/atoms.sidebar",
-  "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.tsx",
+    "sidebar.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/atoms/sidebar"
+  },
+  "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.example.tsx

@@ -0,0 +1,3 @@
+import { Sidebar } from "./sidebar.js";
+
+export const BasicSidebar = () => <Sidebar>Sidebar content</Sidebar>;

package/sidebar.module.scss

@@ -0,0 +1,14 @@
+// Material Design 3 standard navigation drawer container. The background
+// previously came from `--admin-sidebar-bg`, which only the CMS admin app
+// defined.
+
+.BHT__Sidebar {
+  display: flex;
+  flex-direction: column;
+  position: sticky;
+  top: 0;
+  height: 100vh;
+  overflow-y: auto;
+  background: var(--md-sys-color-surface-container-low, var(--color-surface));
+  color: var(--md-sys-color-on-surface-variant, var(--color-text-muted));
+}

package/sidebar.tsx

@@ -0,0 +1,28 @@
+import { type HTMLAttributes, type ReactNode } from "react";
+import { getClassName } from "@bht-component-registry/class-names";
+import styles from "./sidebar.module.scss";
+
+export interface SidebarProps extends HTMLAttributes<HTMLElement> {
+  /** Additional class names to merge with the component root element */
+  className?: string;
+  /** Content to render inside the sidebar */
+  children?: ReactNode;
+}
+
+/**
+ * Dumb, styled sidebar shell — sticky, full-height, scrollable container.
+ * Composition of logo, nav, links, etc. is left entirely to the consumer.
+ */
+export const Sidebar = ({ className, children, ...rest }: SidebarProps) => {
+  const [rootClass] = getClassName({
+    className,
+    rootClass: "BHT__Sidebar",
+    styles,
+  });
+
+  return (
+    <aside {...rest} className={rootClass}>
+      {children}
+    </aside>
+  );
+};