Skip to content
WebJs
Menu

Used to display textual user input from keyboard.

⌘ ⇧ ⌥ ⌃ Ctrl + B
import { html } from '@webjsdev/core';
import { kbdClass, kbdGroupClass } from '#components/ui/kbd.ts';

export default function KbdDemo() {
  return html`
    <div class="flex flex-col items-center gap-4">
      <kbd data-slot="kbd-group" role="img" aria-label="Command Shift Option Control" class=${kbdGroupClass()}>
        <kbd data-slot="kbd" class=${kbdClass()}>⌘</kbd>
        <kbd data-slot="kbd" class=${kbdClass()}>⇧</kbd>
        <kbd data-slot="kbd" class=${kbdClass()}>⌥</kbd>
        <kbd data-slot="kbd" class=${kbdClass()}>⌃</kbd>
      </kbd>
      <kbd data-slot="kbd-group" role="img" aria-label="Control plus B" class=${kbdGroupClass()}>
        <kbd data-slot="kbd" class=${kbdClass()}>Ctrl</kbd>
        <span>+</span>
        <kbd data-slot="kbd" class=${kbdClass()}>B</kbd>
      </kbd>
    </div>
  `;
}
View Code

Installation

pnpm dlx @webjsdev/ui add kbd

Usage

import { kbdClass, kbdGroupClass } from '#components/ui/kbd.ts';
<kbd data-slot="kbd" class=${kbdClass()}>Ctrl</kbd>

Composition

Use the following composition to build kbdClass and kbdGroupClass:

kbdClass
kbdGroupClass
├── kbdClass
└── kbdClass

Group

Use kbdGroupClass() to group keyboard keys together.

Use Ctrl + B Ctrl + K to open the command palette

import { html } from '@webjsdev/core';
import { kbdClass, kbdGroupClass } from '#components/ui/kbd.ts';

export default function KbdGroupExample() {
  return html`
    <div class="flex flex-col items-center gap-4">
      <p class="text-sm text-muted-foreground">
        Use${' '}
        <kbd data-slot="kbd-group" class=${kbdGroupClass()}>
          <kbd data-slot="kbd" class=${kbdClass()}>Ctrl + B</kbd>
          <kbd data-slot="kbd" class=${kbdClass()}>Ctrl + K</kbd>
        </kbd>${' '}
        to open the command palette
      </p>
    </div>
  `;
}
View Code

Button

Put a kbdClass() key inside a button to display a keyboard key inside the button.

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';
import { kbdClass } from '#components/ui/kbd.ts';

export default function KbdButton() {
  return html`
    <button type="button" data-slot="button" data-variant="outline" data-size="default" class=${buttonClass({ variant: 'outline' })}>
      Accept${' '}
      <kbd data-slot="kbd" data-icon="inline-end" class=${cn(kbdClass(), 'translate-x-0.5')}><span aria-hidden="true">⏎</span><span class="sr-only">Enter</span></kbd>
    </button>
  `;
}
View Code

Tooltip

You can put a key inside <ui-tooltip-content> to display a tooltip with a keyboard key.

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';
import { buttonGroupClass } from '#components/ui/button-group.ts';
import { kbdClass, kbdGroupClass } from '#components/ui/kbd.ts';

// Each button sits inside its <ui-tooltip>, so the group's direct-child
// selectors land on the tooltip hosts; the buttons square their own joined
// corners instead.
export default function KbdTooltip() {
  return html`
    <div class="flex flex-wrap gap-4">
      <div role="group" data-slot="button-group" data-orientation="horizontal" class=${buttonGroupClass()}>
        <ui-tooltip>
          <ui-tooltip-trigger>
            <button type="button" data-slot="button" data-variant="outline" data-size="default" class=${cn(buttonClass({ variant: 'outline' }), 'rounded-e-none')}>Save</button>
          </ui-tooltip-trigger>
          <ui-tooltip-content>
            Save Changes <kbd data-slot="kbd" class=${kbdClass()}>S</kbd>
          </ui-tooltip-content>
        </ui-tooltip>
        <ui-tooltip>
          <ui-tooltip-trigger>
            <button type="button" data-slot="button" data-variant="outline" data-size="default" class=${cn(buttonClass({ variant: 'outline' }), 'rounded-s-none border-s-0')}>Print</button>
          </ui-tooltip-trigger>
          <ui-tooltip-content>
            Print Document${' '}
            <kbd data-slot="kbd-group" role="img" aria-label="Control plus P" class=${kbdGroupClass()}>
              <kbd data-slot="kbd" class=${kbdClass()}>Ctrl</kbd>
              <kbd data-slot="kbd" class=${kbdClass()}>P</kbd>
            </kbd>
          </ui-tooltip-content>
        </ui-tooltip>
      </div>
    </div>
  `;
}
View Code

