# Item · JGuang UI

> A versatile component for displaying content with media, title, description, and actions.

- Page: https://jiguang132.com/systems/jguang-ui/docs/components/base/item
- Based on: shadcn/ui documentation (MIT) @ bc0705384b51252af26dcc65425b216bf5eb063c

> Example `item-demo`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


The `Item` component is a straightforward flex container that can house nearly any type of content. Use it to display a title, description, and actions. Group it with the `ItemGroup` component to create a list of items.

## Installation


  

**Command**


  

**Manual**


```text
Use the JGuang UI Registry URL provided on /systems/jguang-ui#install.
```


### Copy and paste the following code into your project.


[View complete source: components/ui/item.tsx](/r/jguang-ui/base/item.json)


### Update the import paths to match your project setup.


## Usage

```tsx showLineNumbers
import {
  Item,
  ItemActions,
  ItemContent,
  ItemDescription,
  ItemMedia,
  ItemTitle,
} from "@/components/ui/item"
```

```tsx showLineNumbers
<Item>
  <ItemMedia variant="icon">
    <Icon />
  </ItemMedia>
  <ItemContent>
    <ItemTitle>Title</ItemTitle>
    <ItemDescription>Description</ItemDescription>
  </ItemContent>
  <ItemActions>
    <Button>Action</Button>
  </ItemActions>
</Item>
```

## Composition

Use the following composition to build an `Item`:

```text
ItemGroup
└── Item
    ├── ItemHeader
    ├── ItemMedia
    ├── ItemContent
    │   ├── ItemTitle
    │   └── ItemDescription
    ├── ItemActions
    └── ItemFooter
```

## Item vs Field

Use `Field` if you need to display a form input such as a checkbox, input, radio, or select.

If you only need to display content such as a title, description, and actions, use `Item`.

## Variant

Use the `variant` prop to change the visual style of the item.


> Example `item-variant`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## Size

Use the `size` prop to change the size of the item. Available sizes are `default`, `sm`, and `xs`.


> Example `item-size`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## Icon

Use `ItemMedia` with `variant="icon"` to display an icon.


> Example `item-icon`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## Avatar

You can use `ItemMedia` with `variant="avatar"` to display an avatar.


> Example `item-avatar`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## Image

Use `ItemMedia` with `variant="image"` to display an image.


> Example `item-image`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## Group

Use `ItemGroup` to group related items together.


> Example `item-group`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## Header

Use `ItemHeader` to add a header above the item content.


> Example `item-header`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## Link

Use the `render` prop to render the item as a link. The hover and focus states will be applied to the anchor element.


> Example `item-link`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


```tsx showLineNumbers
<Item render={<a href="/dashboard" />}>
  <ItemMedia variant="icon">
    <HomeIcon />
  </ItemMedia>
  <ItemContent>
    <ItemTitle>Dashboard</ItemTitle>
    <ItemDescription>Overview of your account and activity.</ItemDescription>
  </ItemContent>
</Item>
```

## Dropdown


> Example `item-dropdown`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## RTL

To enable RTL support in JGuang UI, see the [RTL configuration guide](/systems/jguang-ui/docs/rtl).


> Example `item-rtl`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/item


## API Reference

### Item

The main component for displaying content with media, title, description, and actions.

| Prop      | Type                                | Default     |
| --------- | ----------------------------------- | ----------- |
| `variant` | `"default" \| "outline" \| "muted"` | `"default"` |
| `size`    | `"default" \| "sm" \| "xs"`         | `"default"` |
| `render`  | `React.ReactElement`                |             |

### ItemGroup

A container that groups related items together with consistent styling.

```tsx
<ItemGroup>
  <Item />
  <Item />
</ItemGroup>
```

### ItemSeparator

A separator between items in a group.

```tsx
<ItemGroup>
  <Item />
  <ItemSeparator />
  <Item />
</ItemGroup>
```

### ItemMedia

Use `ItemMedia` to display media content such as icons, images, or avatars.

| Prop      | Type                             | Default     |
| --------- | -------------------------------- | ----------- |
| `variant` | `"default" \| "icon" \| "image"` | `"default"` |

```tsx
<ItemMedia variant="icon">
  <Icon />
</ItemMedia>
```

```tsx
<ItemMedia variant="image">
  <img src="..." alt="..." />
</ItemMedia>
```

### ItemContent

Wraps the title and description of the item.

```tsx
<ItemContent>
  <ItemTitle>Title</ItemTitle>
  <ItemDescription>Description</ItemDescription>
</ItemContent>
```

### ItemTitle

Displays the title of the item.

```tsx
<ItemTitle>Item Title</ItemTitle>
```

### ItemDescription

Displays the description of the item.

```tsx
<ItemDescription>Item description</ItemDescription>
```

### ItemActions

Container for action buttons or other interactive elements.

```tsx
<ItemActions>
  <Button>Action</Button>
</ItemActions>
```

### ItemHeader

Displays a header above the item content.

```tsx
<Item>
  <ItemHeader>Header</ItemHeader>
  <ItemContent>...</ItemContent>
</Item>
```

### ItemFooter

Displays a footer below the item content.

```tsx
<Item>
  <ItemContent>...</ItemContent>
  <ItemFooter>Footer</ItemFooter>
</Item>
```

---

Index of all JGuang resources: https://jiguang132.com/llms.txt