mirror of
https://github.com/hanzoai/shadcn.git
synced 2026-10-30 18:22:59 +00:00
zeekay
16c4453cc1
Squash merge of shadcn-ui/ui main branch into hanzo/ui, bringing in: - [email protected] through [email protected] releases - New apps/v4 directory structure - Registry system improvements and MCP server - Framework support (Vue, Svelte, React Native) - New templates (vite-app, monorepo-next, laravel) - Zod 4 compatibility (scoped override for zod@>4) - Test fixture corrections for alias resolution All 867 merge conflicts resolved preserving Hanzo customizations. 1020/1020 shadcn tests pass.
116 lines
2.1 KiB
Plaintext
116 lines
2.1 KiB
Plaintext
---
|
|
title: Kbd
|
|
description: Used to display textual user input from keyboard.
|
|
base: base
|
|
component: true
|
|
---
|
|
|
|
<ComponentPreview styleName="base-nova" name="kbd-demo" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add kbd
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="kbd"
|
|
title="components/ui/kbd.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Kbd } from "@/components/ui/kbd"
|
|
```
|
|
|
|
```tsx
|
|
<Kbd>Ctrl</Kbd>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Group
|
|
|
|
Use the `KbdGroup` component to group keyboard keys together.
|
|
|
|
<ComponentPreview styleName="base-nova" name="kbd-group" />
|
|
|
|
### Button
|
|
|
|
Use the `Kbd` component inside a `Button` component to display a keyboard key inside a button.
|
|
|
|
<ComponentPreview styleName="base-nova" name="kbd-button" />
|
|
|
|
### Tooltip
|
|
|
|
You can use the `Kbd` component inside a `Tooltip` component to display a tooltip with a keyboard key.
|
|
|
|
<ComponentPreview styleName="base-nova" name="kbd-tooltip" />
|
|
|
|
### Input Group
|
|
|
|
You can use the `Kbd` component inside a `InputGroupAddon` component to display a keyboard key inside an input group.
|
|
|
|
<ComponentPreview styleName="base-nova" name="kbd-input-group" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="base-nova" name="kbd-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
### Kbd
|
|
|
|
Use the `Kbd` component to display a keyboard key.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | `` |
|
|
|
|
```tsx
|
|
<Kbd>Ctrl</Kbd>
|
|
```
|
|
|
|
### KbdGroup
|
|
|
|
Use the `KbdGroup` component to group `Kbd` components together.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | `` |
|
|
|
|
```tsx
|
|
<KbdGroup>
|
|
<Kbd>Ctrl</Kbd>
|
|
<Kbd>B</Kbd>
|
|
</KbdGroup>
|
|
```
|