Input Group

You can put a key inside an input group addon to display a keyboard key inside an input group.

import { html } from '@webjsdev/core';
import {
  inputGroupClass, inputGroupAddonClass, inputGroupInputClass,
} from '#components/ui/input-group.ts';
import { kbdClass } from '#components/ui/kbd.ts';
import { SearchIcon } from '#lib/ui/lucide.ts';

export default function KbdInputGroup() {
  return html`
    <div class="flex w-full max-w-xs flex-col gap-6">
      <div data-slot="input-group" role="group" class=${inputGroupClass()}>
        <input data-slot="input-group-control" id="kbd-input-group" placeholder="Search..." aria-label="Search" class=${inputGroupInputClass()}>
        <label data-slot="input-group-addon" data-align="inline-start" for="kbd-input-group" class=${inputGroupAddonClass()}>
          ${SearchIcon()}
        </label>
        <label data-slot="input-group-addon" data-align="inline-end" for="kbd-input-group" class=${inputGroupAddonClass({ align: 'inline-end' })}>
          <kbd data-slot="kbd" class=${kbdClass()}><span aria-hidden="true">⌘</span><span class="sr-only">Command</span></kbd>
          <kbd data-slot="kbd" class=${kbdClass()}>K</kbd>
        </label>
      </div>
    </div>
  `;
}
View Code

RTL

To enable RTL support, see the RTL configuration guide.

⌘ ⇧ ⌥ ⌃ Ctrl + B
import { html } from '@webjsdev/core';
import { kbdClass, kbdGroupClass } from '#components/ui/kbd.ts';

const translations = {
  en: { dir: 'ltr' },
  ar: { dir: 'rtl' },
  he: { dir: 'rtl' },
};

export default function KbdRtl() {
  const lang = 'ar';
  const { dir } = translations[lang];

  return html`
    <div class="flex flex-col items-center gap-4" dir=${dir} lang=${lang}>
      <kbd data-slot="kbd-group" role="img" aria-label="Command Shift Option Control" class=${kbdGroupClass()}>
        <kbd data-slot="kbd" class=${kbdClass()}>⌘</kbd>
        <kbd data-slot="kbd" class=${kbdClass()}>⇧</kbd>
        <kbd data-slot="kbd" class=${kbdClass()}>⌥</kbd>
        <kbd data-slot="kbd" class=${kbdClass()}>⌃</kbd>
      </kbd>
      <kbd data-slot="kbd-group" role="img" aria-label="Control plus B" class=${kbdGroupClass()}>
        <kbd data-slot="kbd" class=${kbdClass()}>Ctrl</kbd>
        <span>+</span>
        <kbd data-slot="kbd" class=${kbdClass()}>B</kbd>
      </kbd>
    </div>
  `;
}
View Code

API Reference

kbdClass

Use kbdClass() on a native <kbd> element to display a keyboard key. It takes no options; merge your own classes with cn().

A key shown only as a symbol needs a spoken name. Do not put aria-label on the <kbd>, which browsers ignore there. Hide the glyph with aria-hidden="true" and add the spoken form in an sr-only sibling.

<kbd data-slot="kbd" class=${kbdClass()}>Ctrl</kbd>
<kbd data-slot="kbd" class=${kbdClass()}>
  <span aria-hidden="true">⌘</span><span class="sr-only">Command</span>
</kbd>

kbdGroupClass

Use kbdGroupClass() to group keys together. To name a chord, give the group role="img" and an aria-label for the whole chord, so it is announced once as one thing.

<kbd data-slot="kbd-group" role="img" aria-label="Control plus B" class=${kbdGroupClass()}>
  <kbd data-slot="kbd" class=${kbdClass()}>Ctrl</kbd>
  <kbd data-slot="kbd" class=${kbdClass()}>B</kbd>
</kbd>