mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-07-03 01:18:38 +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
98 lines
2.4 KiB
Plaintext
98 lines
2.4 KiB
Plaintext
---
|
|
title: Badge
|
|
description: Displays a badge or a component that looks like a badge.
|
|
base: base
|
|
component: true
|
|
---
|
|
|
|
<ComponentPreview styleName="base-nova" name="badge-demo" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add badge
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="badge"
|
|
title="components/ui/badge.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Badge } from "@/components/ui/badge"
|
|
```
|
|
|
|
```tsx
|
|
<Badge variant="default | outline | secondary | destructive">Badge</Badge>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Variants
|
|
|
|
Use the `variant` prop to change the variant of the badge.
|
|
|
|
<ComponentPreview styleName="base-nova" name="badge-variants" />
|
|
|
|
### With Icon
|
|
|
|
You can render an icon inside the badge. Use `data-icon="inline-start"` to render the icon on the left and `data-icon="inline-end"` to render the icon on the right.
|
|
|
|
<ComponentPreview styleName="base-nova" name="badge-icon" />
|
|
|
|
### With Spinner
|
|
|
|
You can render a spinner inside the badge. Remember to add the `data-icon="inline-start"` or `data-icon="inline-end"` prop to the spinner.
|
|
|
|
<ComponentPreview styleName="base-nova" name="badge-spinner" />
|
|
|
|
### Link
|
|
|
|
Use the `render` prop to render a link as a badge.
|
|
|
|
<ComponentPreview styleName="base-nova" name="badge-link" />
|
|
|
|
### Custom Colors
|
|
|
|
You can customize the colors of a badge by adding custom classes such as `bg-green-50 dark:bg-green-800` to the `Badge` component.
|
|
|
|
<ComponentPreview styleName="base-nova" name="badge-colors" />
|
|
|
|
## API Reference
|
|
|
|
### Badge
|
|
|
|
The `Badge` component displays a badge or a component that looks like a badge.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | ----------------------------------------------------------------------------- | ----------- |
|
|
| `variant` | `"default" \| "secondary" \| "destructive" \| "outline" \| "ghost" \| "link"` | `"default"` |
|
|
| `className` | `string` | - |
|