mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-30 16:14:13 +00:00
47c47eaed2
* feat: add base and radix docs * feat: transform code for display * fix * fix * fix * fix * fix * chore: remove claude files * fix * fix * fix * chore: run format:write * fix * feat: add more examples * fix * feat: add aspect-ratio * feat: add avatar * feat: add badge * feat: add breadcrumb * fix * feat: add button * fix * fix * fix * feat: add calendar and card * feat: add carousel * fix: chart * feat: add checkbox * feat: add collapsible * feat: add combobox * feat: add command * feat: add context menu * feat: add data-table dialog and drawer * feat: dropdown-menu * feat: add date-picker * feat: add empty * feat: add field and hover-card * fix: input * feat: add input * feat: add input-group * feat: add input-otp * feat: add item * feat: add kbd and label * feat: add menubar * feat: add native-select * feat: add more components * feat: more components * feat: more components * feat: add skeleton, slider and sonner * feat: add spinner and switch * feat: add more components * fix: tabs * fix: tabs * feat: add docs for sidebar * fix * fix * fi * docs: update * fix: create page * fix * fix * chore: add changelog * fix
110 lines
2.0 KiB
Plaintext
110 lines
2.0 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" />
|
|
|
|
## 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>
|
|
```
|