Search

Search documentation

Item

A composable component for displaying items in a list or grid.

Installation

pnpm dlx shadcn@latest add @evolphin/item

Usage

import {
  Item,
  ItemActions,
  ItemContent,
  ItemDescription,
  ItemTitle,
} from "@/components/ui/item";
<Item>
  <ItemContent>
    <ItemTitle>Item Title</ItemTitle>
    <ItemDescription>Item Description</ItemDescription>
  </ItemContent>
</Item>

Type Definitions

interface ItemProps {
  /** The visual style of the item */
  variant?: "default" | "outline" | "muted";
ItemProps.variant?: "default" | "outline" | "muted" | undefined

The visual style of the item

/** The size of the item */ ?: "default" | "sm"; } interface ItemMediaProps { /** The visual style of the media container */ ?: "default" | "icon" | "image"; }

Examples

Default

Jane Doe

Software Engineer

List Group

General

System settings and preferences

Account

Manage your account

Order #1234
Pending

2 items • $120.00

API Reference

Item

PropTypeDefaultDescription
variant`"default" \"outline" \"muted"`
size`"default" \"sm"`"default"
asChildbooleanfalseChange the component to the HTML tag or custom component of the only child.
classNamestring-Additional CSS classes

ItemMedia

PropTypeDefaultDescription
variant`"default" \"icon" \"image"`
classNamestring-Additional CSS classes

ItemContent

PropTypeDefaultDescription
classNamestring-Additional CSS classes

ItemActions

PropTypeDefaultDescription
classNamestring-Additional CSS classes

ItemTitle

PropTypeDefaultDescription
classNamestring-Additional CSS classes

ItemDescription

PropTypeDefaultDescription
classNamestring-Additional CSS classes

ItemGroup

PropTypeDefaultDescription
classNamestring-Additional CSS classes

ItemSeparator

PropTypeDefaultDescription
classNamestring-Additional CSS classes

On this page