@nucleux/kbd 0.0.0-stage → 0.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nucleux
+
+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

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# @nucleux/kbd
 
-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.
+Keyboard key and shortcut display — Nucleux agentic UI for React.
+
+Part of **[Nucleux](https://github.com/intelligaia-open-labs/nucleux)** — agentic UI components for React. Install a single component, or the full kit via [`@nucleux/react`](https://www.npmjs.com/package/@nucleux/react).
+
+
+## Exports
+
+- **`Kbd`** — a single key (`<kbd>`), e.g. `Esc`, `⌘`
+- **`KbdGroup`** — a key combination wrapping several `Kbd`s
+
+## Install
+
+```bash
+pnpm add @nucleux/kbd @nucleux/tokens
+```
+
+`react` / `react-dom` are peer dependencies.
+
+## Usage
+
+```tsx
+import { Kbd, KbdGroup } from "@nucleux/kbd";
+
+<KbdGroup>
+  <Kbd>Ctrl</Kbd>
+  <span>+</span>
+  <Kbd>K</Kbd>
+</KbdGroup>
+```
+
+Requires the theme once in your app: `import "@nucleux/tokens/styles.css";`
+and the Tailwind preset from `@nucleux/tokens/preset`.
+
+## License
+
+MIT © Nucleux

package/dist/index.cjs

@@ -0,0 +1,50 @@
+"use client";
+'use strict';
+
+var React = require('react');
+var utils = require('@nucleux/utils');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+
+// src/index.tsx
+var Kbd = React__namespace.forwardRef(({ className, ...props }, ref) => /* @__PURE__ */ jsxRuntime.jsx(
+  "kbd",
+  {
+    ref,
+    "data-slot": "kbd",
+    className: utils.cn(
+      "pointer-events-none inline-flex h-5 w-fit min-w-5 select-none items-center justify-center gap-1 rounded-sm bg-muted px-1 font-sans text-xs font-medium text-muted-foreground",
+      "[&_svg:not([class*='size-'])]:size-3",
+      "[[data-slot=tooltip-content]_&]:bg-background/20 [[data-slot=tooltip-content]_&]:text-background",
+      className
+    ),
+    ...props
+  }
+));
+Kbd.displayName = "Kbd";
+var KbdGroup = React__namespace.forwardRef(({ className, ...props }, ref) => /* @__PURE__ */ jsxRuntime.jsx("kbd", { ref, "data-slot": "kbd-group", className: utils.cn("inline-flex items-center gap-1", className), ...props }));
+KbdGroup.displayName = "KbdGroup";
+
+exports.Kbd = Kbd;
+exports.KbdGroup = KbdGroup;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.tsx"],"names":["React","jsx","cn"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAWO,IAAM,GAAA,GAAYA,4BAAkC,CAAC,EAAE,WAAW,GAAG,KAAA,IAAS,GAAA,qBACnFC,cAAA;AAAA,EAAC,KAAA;AAAA,EAAA;AAAA,IACC,GAAA;AAAA,IACA,WAAA,EAAU,KAAA;AAAA,IACV,SAAA,EAAWC,QAAA;AAAA,MACT,8KAAA;AAAA,MACA,sCAAA;AAAA,MACA,kGAAA;AAAA,MACA;AAAA,KACF;AAAA,IACC,GAAG;AAAA;AACN,CACD;AACD,GAAA,CAAI,WAAA,GAAc,KAAA;AASX,IAAM,QAAA,GAAiBF,4BAAuC,CAAC,EAAE,WAAW,GAAG,KAAA,IAAS,GAAA,qBAC7FC,cAAA,CAAC,SAAI,GAAA,EAAU,WAAA,EAAU,aAAY,SAAA,EAAWC,QAAA,CAAG,kCAAkC,SAAS,CAAA,EAAI,GAAG,KAAA,EAAO,CAC7G;AACD,QAAA,CAAS,WAAA,GAAc,UAAA","file":"index.cjs","sourcesContent":["import * as React from \"react\";\nimport { cn } from \"@nucleux/utils\";\n\nexport type KbdProps = React.HTMLAttributes<HTMLElement>;\n\n/**\n * A single keyboard key, e.g. `<Kbd>⌘</Kbd>` or `<Kbd>Enter</Kbd>`. Renders a\n * semantic `<kbd>` in a small muted keycap; icons inside are sized to 12px.\n * Inside a tooltip it switches to a translucent keycap that reads on the\n * inverted tooltip surface. Combine several keys with KbdGroup.\n */\nexport const Kbd = React.forwardRef<HTMLElement, KbdProps>(({ className, ...props }, ref) => (\n  <kbd\n    ref={ref}\n    data-slot=\"kbd\"\n    className={cn(\n      \"pointer-events-none inline-flex h-5 w-fit min-w-5 select-none items-center justify-center gap-1 rounded-sm bg-muted px-1 font-sans text-xs font-medium text-muted-foreground\",\n      \"[&_svg:not([class*='size-'])]:size-3\",\n      \"[[data-slot=tooltip-content]_&]:bg-background/20 [[data-slot=tooltip-content]_&]:text-background\",\n      className,\n    )}\n    {...props}\n  />\n));\nKbd.displayName = \"Kbd\";\n\nexport type KbdGroupProps = React.HTMLAttributes<HTMLElement>;\n\n/**\n * Groups several Kbd keys into one shortcut, e.g. `⌘ + K`. Renders an outer\n * `<kbd>` (the HTML pattern for a key combination) laid out inline with a\n * small gap; put separators such as \"+\" or \"then\" between the keys as text.\n */\nexport const KbdGroup = React.forwardRef<HTMLElement, KbdGroupProps>(({ className, ...props }, ref) => (\n  <kbd ref={ref} data-slot=\"kbd-group\" className={cn(\"inline-flex items-center gap-1\", className)} {...props} />\n));\nKbdGroup.displayName = \"KbdGroup\";\n"]}

