Skip to main content
NetScriptdocs Search docs ⌘K v0.0.9
Browse documentation

Kbd

Native keyboard notation and grouped shortcut keys.

All components · Theme builder · Implementation source

Live preview

Open live kbd preview

Install

Shell
netscript ui:add kbd

Usage and examples

The preview runs this JSX with the installed components. Import any composed primitives from your UI directory.

TypeScript
import { useState } from 'preact/hooks';
import { Kbd } from '@app/components/ui/kbd.tsx';

export function Example() {
  const [value, setValue] = useState('standard');
  const [open, setOpen] = useState(false);
  const [notice, report] = useState('');
  return (<><div><Kbd>Ctrl+K</Kbd></div><p role="status">{notice}</p></>);
}

Props

Generated from native deno doc --json --private over the shipped implementation. Compound component props retain their owning interface; native attributes pass through where declared.

OwnerPropTypeOptionalDescription
KbdPropschildrenComponentChildrenNo
KbdPropssize"sm" | "md"Yes
KbdPropsvariant"default" | "inverse"Yes
KbdPropsclassstringYes
TypeScript
KbdProps extends Omit<JSX.HTMLAttributes<HTMLElement>, "size" | "class">

Keyboard

Presentation component; no component-specific keyboard interactions.

Tokens

Semantic contract roles: border/default, font/mono, radius/badge, size/kbd, surface/card, text/inverse, text/muted.

CSS custom properties referenced directly: --ns-border, --ns-border-width, --ns-card, --ns-font-mono, --ns-inverse-fg, --ns-muted-fg, --ns-radius-badge, --ns-space-1, --ns-text-caption.

Contract and compatibility

Accessibility pattern: native kbd notation; no keyboard interaction

  • Native kbd notation is noninteractive; Kbd.Group joins keys with decorative plus separators.

Design contract values marked planned are not implementation props. The props above describe what ships today.

Search all documentation

Type a term to search the documentation.