@nordcom/nordstar-kbd 0.0.75
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.
- package/LICENSE +23 -0
- package/README.md +12 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2 -0
- package/dist/kbd.d.ts +27 -0
- package/dist/kbd.d.ts.map +1 -0
- package/dist/kbd.js +42 -0
- package/package.json +82 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023-2026 Filiph Sandström <filfat@hotmail.se>
|
|
4
|
+
Copyright (c) 2023-2024 Nordcom AB <opensource@nordcom.io>
|
|
5
|
+
Copyright (c) 2020 Junior Garcia (Next UI)
|
|
6
|
+
|
|
7
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
8
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
9
|
+
in the Software without restriction, including without limitation the rights
|
|
10
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
11
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
12
|
+
furnished to do so, subject to the following conditions:
|
|
13
|
+
|
|
14
|
+
The above copyright notice and this permission notice shall be included in all
|
|
15
|
+
copies or substantial portions of the Software.
|
|
16
|
+
|
|
17
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
18
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
19
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
20
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
21
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
22
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
23
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# [@nordcom/nordstar-kbd](https://nordcominc.github.io/nordstar/docs/components/kbd/?utm_source=nordstar&utm_campaign=oss)
|
|
2
|
+
|
|
3
|
+
A thin rule that divides content visually or semantically.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
> [!TIP]
|
|
8
|
+
> This is an internal package and should probably not be installed by itself, but rather come as a dependency of `@nordcom/nordstar`.
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
npm install @nordcom/nordstar-kbd
|
|
12
|
+
```
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;AAExB,YAAY,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEtC,OAAO,EAAE,GAAG,EAAE,CAAC"}
|
package/dist/index.js
ADDED
package/dist/kbd.d.ts
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { As, InternalForwardRefRenderFunction } from '../../../core/system';
|
|
2
|
+
export type KbdProps = {
|
|
3
|
+
as?: As;
|
|
4
|
+
/** Size of the key chip. Defaults to `'md'`. */
|
|
5
|
+
size?: 'sm' | 'md';
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* `<Kbd/>`, a keyboard-key indicator for documenting shortcuts.
|
|
9
|
+
*
|
|
10
|
+
* Renders a real `<kbd>` element by default so the markup is semantically a keyboard input
|
|
11
|
+
* and assistive tech announces it as such. The chip mirrors Nordstar's bordered, high-contrast
|
|
12
|
+
* surface language; pass `size` to fit it inline with surrounding text or in denser menus.
|
|
13
|
+
*
|
|
14
|
+
* @param {object} props - `<Kbd/>` props.
|
|
15
|
+
* @param {As} [props.as='kbd'] - The element to render the component as.
|
|
16
|
+
* @param {'sm' | 'md'} [props.size='md'] - The chip size.
|
|
17
|
+
* @returns {React.ReactNode} The `<Kbd/>` component.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```tsx
|
|
21
|
+
* <Kbd>⌘K</Kbd>
|
|
22
|
+
* <Kbd size="sm">Esc</Kbd>
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
declare const Kbd: InternalForwardRefRenderFunction<"kbd", KbdProps, never>;
|
|
26
|
+
export default Kbd;
|
|
27
|
+
//# sourceMappingURL=kbd.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"kbd.d.ts","sourceRoot":"","sources":["../src/kbd.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAqBnD,MAAM,MAAM,QAAQ,GAAG;IACnB,EAAE,CAAC,EAAE,EAAE,CAAC;IAER,gDAAgD;IAChD,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,QAAA,MAAM,GAAG,6FAEP,CAAC;AAIH,eAAe,GAAG,CAAC"}
|
package/dist/kbd.js
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { cn, forwardRef } from "@nordcom/nordstar-system";
|
|
2
|
+
import { cva } from "class-variance-authority";
|
|
3
|
+
import { jsx } from "react/jsx-runtime";
|
|
4
|
+
//#region src/kbd.tsx
|
|
5
|
+
var variants = cva(cn("inline-flex select-none items-center justify-center gap-1 rounded-sm border-2 border-foreground-highlight border-solid bg-background-highlight text-center font-mono font-semibold text-foreground leading-none"), {
|
|
6
|
+
defaultVariants: { size: "md" },
|
|
7
|
+
variants: { size: {
|
|
8
|
+
md: "h-6 min-w-6 px-1.5 text-xs",
|
|
9
|
+
sm: "h-5 min-w-5 px-1 text-[0.625rem]"
|
|
10
|
+
} }
|
|
11
|
+
});
|
|
12
|
+
/**
|
|
13
|
+
* `<Kbd/>`, a keyboard-key indicator for documenting shortcuts.
|
|
14
|
+
*
|
|
15
|
+
* Renders a real `<kbd>` element by default so the markup is semantically a keyboard input
|
|
16
|
+
* and assistive tech announces it as such. The chip mirrors Nordstar's bordered, high-contrast
|
|
17
|
+
* surface language; pass `size` to fit it inline with surrounding text or in denser menus.
|
|
18
|
+
*
|
|
19
|
+
* @param {object} props - `<Kbd/>` props.
|
|
20
|
+
* @param {As} [props.as='kbd'] - The element to render the component as.
|
|
21
|
+
* @param {'sm' | 'md'} [props.size='md'] - The chip size.
|
|
22
|
+
* @returns {React.ReactNode} The `<Kbd/>` component.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```tsx
|
|
26
|
+
* <Kbd>⌘K</Kbd>
|
|
27
|
+
* <Kbd size="sm">Esc</Kbd>
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
var Kbd = forwardRef(({ as: Tag = "kbd", size = "md", className, ...props }, ref) => {
|
|
31
|
+
return /* @__PURE__ */ jsx(Tag, {
|
|
32
|
+
className: cn(variants({ size }), className),
|
|
33
|
+
"data-size": size,
|
|
34
|
+
ref,
|
|
35
|
+
...props
|
|
36
|
+
});
|
|
37
|
+
});
|
|
38
|
+
Kbd.displayName = "Nordstar.Kbd";
|
|
39
|
+
//#endregion
|
|
40
|
+
export { Kbd as default };
|
|
41
|
+
|
|
42
|
+
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2JkLmpzIiwibmFtZXMiOltdLCJzb3VyY2VzIjpbIi4uL3NyYy9rYmQudHN4Il0sInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgQXMgfSBmcm9tICdAbm9yZGNvbS9ub3Jkc3Rhci1zeXN0ZW0nO1xuaW1wb3J0IHsgY24sIGZvcndhcmRSZWYgfSBmcm9tICdAbm9yZGNvbS9ub3Jkc3Rhci1zeXN0ZW0nO1xuaW1wb3J0IHsgY3ZhIH0gZnJvbSAnY2xhc3MtdmFyaWFuY2UtYXV0aG9yaXR5JztcblxuY29uc3QgdmFyaWFudHMgPSBjdmEoXG4gICAgY24oXG4gICAgICAgICdpbmxpbmUtZmxleCBzZWxlY3Qtbm9uZSBpdGVtcy1jZW50ZXIganVzdGlmeS1jZW50ZXIgZ2FwLTEgcm91bmRlZC1zbSBib3JkZXItMiBib3JkZXItZm9yZWdyb3VuZC1oaWdobGlnaHQgYm9yZGVyLXNvbGlkIGJnLWJhY2tncm91bmQtaGlnaGxpZ2h0IHRleHQtY2VudGVyIGZvbnQtbW9ubyBmb250LXNlbWlib2xkIHRleHQtZm9yZWdyb3VuZCBsZWFkaW5nLW5vbmUnLFxuICAgICksXG4gICAge1xuICAgICAgICBkZWZhdWx0VmFyaWFudHM6IHtcbiAgICAgICAgICAgIHNpemU6ICdtZCcsXG4gICAgICAgIH0sXG4gICAgICAgIHZhcmlhbnRzOiB7XG4gICAgICAgICAgICBzaXplOiB7XG4gICAgICAgICAgICAgICAgbWQ6ICdoLTYgbWluLXctNiBweC0xLjUgdGV4dC14cycsXG4gICAgICAgICAgICAgICAgc206ICdoLTUgbWluLXctNSBweC0xIHRleHQtWzAuNjI1cmVtXScsXG4gICAgICAgICAgICB9LFxuICAgICAgICB9LFxuICAgIH0sXG4pO1xuXG5leHBvcnQgdHlwZSBLYmRQcm9wcyA9IHtcbiAgICBhcz86IEFzO1xuXG4gICAgLyoqIFNpemUgb2YgdGhlIGtleSBjaGlwLiBEZWZhdWx0cyB0byBgJ21kJ2AuICovXG4gICAgc2l6ZT86ICdzbScgfCAnbWQnO1xufTtcblxuLyoqXG4gKiBgPEtiZC8+YCwgYSBrZXlib2FyZC1rZXkgaW5kaWNhdG9yIGZvciBkb2N1bWVudGluZyBzaG9ydGN1dHMuXG4gKlxuICogUmVuZGVycyBhIHJlYWwgYDxrYmQ+YCBlbGVtZW50IGJ5IGRlZmF1bHQgc28gdGhlIG1hcmt1cCBpcyBzZW1hbnRpY2FsbHkgYSBrZXlib2FyZCBpbnB1dFxuICogYW5kIGFzc2lzdGl2ZSB0ZWNoIGFubm91bmNlcyBpdCBhcyBzdWNoLiBUaGUgY2hpcCBtaXJyb3JzIE5vcmRzdGFyJ3MgYm9yZGVyZWQsIGhpZ2gtY29udHJhc3RcbiAqIHN1cmZhY2UgbGFuZ3VhZ2U7IHBhc3MgYHNpemVgIHRvIGZpdCBpdCBpbmxpbmUgd2l0aCBzdXJyb3VuZGluZyB0ZXh0IG9yIGluIGRlbnNlciBtZW51cy5cbiAqXG4gKiBAcGFyYW0ge29iamVjdH0gcHJvcHMgLSBgPEtiZC8+YCBwcm9wcy5cbiAqIEBwYXJhbSB7QXN9IFtwcm9wcy5hcz0na2JkJ10gLSBUaGUgZWxlbWVudCB0byByZW5kZXIgdGhlIGNvbXBvbmVudCBhcy5cbiAqIEBwYXJhbSB7J3NtJyB8ICdtZCd9IFtwcm9wcy5zaXplPSdtZCddIC0gVGhlIGNoaXAgc2l6ZS5cbiAqIEByZXR1cm5zIHtSZWFjdC5SZWFjdE5vZGV9IFRoZSBgPEtiZC8+YCBjb21wb25lbnQuXG4gKlxuICogQGV4YW1wbGVcbiAqIGBgYHRzeFxuICogPEtiZD7ijJhLPC9LYmQ+XG4gKiA8S2JkIHNpemU9XCJzbVwiPkVzYzwvS2JkPlxuICogYGBgXG4gKi9cbmNvbnN0IEtiZCA9IGZvcndhcmRSZWY8J2tiZCcsIEtiZFByb3BzPigoeyBhczogVGFnID0gJ2tiZCcsIHNpemUgPSAnbWQnLCBjbGFzc05hbWUsIC4uLnByb3BzIH0sIHJlZikgPT4ge1xuICAgIHJldHVybiA8VGFnIGNsYXNzTmFtZT17Y24odmFyaWFudHMoeyBzaXplIH0pLCBjbGFzc05hbWUpfSBkYXRhLXNpemU9e3NpemV9IHJlZj17cmVmfSB7Li4ucHJvcHN9IC8+O1xufSk7XG5cbktiZC5kaXNwbGF5TmFtZSA9ICdOb3Jkc3Rhci5LYmQnO1xuXG5leHBvcnQgZGVmYXVsdCBLYmQ7XG4iXSwibWFwcGluZ3MiOiI7Ozs7QUFJQSxJQUFNLFdBQVcsSUFDYixHQUNJLGlOQUNKLEdBQ0E7Q0FDSSxpQkFBaUIsRUFDYixNQUFNLEtBQ1Y7Q0FDQSxVQUFVLEVBQ04sTUFBTTtFQUNGLElBQUk7RUFDSixJQUFJO0NBQ1IsRUFDSjtBQUNKLENBQ0o7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUEyQkEsSUFBTSxNQUFNLFlBQTZCLEVBQUUsSUFBSSxNQUFNLE9BQU8sT0FBTyxNQUFNLFdBQVcsR0FBRyxTQUFTLFFBQVE7Q0FDcEcsT0FBTyxvQkFBQyxLQUFEO0VBQUssV0FBVyxHQUFHLFNBQVMsRUFBRSxLQUFLLENBQUMsR0FBRyxTQUFTO0VBQUcsYUFBVztFQUFXO0VBQUssR0FBSTtDQUFRLENBQUE7QUFDckcsQ0FBQztBQUVELElBQUksY0FBYyJ9
|
package/package.json
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json.schemastore.org/package.json",
|
|
3
|
+
"name": "@nordcom/nordstar-kbd",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"version": "0.0.75",
|
|
6
|
+
"description": "A keyboard-key indicator for documenting shortcuts.",
|
|
7
|
+
"files": [
|
|
8
|
+
"dist",
|
|
9
|
+
"CHANGELOG.md",
|
|
10
|
+
"README.md"
|
|
11
|
+
],
|
|
12
|
+
"main": "./dist/index.js",
|
|
13
|
+
"types": "./dist/index.d.ts",
|
|
14
|
+
"exports": {
|
|
15
|
+
".": {
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"import": "./dist/index.js",
|
|
18
|
+
"default": "./dist/index.js"
|
|
19
|
+
},
|
|
20
|
+
"./package.json": "./package.json"
|
|
21
|
+
},
|
|
22
|
+
"publishConfig": {
|
|
23
|
+
"access": "public"
|
|
24
|
+
},
|
|
25
|
+
"sideEffects": false,
|
|
26
|
+
"keywords": [
|
|
27
|
+
"nordstar",
|
|
28
|
+
"nordcom",
|
|
29
|
+
"component",
|
|
30
|
+
"react",
|
|
31
|
+
"kbd",
|
|
32
|
+
"keyboard",
|
|
33
|
+
"shortcut",
|
|
34
|
+
"nordstar-kbd"
|
|
35
|
+
],
|
|
36
|
+
"author": {
|
|
37
|
+
"name": "Filiph Sandström",
|
|
38
|
+
"email": "filfat@hotmail.se",
|
|
39
|
+
"url": "https://github.com/filiphsps/"
|
|
40
|
+
},
|
|
41
|
+
"contributors": [
|
|
42
|
+
{
|
|
43
|
+
"name": "Filiph Sandström",
|
|
44
|
+
"email": "filfat@hotmail.se",
|
|
45
|
+
"url": "https://github.com/filiphsps/"
|
|
46
|
+
}
|
|
47
|
+
],
|
|
48
|
+
"repository": {
|
|
49
|
+
"type": "git",
|
|
50
|
+
"url": "git+https://github.com/NordcomInc/nordstar.git",
|
|
51
|
+
"directory": "packages/components/kbd"
|
|
52
|
+
},
|
|
53
|
+
"license": "MIT",
|
|
54
|
+
"bugs": {
|
|
55
|
+
"url": "https://github.com/NordcomInc/nordstar/issues"
|
|
56
|
+
},
|
|
57
|
+
"homepage": "https://nordcominc.github.io/nordstar/docs/components/kbd/",
|
|
58
|
+
"dependencies": {
|
|
59
|
+
"class-variance-authority": "0.7.1",
|
|
60
|
+
"@nordcom/nordstar-system": "0.0.75"
|
|
61
|
+
},
|
|
62
|
+
"peerDependencies": {
|
|
63
|
+
"react": ">=19",
|
|
64
|
+
"react-dom": ">=19"
|
|
65
|
+
},
|
|
66
|
+
"devDependencies": {
|
|
67
|
+
"@types/node": "25.9.3",
|
|
68
|
+
"@types/react": "19.2.17",
|
|
69
|
+
"@types/react-dom": "19.2.3",
|
|
70
|
+
"react": "19.2.7",
|
|
71
|
+
"react-dom": "19.2.7",
|
|
72
|
+
"typescript": "6.0.3",
|
|
73
|
+
"vite": "8.0.16",
|
|
74
|
+
"vite-plugin-dts": "5.0.2"
|
|
75
|
+
},
|
|
76
|
+
"scripts": {
|
|
77
|
+
"build": "tsc && vite build",
|
|
78
|
+
"dev": "vite build --watch",
|
|
79
|
+
"clean": "rm -rf dist coverage .turbo .next *.tsbuildinfo *.log",
|
|
80
|
+
"typecheck": "tsc --noEmit"
|
|
81
|
+
}
|
|
82
|
+
}
|