The Attachment component displays a file or image attachment, its media, name, and metadata, with optional actions and upload state. Use it for files and images in chat composers, message threads, and upload lists.
Installation
Usage
<script setup lang="ts">
import { FileTextIcon, XIcon } from '@lucide/vue'
import {
Attachment,
AttachmentAction,
AttachmentActions,
AttachmentContent,
AttachmentDescription,
AttachmentMedia,
AttachmentTitle,
} from '@/components/ui/attachment'
</script>
<template>
<Attachment>
<AttachmentMedia>
<FileTextIcon />
</AttachmentMedia>
<AttachmentContent>
<AttachmentTitle>sales-dashboard.pdf</AttachmentTitle>
<AttachmentDescription>PDF · 2.4 MB</AttachmentDescription>
</AttachmentContent>
<AttachmentActions>
<AttachmentAction aria-label="Remove sales-dashboard.pdf">
<XIcon />
</AttachmentAction>
</AttachmentActions>
</Attachment>
</template>Composition
Use the following composition to build an attachment:
Attachment
├── AttachmentMedia
├── AttachmentContent
│ ├── AttachmentTitle
│ └── AttachmentDescription
├── AttachmentActions
│ └── AttachmentAction
└── AttachmentTriggerUse AttachmentGroup to lay out multiple attachments in a scrollable row:
AttachmentGroup
├── Attachment
└── AttachmentFeatures
- Icon and image media through
AttachmentMedia - Upload states:
idle,uploading,processing,error, anddonewith built-in styling and a shimmer while in progress - Three sizes and horizontal or vertical orientation
- A full-card
AttachmentTriggerthat opens a link or dialog while the actions stay independently clickable - Scrollable, snapping
AttachmentGroupwith an edge fade - Customizable styling through the Vue
classattribute on every part
Examples
Image
Set variant="image" on AttachmentMedia and render an <img> inside it. Use orientation="vertical" to stack the media above the content.
States
Set state to reflect the upload lifecycle. uploading and processing shimmer the title, and error switches to a destructive treatment.
Sizes
Use size to switch between default, sm, and xs.
Group
Wrap attachments in AttachmentGroup to lay them out in a horizontally scrollable, snapping row with an edge fade.
Trigger
Add an AttachmentTrigger to make the whole card open a link or dialog. It fills the card behind the actions, so the actions stay clickable.
<template>
<Dialog>
<Attachment>
<!-- media, content, actions -->
<DialogTrigger as-child>
<AttachmentTrigger aria-label="Preview research-summary.pdf" />
</DialogTrigger>
</Attachment>
<DialogContent>
<!-- ... -->
</DialogContent>
</Dialog>
</template>Accessibility
AttachmentAction renders a Button, and AttachmentTrigger renders a real <button> (or your element via as-child). Follow the guidance below so both are operable and announced.
Label icon-only actions
AttachmentAction is usually icon-only, so give each one an aria-label describing the action and its target.
<template>
<AttachmentAction aria-label="Remove sales-dashboard.pdf">
<XIcon />
</AttachmentAction>
</template>Label the trigger
AttachmentTrigger covers the card with no text of its own, so give it an aria-label for what activating it does.
<template>
<AttachmentTrigger as-child>
<a
:href="url"
target="_blank"
rel="noreferrer"
aria-label="Open workspace.png"
/>
</AttachmentTrigger>
</template>The trigger sits behind the actions in the stacking order, so an AttachmentAction and the AttachmentTrigger never trap each other — both remain separately focusable and clickable.
Keyboard scrolling
An AttachmentGroup scrolls horizontally. When its attachments are interactive: a trigger or actions, keyboard users reach off-screen items by tabbing to them. For a row of presentational attachments, make the group itself focusable and scrollable by adding tabindex="0", role="group", and an aria-label.
Meaning beyond color
The error state uses a destructive color. Keep the failure reason in AttachmentDescription so the state is not conveyed by color alone.
API Reference
Attachment
The root attachment container.
AttachmentMedia
The media slot for an icon or image preview.
AttachmentContent
Wraps the title and description.
AttachmentTitle
The attachment name. Shimmers while the attachment is uploading or processing.
AttachmentDescription
Secondary metadata such as the file type, size, or upload status.
AttachmentActions
A container for one or more actions, aligned to the end of the attachment.
AttachmentAction
An action button. Renders a Button and accepts Vue fallthrough attributes such as aria-label.
AttachmentTrigger
A full-card overlay that activates the attachment. Renders a <button> by default and accepts Vue fallthrough attributes such as aria-label.
AttachmentGroup
Lays out attachments in a horizontally scrollable, snapping row.