A versatile component for displaying content with media, title, description, and actions.
A simple item with title and description.
import { html } from '@webjsdev/core';
import { buttonClass } from '#components/ui/button.ts';
import {
itemClass, itemActionsClass, itemContentClass, itemDescriptionClass,
itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
import { BadgeCheckIcon, ChevronRightIcon } from '#lib/ui/lucide.ts';
export default function ItemDemo() {
return html`
<div class="flex w-full max-w-md flex-col gap-6">
<div data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Basic Item</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
A simple item with title and description.
</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
<button type="button" data-slot="button" data-variant="outline" data-size="sm" class=${buttonClass({ variant: 'outline', size: 'sm' })}>
Action
</button>
</div>
</div>
<a href="#" data-slot="item" data-variant="outline" data-size="sm" class=${itemClass({ variant: 'outline', size: 'sm' })}>
<div data-slot="item-media" data-variant="default" class=${itemMediaClass()}>
${BadgeCheckIcon('size-5')}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Your profile has been verified.</div>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
${ChevronRightIcon('size-4')}
</div>
</a>
</div>
`;
}
View Code
Installation
Copy and paste the following code into your project.
/**
* Item: a flexible row for lists of things (a person, a file, a setting), with
* media, a title and description, and actions. Tier-1 class helper; compose
* with a plain element, or an `<a>` / `<button>` when the whole row acts.
*
* shadcn parity:
* ItemGroup / ItemSeparator → itemGroupClass() / itemSeparatorClass()
* Item (variant: default | outline | muted, size: default | sm | xs)
* → itemClass({ variant, size }), alias itemVariants
* ItemMedia (variant: default | icon | image)
* → itemMediaClass({ variant }), alias itemMediaVariants
* ItemContent / ItemTitle / ItemDescription / ItemActions / ItemHeader / ItemFooter
* → itemContentClass() ... itemFooterClass()
*
* Every part takes its `data-slot` (shown on each helper), which is what the
* styles use to lay the parts out relative to each other.
*
* A11y (required for accessible output): a group of items is a list, so render
* it as `<ul role="list">` with each item an `<li>`, or keep `role="list"` /
* `role="listitem"` on divs. A whole-row link is a real `<a>` holding the
* content, never a click handler on a div. Media that only decorates takes
* `alt=""` or `aria-hidden="true"`, and an icon-only action needs
* `aria-label`.
*
* Design tokens used: --border, --muted, --muted-foreground, --accent, --ring.
*
* @example
* ```html
* <div class=${itemClass({ variant: 'outline' })} data-slot="item" data-variant="outline">
* <div class=${itemContentClass()} data-slot="item-content">
* <div class=${itemTitleClass()} data-slot="item-title">Two-factor authentication</div>
* <p class=${itemDescriptionClass()} data-slot="item-description">Verify it is you with a code.</p>
* </div>
* <div class=${itemActionsClass()} data-slot="item-actions">
* <button class=${buttonClass({ variant: 'outline', size: 'sm' })} type="button">Enable</button>
* </div>
* </div>
* ```
*/
import { cn } from '../lib/utils.ts';
/** Set `data-slot="item-group"` on the element. */
export function itemGroupClass(): string {
return 'group/item-group flex w-full flex-col';
}
/**
* Set `data-slot="item-separator"` on the element. shadcn's ItemSeparator is a
* horizontal Separator, so the line's own size and colour come with it, and
* the style adds its margin.
*/
export function itemSeparatorClass(): string {
return 'my-0 h-px w-full shrink-0 bg-border';
}
const ITEM_BASE =
'rounded-md border border-transparent text-sm [a]:hover:bg-accent/50 group/item flex w-full flex-wrap items-center transition-colors duration-100 outline-none focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50 [a]:transition-colors';
const ITEM_VARIANTS = {
default: 'bg-transparent',
outline: 'border-border',
muted: 'bg-muted/50',
} as const;
const ITEM_SIZES = {
default: 'gap-4 p-4',
sm: 'gap-2.5 px-4 py-3',
xs: '',
} as const;
/** The part, with its variant options. Set its `data-slot` and any `data-variant` / `data-size` to match. */
export function itemClass(opts: { variant?: keyof typeof ITEM_VARIANTS; size?: keyof typeof ITEM_SIZES } & { className?: string } = {}): string {
return cn(ITEM_BASE, ITEM_VARIANTS[opts.variant ?? 'default'], ITEM_SIZES[opts.size ?? 'default'], opts.className);
}
/**
* shadcn's name for {@link itemClass}, so shadcn code ports verbatim. Like cva,
* it merges a `className` into the result.
*/
export function itemVariants(opts: { variant?: keyof typeof ITEM_VARIANTS; size?: keyof typeof ITEM_SIZES } & { className?: string } = {}): string {
return itemClass(opts);
}
const ITEM_MEDIA_BASE =
'gap-2 group-has-[[data-slot=item-description]]/item:translate-y-0.5 group-has-[[data-slot=item-description]]/item:self-start flex shrink-0 items-center justify-center [&_svg]:pointer-events-none';
const ITEM_MEDIA_VARIANTS = {
default: 'bg-transparent',
icon: "size-8 rounded-sm border bg-muted [&_svg:not([class*='size-'])]:size-4",
image: 'size-10 overflow-hidden rounded-sm [&_img]:size-full [&_img]:object-cover',
} as const;
/** The part, with its variant options. Set its `data-slot` and any `data-variant` / `data-size` to match. */
export function itemMediaClass(opts: { variant?: keyof typeof ITEM_MEDIA_VARIANTS } & { className?: string } = {}): string {
return cn(ITEM_MEDIA_BASE, ITEM_MEDIA_VARIANTS[opts.variant ?? 'default'], opts.className);
}
/**
* shadcn's name for {@link itemMediaClass}, so shadcn code ports verbatim. Like cva,
* it merges a `className` into the result.
*/
export function itemMediaVariants(opts: { variant?: keyof typeof ITEM_MEDIA_VARIANTS } & { className?: string } = {}): string {
return itemMediaClass(opts);
}
/** Set `data-slot="item-content"` on the element. */
export function itemContentClass(): string {
return 'gap-1 flex flex-1 flex-col [&+[data-slot=item-content]]:flex-none';
}
/** Set `data-slot="item-title"` on the element. */
export function itemTitleClass(): string {
return 'gap-2 text-sm leading-snug font-medium line-clamp-1 flex w-fit items-center';
}
/** Set `data-slot="item-description"` on the element. */
export function itemDescriptionClass(): string {
return 'text-sm leading-normal text-balance text-muted-foreground line-clamp-2 font-normal [&>a]:underline [&>a]:underline-offset-4 [&>a:hover]:text-primary';
}
/** Set `data-slot="item-actions"` on the element. */
export function itemActionsClass(): string {
return 'gap-2 flex items-center';
}
/** Set `data-slot="item-header"` on the element. */
export function itemHeaderClass(): string {
return 'gap-2 flex basis-full items-center justify-between';
}
/** Set `data-slot="item-footer"` on the element. */
export function itemFooterClass(): string {
return 'gap-2 flex basis-full items-center justify-between';
}
Update the import paths to match your project setup.
Usage
import {
itemClass,
itemActionsClass,
itemContentClass,
itemDescriptionClass,
itemMediaClass,
itemTitleClass,
} from '#components/ui/item.ts';
<div data-slot="item" class=${itemClass()}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${Icon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Title</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>Description</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
<button class=${buttonClass()}>Action</button>
</div>
</div>
Composition
Use the following composition to build an item:
itemGroupClass
└── itemClass
├── itemHeaderClass
├── itemMediaClass
├── itemContentClass
│ ├── itemTitleClass
│ └── itemDescriptionClass
├── itemActionsClass
└── itemFooterClass
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 option to change the visual style of the item.
Transparent background with no border.
Outlined style with a visible border.
Muted background for secondary content.
import { html } from '@webjsdev/core';
import {
itemClass, itemContentClass, itemDescriptionClass, itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
import { InboxIcon } from '#lib/ui/lucide.ts';
export default function ItemVariant() {
return html`
<div class="flex w-full max-w-md flex-col gap-6">
<div data-slot="item" data-variant="default" data-size="default" class=${itemClass()}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${InboxIcon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Default Variant</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
Transparent background with no border.
</p>
</div>
</div>
<div data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${InboxIcon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Outline Variant</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
Outlined style with a visible border.
</p>
</div>
</div>
<div data-slot="item" data-variant="muted" data-size="default" class=${itemClass({ variant: 'muted' })}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${InboxIcon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Muted Variant</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
Muted background for secondary content.
</p>
</div>
</div>
</div>
`;
}
View Code
Size
Use the size option to change the size of the item. Available sizes are default, sm, and xs.
The standard size for most use cases.
A compact size for dense layouts.
The most compact size available.
import { html } from '@webjsdev/core';
import {
itemClass, itemContentClass, itemDescriptionClass, itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
import { InboxIcon } from '#lib/ui/lucide.ts';
export default function ItemSizeDemo() {
return html`
<div class="flex w-full max-w-md flex-col gap-6">
<div data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${InboxIcon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Default Size</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
The standard size for most use cases.
</p>
</div>
</div>
<div data-slot="item" data-variant="outline" data-size="sm" class=${itemClass({ variant: 'outline', size: 'sm' })}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${InboxIcon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Small Size</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>A compact size for dense layouts.</p>
</div>
</div>
<div data-slot="item" data-variant="outline" data-size="xs" class=${itemClass({ variant: 'outline', size: 'xs' })}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${InboxIcon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Extra Small Size</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>The most compact size available.</p>
</div>
</div>
</div>
`;
}
View Code
Icon
Use itemMediaClass({ variant: 'icon' }) to display an icon.
New login detected from unknown device.
import { html } from '@webjsdev/core';
import { buttonClass } from '#components/ui/button.ts';
import {
itemClass, itemActionsClass, itemContentClass, itemDescriptionClass,
itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
import { ShieldAlertIcon } from '#lib/ui/lucide.ts';
export default function ItemIcon() {
return html`
<div class="flex w-full max-w-lg flex-col gap-6">
<div data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${ShieldAlertIcon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Security Alert</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
New login detected from unknown device.
</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
<button type="button" data-slot="button" data-variant="outline" data-size="sm" class=${buttonClass({ variant: 'outline', size: 'sm' })}>
Review
</button>
</div>
</div>
</div>
`;
}
View Code
Avatar
You can put an avatar inside the default itemMediaClass() media to display it.
Last seen 5 months ago
Invite your team to collaborate on this project.
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { avatarClass, avatarImageClass, avatarFallbackClass } from '#components/ui/avatar.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
itemClass, itemActionsClass, itemContentClass, itemDescriptionClass,
itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
import { Plus } from '#lib/ui/lucide.ts';
export default function ItemAvatar() {
return html`
<div class="flex w-full max-w-lg flex-col gap-6">
<div data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-media" data-variant="default" class=${itemMediaClass()}>
<span data-slot="avatar" data-size="default" class=${cn(avatarClass(), 'size-10')}>
<img data-slot="avatar-image" src="https://github.com/evilrabbit.png" alt="" class=${avatarImageClass()}>
<span data-slot="avatar-fallback" class=${avatarFallbackClass()}>ER</span>
</span>
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Evil Rabbit</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>Last seen 5 months ago</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
<button type="button" data-slot="button" data-variant="outline" data-size="icon-sm" aria-label="Invite" class=${cn(buttonClass({ variant: 'outline', size: 'icon-sm' }), 'rounded-full')}>
${Plus()}
</button>
</div>
</div>
<div data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-media" data-variant="default" class=${itemMediaClass()}>
<div class="flex -space-x-2 *:data-[slot=avatar]:ring-2 *:data-[slot=avatar]:ring-background *:data-[slot=avatar]:grayscale">
<span data-slot="avatar" data-size="default" class=${cn(avatarClass(), 'hidden sm:flex')}>
<img data-slot="avatar-image" src="/avatars/vivek.jpg" alt="@vivek" class=${avatarImageClass()}>
<span data-slot="avatar-fallback" class=${avatarFallbackClass()}>VK</span>
</span>
<span data-slot="avatar" data-size="default" class=${cn(avatarClass(), 'hidden sm:flex')}>
<img data-slot="avatar-image" src="https://github.com/maxleiter.png" alt="@maxleiter" class=${avatarImageClass()}>
<span data-slot="avatar-fallback" class=${avatarFallbackClass()}>LR</span>
</span>
<span data-slot="avatar" data-size="default" class=${avatarClass()}>
<img data-slot="avatar-image" src="https://github.com/evilrabbit.png" alt="@evilrabbit" class=${avatarImageClass()}>
<span data-slot="avatar-fallback" class=${avatarFallbackClass()}>ER</span>
</span>
</div>
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>No Team Members</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
Invite your team to collaborate on this project.
</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
<button type="button" data-slot="button" data-variant="outline" data-size="sm" class=${buttonClass({ variant: 'outline', size: 'sm' })}>
Invite
</button>
</div>
</div>
</div>
`;
}
View Code
Image
Use itemMediaClass({ variant: 'image' }) to display an image.
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import {
itemClass, itemContentClass, itemDescriptionClass, itemGroupClass,
itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
const music = [
{
title: 'Midnight City Lights',
artist: 'Neon Dreams',
album: 'Electric Nights',
duration: '3:45',
},
{
title: 'Coffee Shop Conversations',
artist: 'The Morning Brew',
album: 'Urban Stories',
duration: '4:05',
},
{
title: 'Digital Rain',
artist: 'Cyber Symphony',
album: 'Binary Beats',
duration: '3:30',
},
];
export default function ItemImage() {
return html`
<div class="flex w-full max-w-md flex-col gap-6">
<div role="list" data-slot="item-group" class=${cn(itemGroupClass(), 'gap-4')}>
${music.map((song) => html`
<a href="#" role="listitem" data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-media" data-variant="image" class=${itemMediaClass({ variant: 'image' })}>
<img src=${`https://avatar.vercel.sh/${song.title}`} alt=${song.title} width="32" height="32" class="object-cover grayscale">
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${cn(itemTitleClass(), 'line-clamp-1')}>
${song.title} -${' '}<span class="text-muted-foreground">${song.album}</span>
</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>${song.artist}</p>
</div>
<div data-slot="item-content" class=${cn(itemContentClass(), 'flex-none text-center')}>
<p data-slot="item-description" class=${itemDescriptionClass()}>${song.duration}</p>
</div>
</a>
`)}
</div>
</div>
`;
}
View Code
Group
Use itemGroupClass() to group related items together. A group is a list, so give it role="list" and each item role="listitem", or use <ul> and <li>.
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { avatarClass, avatarImageClass, avatarFallbackClass } from '#components/ui/avatar.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
itemClass, itemActionsClass, itemContentClass, itemDescriptionClass,
itemGroupClass, itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
import { PlusIcon } from '#lib/ui/lucide.ts';
const people = [
{
username: 'vivek',
avatar: '/avatars/vivek.jpg',
email: '[email protected]',
},
{
username: 'maxleiter',
avatar: 'https://github.com/maxleiter.png',
email: '[email protected]',
},
{
username: 'evilrabbit',
avatar: 'https://github.com/evilrabbit.png',
email: '[email protected]',
},
];
export default function ItemGroupExample() {
return html`
<div role="list" data-slot="item-group" class=${cn(itemGroupClass(), 'max-w-sm')}>
${people.map((person) => html`
<div role="listitem" data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-media" data-variant="default" class=${itemMediaClass()}>
<span data-slot="avatar" data-size="default" class=${avatarClass()}>
<img data-slot="avatar-image" src=${person.avatar} alt="" class=${cn(avatarImageClass(), 'grayscale')}>
<span data-slot="avatar-fallback" class=${avatarFallbackClass()}>${person.username.charAt(0)}</span>
</span>
</div>
<div data-slot="item-content" class=${cn(itemContentClass(), 'gap-1')}>
<div data-slot="item-title" class=${itemTitleClass()}>${person.username}</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>${person.email}</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
<button type="button" data-slot="button" data-variant="ghost" data-size="icon" aria-label=${`Add ${person.username}`} class=${cn(buttonClass({ variant: 'ghost', size: 'icon' }), 'rounded-full')}>
${PlusIcon()}
</button>
</div>
</div>
`)}
</div>
`;
}
View Code
Header
Use itemHeaderClass() to add a header above the item content.
Everyday tasks and UI generation.
Advanced thinking or reasoning.
Open Source model for everyone.
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import {
itemClass, itemContentClass, itemDescriptionClass, itemGroupClass,
itemHeaderClass, itemTitleClass,
} from '#components/ui/item.ts';
const models = [
{
name: 'v0-1.5-sm',
description: 'Everyday tasks and UI generation.',
image:
'https://images.unsplash.com/photo-1650804068570-7fb2e3dbf888?q=80&w=640&auto=format&fit=crop',
credit: 'Valeria Reverdo on Unsplash',
},
{
name: 'v0-1.5-lg',
description: 'Advanced thinking or reasoning.',
image:
'https://images.unsplash.com/photo-1610280777472-54133d004c8c?q=80&w=640&auto=format&fit=crop',
credit: 'Michael Oeser on Unsplash',
},
{
name: 'v0-2.0-mini',
description: 'Open Source model for everyone.',
image:
'https://images.unsplash.com/photo-1602146057681-08560aee8cde?q=80&w=640&auto=format&fit=crop',
credit: 'Cherry Laithang on Unsplash',
},
];
export default function ItemHeaderDemo() {
return html`
<div class="flex w-full max-w-xl flex-col gap-6">
<div role="list" data-slot="item-group" class=${cn(itemGroupClass(), 'grid grid-cols-3 gap-4')}>
${models.map((model) => html`
<div role="listitem" data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-header" class=${itemHeaderClass()}>
<img src=${model.image} alt=${model.name} width="128" height="128" class="aspect-square w-full rounded-sm object-cover">
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>${model.name}</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>${model.description}</p>
</div>
</div>
`)}
</div>
</div>
`;
}
View Code
Link
A class helper styles any element, so an item that is a link is an <a> with the item's classes. The hover and focus states apply to the anchor element.
import { html } from '@webjsdev/core';
import {
itemClass, itemActionsClass, itemContentClass, itemDescriptionClass, itemTitleClass,
} from '#components/ui/item.ts';
import { ChevronRightIcon, ExternalLinkIcon } from '#lib/ui/lucide.ts';
// A link that is an item is an <a> carrying the item's classes. There is no
// wrapper and no asChild.
export default function ItemLink() {
return html`
<div class="flex w-full max-w-md flex-col gap-4">
<a href="#" data-slot="item" data-variant="default" data-size="default" class=${itemClass()}>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Visit our documentation</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
Learn how to get started with our components.
</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
${ChevronRightIcon('size-4')}
</div>
</a>
<a href="#" target="_blank" rel="noopener noreferrer" data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>External resource</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>
Opens in a new tab with security attributes.
</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
${ExternalLinkIcon('size-4')}
</div>
</a>
</div>
`;
}
View Code
<a href="/dashboard" data-slot="item" class=${itemClass()}>
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${HomeIcon()}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Dashboard</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>Overview of your account and activity.</p>
</div>
</a>
Dropdown
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { avatarClass, avatarImageClass, avatarFallbackClass } from '#components/ui/avatar.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
itemClass, itemContentClass, itemDescriptionClass, itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
import { ChevronDownIcon } from '#lib/ui/lucide.ts';
const people = [
{
username: 'vivek',
avatar: '/avatars/vivek.jpg',
email: '[email protected]',
},
{
username: 'maxleiter',
avatar: 'https://github.com/maxleiter.png',
email: '[email protected]',
},
{
username: 'evilrabbit',
avatar: 'https://github.com/evilrabbit.png',
email: '[email protected]',
},
];
export default function ItemDropdown() {
return html`
<ui-dropdown-menu>
<ui-dropdown-menu-trigger>
<button type="button" data-slot="button" data-variant="outline" data-size="default" class=${buttonClass({ variant: 'outline' })}>
Select ${ChevronDownIcon()}
</button>
</ui-dropdown-menu-trigger>
<ui-dropdown-menu-content class="w-48" align="end">
<ui-dropdown-menu-group>
${people.map((person) => html`
<ui-dropdown-menu-item>
<div data-slot="item" data-variant="default" data-size="xs" class=${cn(itemClass({ size: 'xs' }), 'w-full p-2')}>
<div data-slot="item-media" data-variant="default" class=${itemMediaClass()}>
<span data-slot="avatar" data-size="default" class=${cn(avatarClass(), 'size-[--spacing(6.5)]')}>
<img data-slot="avatar-image" src=${person.avatar} alt="" class=${cn(avatarImageClass(), 'grayscale')}>
<span data-slot="avatar-fallback" class=${avatarFallbackClass()}>${person.username.charAt(0)}</span>
</span>
</div>
<div data-slot="item-content" class=${cn(itemContentClass(), 'gap-0')}>
<div data-slot="item-title" class=${itemTitleClass()}>${person.username}</div>
<p data-slot="item-description" class=${cn(itemDescriptionClass(), 'leading-none')}>${person.email}</p>
</div>
</div>
</ui-dropdown-menu-item>
`)}
</ui-dropdown-menu-group>
</ui-dropdown-menu-content>
</ui-dropdown-menu>
`;
}
View Code
RTL
To enable RTL support, see the RTL configuration guide.
عنصر بسيط يحتوي على عنوان ووصف.
import { html } from '@webjsdev/core';
import { buttonClass } from '#components/ui/button.ts';
import {
itemClass, itemActionsClass, itemContentClass, itemDescriptionClass,
itemMediaClass, itemTitleClass,
} from '#components/ui/item.ts';
import { BadgeCheckIcon, ChevronRightIcon } from '#lib/ui/lucide.ts';
const translations = {
en: {
dir: 'ltr',
values: {
basicItem: 'Basic Item',
basicItemDesc: 'A simple item with title and description.',
action: 'Action',
verifiedTitle: 'Your profile has been verified.',
},
},
ar: {
dir: 'rtl',
values: {
basicItem: 'عنصر أساسي',
basicItemDesc: 'عنصر بسيط يحتوي على عنوان ووصف.',
action: 'إجراء',
verifiedTitle: 'تم التحقق من ملفك الشخصي.',
},
},
he: {
dir: 'rtl',
values: {
basicItem: 'פריט בסיסי',
basicItemDesc: 'פריט פשוט עם כותרת ותיאור.',
action: 'פעולה',
verifiedTitle: 'הפרופיל שלך אומת.',
},
},
};
export default function ItemRtl() {
const lang = 'ar';
const { dir, values: t } = translations[lang];
return html`
<div class="flex w-full max-w-md flex-col gap-6" dir=${dir} lang=${lang}>
<div data-slot="item" data-variant="outline" data-size="default" class=${itemClass({ variant: 'outline' })}>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>${t.basicItem}</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>${t.basicItemDesc}</p>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
<button type="button" data-slot="button" data-variant="outline" data-size="sm" class=${buttonClass({ variant: 'outline', size: 'sm' })}>
${t.action}
</button>
</div>
</div>
<a href="#" data-slot="item" data-variant="outline" data-size="sm" class=${itemClass({ variant: 'outline', size: 'sm' })}>
<div data-slot="item-media" data-variant="default" class=${itemMediaClass()}>
${BadgeCheckIcon('size-5')}
</div>
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>${t.verifiedTitle}</div>
</div>
<div data-slot="item-actions" class=${itemActionsClass()}>
${ChevronRightIcon('size-4')}
</div>
</a>
</div>
`;
}
View Code
API Reference
Every part is a class helper. Set the part's data-slot on the element as well, since the styles use it to lay the parts out relative to each other.
itemClass
The main part, for displaying content with media, title, description, and actions. Put it on a <div>, or on an <a> or <button> when the whole row acts. itemVariants() is an alias of itemClass() that also merges a className.
itemGroupClass
A container that groups related items together with consistent styling.
<div role="list" data-slot="item-group" class=${itemGroupClass()}>
<div role="listitem" data-slot="item" class=${itemClass()}>...</div>
<div role="listitem" data-slot="item" class=${itemClass()}>...</div>
</div>
itemSeparatorClass
A separator between items in a group.
<div role="list" data-slot="item-group" class=${itemGroupClass()}>
<div role="listitem" data-slot="item" class=${itemClass()}>...</div>
<div role="separator" data-slot="item-separator" class=${itemSeparatorClass()}></div>
<div role="listitem" data-slot="item" class=${itemClass()}>...</div>
</div>
itemMediaClass
Use itemMediaClass() to display media content such as icons, images, or avatars. itemMediaVariants() is an alias of itemMediaClass() that also merges a className.
<div data-slot="item-media" data-variant="icon" class=${itemMediaClass({ variant: 'icon' })}>
${Icon()}
</div>
<div data-slot="item-media" data-variant="image" class=${itemMediaClass({ variant: 'image' })}>
<img src="..." alt="...">
</div>
itemContentClass
Wraps the title and description of the item.
<div data-slot="item-content" class=${itemContentClass()}>
<div data-slot="item-title" class=${itemTitleClass()}>Title</div>
<p data-slot="item-description" class=${itemDescriptionClass()}>Description</p>
</div>
itemTitleClass
Displays the title of the item.
<div data-slot="item-title" class=${itemTitleClass()}>Item Title</div>
itemDescriptionClass
Displays the description of the item.
<p data-slot="item-description" class=${itemDescriptionClass()}>Item description</p>
itemActionsClass
Container for action buttons or other interactive elements.
<div data-slot="item-actions" class=${itemActionsClass()}>
<button class=${buttonClass()}>Action</button>
</div>
itemHeaderClass
Displays a header above the item content.
<div data-slot="item" class=${itemClass()}>
<div data-slot="item-header" class=${itemHeaderClass()}>Header</div>
<div data-slot="item-content" class=${itemContentClass()}>...</div>
</div>
itemFooterClass
Displays a footer below the item content.
<div data-slot="item" class=${itemClass()}>
<div data-slot="item-content" class=${itemContentClass()}>...</div>
<div data-slot="item-footer" class=${itemFooterClass()}>Footer</div>
</div>