package/dist/index.d.cts

@@ -0,0 +1,19 @@
+import * as React from 'react';
+
+type KbdProps = React.HTMLAttributes<HTMLElement>;
+/**
+ * A single keyboard key, e.g. `<Kbd>⌘</Kbd>` or `<Kbd>Enter</Kbd>`. Renders a
+ * semantic `<kbd>` in a small muted keycap; icons inside are sized to 12px.
+ * Inside a tooltip it switches to a translucent keycap that reads on the
+ * inverted tooltip surface. Combine several keys with KbdGroup.
+ */
+declare const Kbd: React.ForwardRefExoticComponent<KbdProps & React.RefAttributes<HTMLElement>>;
+type KbdGroupProps = React.HTMLAttributes<HTMLElement>;
+/**
+ * Groups several Kbd keys into one shortcut, e.g. `⌘ + K`. Renders an outer
+ * `<kbd>` (the HTML pattern for a key combination) laid out inline with a
+ * small gap; put separators such as "+" or "then" between the keys as text.
+ */
+declare const KbdGroup: React.ForwardRefExoticComponent<KbdGroupProps & React.RefAttributes<HTMLElement>>;
+
+export { Kbd, KbdGroup, type KbdGroupProps, type KbdProps };

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import * as React from 'react';
+
+type KbdProps = React.HTMLAttributes<HTMLElement>;
+/**
+ * A single keyboard key, e.g. `<Kbd>⌘</Kbd>` or `<Kbd>Enter</Kbd>`. Renders a
+ * semantic `<kbd>` in a small muted keycap; icons inside are sized to 12px.
+ * Inside a tooltip it switches to a translucent keycap that reads on the
+ * inverted tooltip surface. Combine several keys with KbdGroup.
+ */
+declare const Kbd: React.ForwardRefExoticComponent<KbdProps & React.RefAttributes<HTMLElement>>;
+type KbdGroupProps = React.HTMLAttributes<HTMLElement>;
+/**
+ * Groups several Kbd keys into one shortcut, e.g. `⌘ + K`. Renders an outer
+ * `<kbd>` (the HTML pattern for a key combination) laid out inline with a
+ * small gap; put separators such as "+" or "then" between the keys as text.
+ */
+declare const KbdGroup: React.ForwardRefExoticComponent<KbdGroupProps & React.RefAttributes<HTMLElement>>;
+
+export { Kbd, KbdGroup, type KbdGroupProps, type KbdProps };

package/dist/index.js

