mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-25 05:35:48 +00:00
38de7fddc2
* feat: rtl * feat * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * feat: add sidebar * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * chore: changeset * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix
171 lines
3.3 KiB
Plaintext
171 lines
3.3 KiB
Plaintext
---
|
|
title: Card
|
|
description: Displays a card with header, content, and footer.
|
|
base: base
|
|
component: true
|
|
---
|
|
|
|
<ComponentPreview
|
|
name="card-demo"
|
|
styleName="base-nova"
|
|
previewClassName="h-[30rem]"
|
|
/>
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add card
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="card"
|
|
title="components/ui/card.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
Card,
|
|
CardAction,
|
|
CardContent,
|
|
CardDescription,
|
|
CardFooter,
|
|
CardHeader,
|
|
CardTitle,
|
|
} from "@/components/ui/card"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<Card>
|
|
<CardHeader>
|
|
<CardTitle>Card Title</CardTitle>
|
|
<CardDescription>Card Description</CardDescription>
|
|
<CardAction>Card Action</CardAction>
|
|
</CardHeader>
|
|
<CardContent>
|
|
<p>Card Content</p>
|
|
</CardContent>
|
|
<CardFooter>
|
|
<p>Card Footer</p>
|
|
</CardFooter>
|
|
</Card>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Size
|
|
|
|
Use the `size="sm"` prop to set the size of the card to small. The small size variant uses smaller spacing.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="card-small"
|
|
previewClassName="h-96"
|
|
/>
|
|
|
|
### Image
|
|
|
|
Add an image before the card header to create a card with an image.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="card-image"
|
|
previewClassName="h-[32rem]"
|
|
/>
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="card-rtl"
|
|
direction="rtl"
|
|
previewClassName="h-[30rem]"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
### Card
|
|
|
|
The `Card` component is the root container for card content.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | ------------------- | ----------- |
|
|
| `size` | `"default" \| "sm"` | `"default"` |
|
|
| `className` | `string` | - |
|
|
|
|
### CardHeader
|
|
|
|
The `CardHeader` component is used for a title, description, and optional action.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | - |
|
|
|
|
### CardTitle
|
|
|
|
The `CardTitle` component is used for the card title.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | - |
|
|
|
|
### CardDescription
|
|
|
|
The `CardDescription` component is used for helper text under the title.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | - |
|
|
|
|
### CardAction
|
|
|
|
The `CardAction` component places content in the top-right of the header (for example, a button or a badge).
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | - |
|
|
|
|
### CardContent
|
|
|
|
The `CardContent` component is used for the main card body.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | - |
|
|
|
|
### CardFooter
|
|
|
|
The `CardFooter` component is used for actions and secondary content at the bottom of the card.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | - |
|