@c2n/kbd 0.0.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nguyen Thai Vinh
+
+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

@@ -0,0 +1,11 @@
+# Kbd
+
+`@c2n/kbd` provides `c2-kbd`, a semantic and themeable keyboard-key label for shortcuts and command hints.
+
+```html
+<script type="module">
+  import '@c2n/kbd'
+</script>
+
+Press <c2-kbd>Ctrl + K</c2-kbd> to search.
+```

package/dist/kbd.js

@@ -0,0 +1,25 @@
+import { LitElement, html, unsafeCSS } from "lit";
+import { customElement } from "@c2n/core/element-helper.js";
+//#region src/kbd.scss?inline
+var kbd_default = "/* ex : var((width: 24px), width, c2-checkbox)  returns var(--c2-checkbox-width, 24px) */\n:host {\n  display: inline-flex;\n  flex: none;\n  vertical-align: middle;\n}\n\n:host([hidden]) {\n  display: none;\n}\n\n.c2-kbd {\n  display: inline-flex;\n  align-items: center;\n  justify-content: center;\n  box-sizing: border-box;\n  min-width: var(--c2-kbd--min-width,24px);\n  height: var(--c2-kbd--height,24px);\n  margin: 0;\n  padding-left: var(--c2-kbd--padding-left,6px);\n  padding-right: var(--c2-kbd--padding-right,6px);\n  gap: var(--c2-kbd--gap,4px);\n  background-color: var(--c2-kbd--background-color,#f4f4f5);\n  color: var(--c2-kbd--color,#52525b);\n  border: var(--c2-kbd--border,1px solid #d4d4d8);\n  border-radius: var(--c2-kbd--border-radius,5px);\n  box-shadow: var(--c2-kbd--box-shadow,0 1px 0 #a1a1aa);\n  font-family: var(--c2-kbd--font-family,ui-monospace SFMono-Regular Menlo Monaco Consolas monospace);\n  font-size: var(--c2-kbd--font-size,12px);\n  font-weight: var(--c2-kbd--font-weight,500);\n  line-height: var(--c2-kbd--line-height,1);\n  letter-spacing: var(--c2-kbd--letter-spacing,0.01em);\n  text-transform: var(--c2-kbd--text-transform,none);\n  white-space: nowrap;\n  user-select: none;\n}";
+//#endregion
+//#region \0@oxc-project+runtime@0.148.0/helpers/esm/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+//#endregion
+//#region src/kbd.ts
+var Kbd = class Kbd extends LitElement {
+	static {
+		this.styles = unsafeCSS(kbd_default);
+	}
+	render() {
+		return html`<kbd class="c2-kbd" part="kbd"><slot></slot></kbd>`;
+	}
+};
+Kbd = __decorate([customElement("c2-kbd")], Kbd);
+//#endregion
+export { Kbd };

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@c2n/kbd",
+  "version": "0.0.7",
+  "type": "module",
+  "main": "dist/kbd.js",
+  "exports": {
+    ".": {
+      "types": "./types/src/kbd.d.ts",
+      "default": "./dist/kbd.js"
+    },
+    "./react": {
+      "types": "./react.d.ts",
+      "default": "./react.js"
+    },
+    "./vue": {
+      "types": "./vue.d.ts",
+      "default": "./vue.js"
+    },
+    "./custom-elements.json": "./custom-elements.json"
+  },
+  "files": [
+    "dist",
+    "types",
+    "react.d.ts",
+    "react.js",
+    "vue.d.ts",
+    "vue.js"
+  ],
+  "keywords": [
+    "kbd",
+    "web component",
+    "lit"
+  ],
+  "license": "MIT",
+  "author": "code2nguyen@gmail.com",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/code2nguyen/web-components.git"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "wireit",
+    "build:only": "vite build",
+    "type-check": "wireit"
+  },
+  "wireit": {
+    "type-check": {
+      "dependencies": [
+        "../../core:build"
+      ],
+      "command": "tsc -p tsconfig.lib.json --composite false"
+    },
+    "build": {
+      "dependencies": [
+        "type-check"
+      ],
+      "command": "vite build"
+    }
+  },
+  "dependencies": {
+    "@c2n/core": "0.0.7",
+    "lit": "3.3.3"
+  },
+  "devDependencies": {
+    "@c2n/config": "*"
+  },
+  "customElements": "custom-elements.json",
+  "gitHead": "c8db398a27f7cd417d665fdf5da455fee2d4e910"
+}

package/react.d.ts