@@ -0,0 +1,27 @@
+"use client";
+import * as React from 'react';
+import { cn } from '@nucleux/utils';
+import { jsx } from 'react/jsx-runtime';
+
+// src/index.tsx
+var Kbd = React.forwardRef(({ className, ...props }, ref) => /* @__PURE__ */ jsx(
+  "kbd",
+  {
+    ref,
+    "data-slot": "kbd",
+    className: cn(
+      "pointer-events-none inline-flex h-5 w-fit min-w-5 select-none items-center justify-center gap-1 rounded-sm bg-muted px-1 font-sans text-xs font-medium text-muted-foreground",
+      "[&_svg:not([class*='size-'])]:size-3",
+      "[[data-slot=tooltip-content]_&]:bg-background/20 [[data-slot=tooltip-content]_&]:text-background",
+      className
+    ),
+    ...props
+  }
+));
+Kbd.displayName = "Kbd";
+var KbdGroup = React.forwardRef(({ className, ...props }, ref) => /* @__PURE__ */ jsx("kbd", { ref, "data-slot": "kbd-group", className: cn("inline-flex items-center gap-1", className), ...props }));
+KbdGroup.displayName = "KbdGroup";
+
+export { Kbd, KbdGroup };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.tsx"],"names":[],"mappings":";;;;;AAWO,IAAM,GAAA,GAAY,iBAAkC,CAAC,EAAE,WAAW,GAAG,KAAA,IAAS,GAAA,qBACnF,GAAA;AAAA,EAAC,KAAA;AAAA,EAAA;AAAA,IACC,GAAA;AAAA,IACA,WAAA,EAAU,KAAA;AAAA,IACV,SAAA,EAAW,EAAA;AAAA,MACT,8KAAA;AAAA,MACA,sCAAA;AAAA,MACA,kGAAA;AAAA,MACA;AAAA,KACF;AAAA,IACC,GAAG;AAAA;AACN,CACD;AACD,GAAA,CAAI,WAAA,GAAc,KAAA;AASX,IAAM,QAAA,GAAiB,iBAAuC,CAAC,EAAE,WAAW,GAAG,KAAA,IAAS,GAAA,qBAC7F,GAAA,CAAC,SAAI,GAAA,EAAU,WAAA,EAAU,aAAY,SAAA,EAAW,EAAA,CAAG,kCAAkC,SAAS,CAAA,EAAI,GAAG,KAAA,EAAO,CAC7G;AACD,QAAA,CAAS,WAAA,GAAc,UAAA","file":"index.js","sourcesContent":["import * as React from \"react\";\nimport { cn } from \"@nucleux/utils\";\n\nexport type KbdProps = React.HTMLAttributes<HTMLElement>;\n\n/**\n * A single keyboard key, e.g. `<Kbd>⌘</Kbd>` or `<Kbd>Enter</Kbd>`. Renders a\n * semantic `<kbd>` in a small muted keycap; icons inside are sized to 12px.\n * Inside a tooltip it switches to a translucent keycap that reads on the\n * inverted tooltip surface. Combine several keys with KbdGroup.\n */\nexport const Kbd = React.forwardRef<HTMLElement, KbdProps>(({ className, ...props }, ref) => (\n  <kbd\n    ref={ref}\n    data-slot=\"kbd\"\n    className={cn(\n      \"pointer-events-none inline-flex h-5 w-fit min-w-5 select-none items-center justify-center gap-1 rounded-sm bg-muted px-1 font-sans text-xs font-medium text-muted-foreground\",\n      \"[&_svg:not([class*='size-'])]:size-3\",\n      \"[[data-slot=tooltip-content]_&]:bg-background/20 [[data-slot=tooltip-content]_&]:text-background\",\n      className,\n    )}\n    {...props}\n  />\n));\nKbd.displayName = \"Kbd\";\n\nexport type KbdGroupProps = React.HTMLAttributes<HTMLElement>;\n\n/**\n * Groups several Kbd keys into one shortcut, e.g. `⌘ + K`. Renders an outer\n * `<kbd>` (the HTML pattern for a key combination) laid out inline with a\n * small gap; put separators such as \"+\" or \"then\" between the keys as text.\n */\nexport const KbdGroup = React.forwardRef<HTMLElement, KbdGroupProps>(({ className, ...props }, ref) => (\n  <kbd ref={ref} data-slot=\"kbd-group\" className={cn(\"inline-flex items-center gap-1\", className)} {...props} />\n));\nKbdGroup.displayName = \"KbdGroup\";\n"]}

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@nucleux/kbd",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.7.0",
+  "type": "module",
+  "sideEffects": false,
+  "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",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "dependencies": {
+    "@nucleux/utils": "0.7.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "@types/react": "^18.3.18",
+    "react": "^18.3.1",
+    "lucide-react": "^0.469.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/intelligaia-open-labs/nucleux.git",
+    "directory": "packages/kbd"
+  },
+  "homepage": "https://github.com/intelligaia-open-labs/nucleux#readme",
+  "description": "Keyboard key and shortcut display — Nucleux agentic UI for React.",
+  "keywords": [
+    "nucleux",
+    "react",
+    "ui",
+    "components",
+    "agentic",
+    "ai",
+    "tailwind",
+    "kbd"
+  ],
+  "scripts": {
+    "build": "tsup"
+  }
 }