mirror of
https://github.com/hanzoai/shadcn.git
synced 2026-10-30 18:22:59 +00:00
zeekay
15f639161d
- Fix 3D card component demos with proper content in both default and new-york themes - Update all 170+ CLI installation commands from 'npx hanzo-ui@latest' to 'npx @hanzo/ui@latest' - Update CLAUDE.md to reflect correct package naming - Rebuild component registry with updated demos
105 lines
1.8 KiB
Plaintext
105 lines
1.8 KiB
Plaintext
---
|
|
title: Kbd
|
|
description: Used to display textual user input from keyboard.
|
|
component: true
|
|
---
|
|
|
|
<ComponentPreview name="kbd-demo" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">CLI</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx @hanzo/ui@latest add kbd
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps>
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource name="kbd" title="components/ui/kbd.tsx" />
|
|
|
|
<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 name="kbd-group" />
|
|
|
|
### Button
|
|
|
|
Use the `Kbd` component inside a `Button` component to display a keyboard key inside a button.
|
|
|
|
<ComponentPreview name="kbd-button" />
|
|
|
|
### Tooltip
|
|
|
|
You can use the `Kbd` component inside a `Tooltip` component to display a tooltip with a keyboard key.
|
|
|
|
<ComponentPreview 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 name="kbd-input-group" />
|
|
|
|
## 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>
|
|
```
|