Kbd

Keyboard shortcut and keycap text primitive.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Kbd } from "@tavojs/ui/kbd";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/kbd.

When to use

Use it when

Use `Kbd` for keyboard shortcut labels

Choose something else when

Avoid Kbd when replacing interactive controls with content-only components.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Kbd example

TSXCreate: src/components/examples/KbdExample1.tsx

tsximport { Kbd } from "@tavojs/ui/kbd";
import { Inline } from "@tavojs/ui";

export function KbdExample1() {
  return (
    <>
      <Inline gap="sm"><Kbd>Cmd</Kbd><Kbd>K</Kbd></Inline>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`as`	`string \| Component<Record<string, unknown>>`	—	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
`children`	`Child`	—	Visible content rendered by the component. Applies to Kbd.
`className`	`string`	—	Optional class hook for app-level styling. Applies to Kbd.
`sx`	`Sx`	—	Mobile-first responsive style overrides where supported. Applies to Kbd.

Complete TypeScript API

Import from @tavojs/ui/kbd. Published exports: Kbd, KbdProps.

`KbdProps`

Property	Type	Required	Description
`children`	`Child`	No	Visible content rendered by the component. Applies to Kbd.
`className`	`string`	No	Optional class hook for app-level styling. Applies to Kbd.
`sx`	`Sx`	No	Mobile-first responsive style overrides where supported. Applies to Kbd.
`id`	`string`	No	Inherited id attribute accepted by Kbd.
`role`	`string`	No	Inherited role attribute accepted by Kbd.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Kbd.
`title`	`string`	No	Inherited title attribute accepted by Kbd.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Kbd.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Kbd.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Kbd.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Kbd.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Kbd.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Kbd.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Kbd.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Kbd.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Kbd.
`as`	`PolymorphicAs`	No	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	The public root follows the as/component prop. Root attributes, className, style, and supported events are forwarded there.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Kbd when replacing interactive controls with content-only components.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Content components should keep meaningful text and media alternatives available to assistive technology.

Provide alt text for meaningful images.
Use semantic text variants for headings and paragraphs.
Do not hide essential content visually unless VisuallyHidden is intentional.

Component status

Contract	Current value
Maturity	stable
Category	content
Component import	`@tavojs/ui/kbd`
Explicit CSS import	`@tavojs/ui/css/kbd`
Preview	Interactive preview available on this page