Attachment

Displays a file or image attachment with media, metadata, upload state, and actions.

workspace.pngPNG · 820 KB

desk-reference.jpgJPG · 1.1 MB

office-reference.jpgJPG · 940 KB

sales-dashboard.pdfUploading · 64%

message-renderer.tsxTypeScript · 12 KB

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

import {
  Attachment,
  AttachmentGroup,
} from "@o/pipeline/experimental/components/chat/attachment";

Usage

import { IconClose, IconFileText } from "@o/pipeline/experimental/icons";
import { Attachment } from "@o/pipeline/experimental/components/chat/attachment";

<Attachment.Root>
  <Attachment.Media>
    <IconFileText />
  </Attachment.Media>
  <Attachment.Content>
    <Attachment.Title>sales-dashboard.pdf</Attachment.Title>
    <Attachment.Description>PDF · 2.4 MB</Attachment.Description>
  </Attachment.Content>
  <Attachment.Actions>
    <Attachment.Action aria-label="Remove sales-dashboard.pdf">
      <IconClose />
    </Attachment.Action>
  </Attachment.Actions>
</Attachment.Root>

Composition

Use the following composition to build an attachment:

Attachment.Root
├── Attachment.Media
├── Attachment.Content
│   ├── Attachment.Title
│   └── Attachment.Description
├── Attachment.Actions
│   └── Attachment.Action
└── Attachment.Trigger

Use AttachmentGroup to lay out multiple attachments in a scrollable row:

AttachmentGroup
├── Attachment.Root
└── Attachment.Root

Features

Icon and image media through Attachment.Media
Upload states: idle, uploading, processing, error, and done with built-in styling and a shimmer while in progress
Three sizes and horizontal or vertical orientation
A full-card Attachment.Trigger that opens a link or dialog while the actions stay independently clickable
Scrollable, snapping AttachmentGroup with an edge fade
Customizable styling through the className prop on every part

Image

Set variant="image" on Attachment.Media and render an <img> inside it. Use orientation="vertical" to stack the media above the content.

workspace.pngPNG · 820 KB

desk-reference.jpgJPG · 1.1 MB

office-reference.jpgJPG · 940 KB

States

Set state to reflect the upload lifecycle. uploading and processing shimmer the title, and error switches to a destructive treatment.

selected-file.pdfReady to upload

design-system.zipUploading · 64%

market-research.pdfProcessing document

financial-model.xlsxUpload failed. Try again.

uploaded-report.pdfUploaded · 1.8 MB

Sizes

Use size to switch between default, sm, and xs.

Default attachmentPDF · 2.4 MB

Small attachmentPDF · 2.4 MB

Extra small attachment

Group

Wrap attachments in AttachmentGroup to lay them out in a horizontally scrollable, snapping row with an edge fade.

briefing-notes.pdfPDF · 1.4 MB

workspace.pngPNG · 820 KB

customers.csvCSV · 18 KB

renderer.tsxTSX · 12 KB

Trigger

Add an Attachment.Trigger to make the whole card open a link or dialog. It fills the card behind the actions, so the actions stay clickable.

Dialog

Compose Attachment.Trigger with Dialog.Trigger to open a file preview while keeping the attachment actions independently clickable.

research-summary.pdfOpen preview dialog

Place Lightbox.Trigger inside Attachment.Media so the visible thumbnail opens the full-size image and acts as the view-transition source. This works with either a horizontal or vertical attachment.

workspace.pngPNG · 820 KB

desk-reference.jpgJPG · 1.1 MB

Accessibility

Attachment.Action renders a Button, and Attachment.Trigger renders a real <button> (or your element via render). Follow the guidance below so both are operable and announced.

Label icon-only actions

Attachment.Action is usually icon-only, so give each one an aria-label describing the action and its target.

<Attachment.Action aria-label="Remove sales-dashboard.pdf">
  <IconClose />
</Attachment.Action>

Label the trigger

Attachment.Trigger covers the card with no text of its own, so give it an aria-label for what activating it does.

<Attachment.Trigger
  render={
    <a
      href={url}
      target="_blank"
      rel="noreferrer"
      aria-label="Open workspace.png"
    />
  }
/>

The trigger sits behind the actions in the stacking order, so an Attachment.Action and the Attachment.Trigger 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 Attachment.Description so the state is not conveyed by color alone.

API Reference

Attachment.Root

The root attachment container.

Prop	Type	Default	Description
`state`	`"idle" \| "uploading" \| "processing" \| "error" \| "done"`	`"done"`	The upload state. Drives styling and the shimmer.
`size`	`"default" \| "sm" \| "xs"`	`"default"`	The attachment size.
`orientation`	`"horizontal" \| "vertical"`	`"horizontal"`	Lay the media beside or above the content.
`className`	`string`	-	Additional classes to apply to the root element.

Attachment.Media

The media slot for an icon or image preview.

Prop	Type	Default	Description
`variant`	`"icon" \| "image"`	`"icon"`	Whether the media holds an icon or an `<img>`.
`className`	`string`	-	Additional classes to apply to the media slot.

Attachment.Content

Wraps the title and description.

Prop	Type	Default	Description
`className`	`string`	-	Additional classes to apply to the content slot.

Attachment.Title

The attachment name. Shimmers while the attachment is uploading or processing.

Prop	Type	Default	Description
`className`	`string`	-	Additional classes to apply to the title.

Attachment.Description

Secondary metadata such as the file type, size, or upload status.

Prop	Type	Default	Description
`className`	`string`	-	Additional classes to apply to the description.

Attachment.Actions

A container for one or more actions, aligned to the end of the attachment.

Prop	Type	Default	Description
`className`	`string`	-	Additional classes to apply to the actions.

Attachment.Action

An action button. Renders a Button and accepts all of its props.

Prop	Type	Default	Description
`size`	`Button["size"]`	`"icon-xs"`	The button size.
`...props`	`React.ComponentProps<typeof Button>`	-	Props spread to the underlying `Button`.

Attachment.Trigger

A full-card overlay that activates the attachment. Renders a <button> by default.

Prop	Type	Default	Description
`render`	`ReactElement \| function`	-	Render as a different element, such as a link.
`...props`	`React.ComponentProps<"button">`	-	Props spread to the trigger element.

AttachmentGroup

Lays out attachments in a horizontally scrollable, snapping row.

Prop	Type	Default	Description
`className`	`string`	-	Additional classes to apply to the group.