@@ -0,0 +1,24 @@
+// GENERATED by @c2n/framework-types. Do not edit by hand.
+//
+// JSX types for the custom elements of @c2n/kbd. Import once, anywhere in the program:
+//
+//     import '@c2n/kbd/react'
+//
+// Register the elements at module scope before React renders, or React writes an object prop as an
+// attribute and it stringifies.
+
+import type { DetailedHTMLProps, HTMLAttributes } from 'react'
+import type { Kbd } from '@c2n/kbd'
+
+/** Standard React host-element attributes plus the element's own public properties. */
+type C2Props<T> = DetailedHTMLProps<HTMLAttributes<T>, T> & Partial<Omit<T, keyof HTMLElement>>
+
+declare module 'react' {
+  namespace JSX {
+    interface IntrinsicElements {
+      'c2-kbd': C2Props<Kbd>
+    }
+  }
+}
+
+export {}

package/react.js

@@ -0,0 +1,3 @@
+// GENERATED by @c2n/framework-types. Do not edit by hand.
+// Types only — see the matching .d.ts.
+export {}

package/types/src/kbd.d.ts

@@ -0,0 +1,38 @@
+import { LitElement } from 'lit';
+/**
+ * Displays a keyboard key or shortcut with the semantics of the native `kbd` element. Use one element for a complete
+ * shortcut (`Ctrl + K`) or place several beside descriptive text. The component is presentational and never enters the
+ * tab order; when it repeats a shortcut already announced by a surrounding control, set `aria-hidden="true"` on the
+ * host.
+ *
+ * @tag c2-kbd
+ *
+ * @slot - Key name or shortcut to display.
+ *
+ * @cssproperty {pixel} [--c2-kbd--min-width=24px]
+ * @cssproperty {pixel} [--c2-kbd--height=24px]
+ * @cssproperty {padding} [--c2-kbd--padding-left=6px]
+ * @cssproperty {padding} [--c2-kbd--padding-right=6px]
+ * @cssproperty {pixel} [--c2-kbd--gap=4px] - Space between multiple slotted nodes.
+ * @cssproperty {color} [--c2-kbd--background-color=#f4f4f5]
+ * @cssproperty {color} [--c2-kbd--color=#52525b]
+ * @cssproperty {border} [--c2-kbd--border=1px solid #d4d4d8]
+ * @cssproperty {border-radius} [--c2-kbd--border-radius=5px]
+ * @cssproperty {box-shadow} [--c2-kbd--box-shadow=0 1px 0 #a1a1aa]
+ * @cssproperty {font-family} [--c2-kbd--font-family=ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace]
+ * @cssproperty {font-size} [--c2-kbd--font-size=12px]
+ * @cssproperty {font-weight} [--c2-kbd--font-weight=500]
+ * @cssproperty {line-height} [--c2-kbd--line-height=1]
+ * @cssproperty {pixel} [--c2-kbd--letter-spacing=0.01em]
+ * @cssproperty {text-transform} [--c2-kbd--text-transform=none]
+ */
+export declare class Kbd extends LitElement {
+    static styles: import("lit").CSSResult;
+    render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'c2-kbd': Kbd;
+    }
+}
+//# sourceMappingURL=kbd.d.ts.map

package/types/src/kbd.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kbd.d.ts","sourceRoot":"","sources":["../../src/kbd.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,KAAK,CAAA;AAIjD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBACa,GAAI,SAAQ,UAAU;IACjC,OAAgB,MAAM,0BAAoB;IAEjC,MAAM;CAGhB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,QAAQ,EAAE,GAAG,CAAA;KACd;CACF"}

package/vue.d.ts

@@ -0,0 +1,29 @@
+// GENERATED by @c2n/framework-types. Do not edit by hand.
+//
+// Vue template types for the custom elements of @c2n/kbd. Import once, anywhere in the program:
+//
+//     import '@c2n/kbd/vue'
+//
+// Tell the compiler about the tags as well, or every c2-* tag is resolved as a Vue component and renders
+// nothing: template.compilerOptions.isCustomElement = (tag) => tag.startsWith('c2-') in vite.config.ts.
+
+import type { DefineComponent, HTMLAttributes } from 'vue'
+import type { Kbd } from '@c2n/kbd'
+
+/** The element's own public properties, plus every attribute Vue understands on a host element. */
+type C2Props<T> = Partial<Omit<T, keyof HTMLElement>> & HTMLAttributes
+
+declare module 'vue' {
+  interface GlobalComponents {
+    'c2-kbd': DefineComponent<C2Props<Kbd>>
+  }
+}
+
+declare module '@vue/runtime-dom' {
+  interface HTMLAttributes {
+    /** Vue's own definition omits it, and slotting a plain element into a component needs it. */
+    slot?: string
+  }
+}
+
+export {}

package/vue.js

@@ -0,0 +1,3 @@
+// GENERATED by @c2n/framework-types. Do not edit by hand.
+// Types only — see the matching .d.ts.
+export {}