Kbd

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add kbd

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update kbd

Preview

import { Box } from "@registry/components/ui/box"
import { Flex } from "@registry/components/ui/flex"
import { Kbd, KbdGroup } from "@registry/components/ui/kbd"
import { Text } from "@registry/components/ui/text"
import * as stylex from "@stylexjs/stylex"

Usage

Use Kbd for one key and KbdGroup for a shortcut sequence.

This is display-only. Register the keyboard shortcut separately and use the modifier names appropriate to the platform.

Import from the local file installed by the CLI.

"use client"

import { Kbd } from "@/components/ui/kbd"

export function Preview() {
  return (
    <p>
      Press <Kbd>Escape</Kbd> to close.
    </p>
  )
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.