Skip to contentVibraUI
Connect on X (@ekibuilds)Connect on X (@ekibuilds)
Get started
Data display

Attachment

A file chip with a thumbnail or icon, a name, a line of detail and actions.

Vibra draws the chip as the panel recipe — card plane and hairline ring — instead of a bordered box; an idle slot is a dashed outline at --input contrast, and a failed one rings in the danger tone. The actions are Vibra's ghost icon buttons. A working title shimmers only for a reader who has not asked for less motion, the stretched AttachmentTrigger wears the kit's focus ring on the chip's corners, and the media sizes only its own icons, so a ProductArt picture inside it keeps its drawing's size.

Install

npx shadcn@latest add @vibra/attachment

Needs the @vibra registry in your components.json — set it up once.

Examples

Every state

Idle, uploading, processing, failed and done, each said in words as well as drawn.

Image tiles

Pictures as tiles on a strip that scrolls and snaps; the whole tile opens the file.

Sizes

One file at default, sm and xs, each where it is used.

In a message composer

Files waiting to go with a message. Removing one hands the focus to the next, then to the message.

Props

PropTypeDefaultDescription
state"idle" | "uploading" | "processing" | "error" | "done""done"uploading and processing shimmer the title; error turns the media and detail to the danger tone.
size"default" | "sm" | "xs""default"The chip's padding and the media tile's size.
orientation"horizontal" | "vertical""horizontal"A row with the media at the start, or a tile with the media on top.
AttachmentMedia.variant"icon" | "image""icon"An icon on the muted tile, or an image cropped to fill it.

Dependencies

Registry

npm

Source

components/ui/attachment.tsx
import * as React from "react"
import { mergeProps } from "@base-ui/react/merge-props"
import { useRender } from "@base-ui/react/use-render"
import { cva, type VariantProps } from "class-variance-authority"
import { cn } from "@/lib/utils"

import { Button } from "@/components/ui/button"

const attachmentVariants = cva(
  "group/attachment relative flex w-fit max-w-full min-w-0 shrink-0 flex-wrap panel text-card-foreground transition-colors has-[:focus-visible]:focus-outline has-[>a,>button]:hover:bg-muted/50 data-[state=error]:ring-danger/40 data-[state=idle]:ring-0 data-[state=idle]:outline-1 data-[state=idle]:outline-dashed data-[state=idle]:-outline-offset-1 data-[state=idle]:outline-input",
  {
    variants: {
      size: {
        default:
          "gap-2 text-sm has-data-[slot=attachment-content]:px-2.5 has-data-[slot=attachment-content]:py-2 has-data-[slot=attachment-media]:p-2",
        sm: "gap-2.5 text-xs has-data-[slot=attachment-content]:px-2 has-data-[slot=attachment-content]:py-1.5 has-data-[slot=attachment-media]:p-1.5",
        xs: "gap-1.5 rounded-lg text-xs has-data-[slot=attachment-content]:px-1.5 has-data-[slot=attachment-content]:py-1 has-data-[slot=attachment-media]:p-1",
      },
      orientation: {
        horizontal: "min-w-40 items-center",
        vertical: "w-24 flex-col has-data-[slot=attachment-content]:w-30",
      },
    },
  }
)

function Attachment({
  className,
  state = "done",
  size = "default",
  orientation = "horizontal",
  ...props
}: React.ComponentProps<"div"> &
  VariantProps<typeof attachmentVariants> & {
    state?: "idle" | "uploading" | "processing" | "error" | "done"
  }) {
  return (
    <div
      data-slot="attachment"
      data-state={state}
      data-size={size}
      data-orientation={orientation}
      className={cn(attachmentVariants({ size, orientation }), className)}
      {...props}
    />
  )
}

// The icon sizes reach the media's own children only: a picture drawn with
// svg inside it — ProductArt, the kit's product images — keeps its drawing's
// size instead of shrinking to an icon's 24px.
const attachmentMediaVariants = cva(
  "relative flex aspect-square w-10 shrink-0 items-center justify-center overflow-hidden rounded-lg bg-muted text-foreground group-data-[orientation=vertical]/attachment:w-full group-data-[size=sm]/attachment:w-8 group-data-[size=xs]/attachment:w-7 group-data-[size=xs]/attachment:rounded-md group-data-[state=error]/attachment:bg-destructive/10 group-data-[state=error]/attachment:text-destructive group-data-[orientation=vertical]/attachment:*:data-[slot=spinner]:size-6! [&>svg]:pointer-events-none [&>svg:not([class*='size-'])]:size-4 group-data-[orientation=vertical]/attachment:[&>svg:not([class*='size-'])]:size-6 group-data-[size=xs]/attachment:[&>svg:not([class*='size-'])]:size-3.5",
  {
    variants: {
      variant: {
        icon: "",
        image:
          "opacity-60 group-data-[state=done]/attachment:opacity-100 group-data-[state=idle]/attachment:opacity-100 *:[img]:aspect-square *:[img]:w-full *:[img]:object-cover",
      },
    },
    defaultVariants: {
      variant: "icon",
    },
  }
)

function AttachmentMedia({
  className,
  variant = "icon",
  ...props
}: React.ComponentProps<"div"> & VariantProps<typeof attachmentMediaVariants>) {
  return (
    <div
      data-slot="attachment-media"
      data-variant={variant}
      className={cn(attachmentMediaVariants({ variant }), className)}
      {...props}
    />
  )
}

function AttachmentContent({
  className,
  ...props
}: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="attachment-content"
      className={cn(
        "max-w-full min-w-0 flex-1 leading-tight group-data-[orientation=vertical]/attachment:px-1",
        className
      )}
      {...props}
    />
  )
}

function AttachmentTitle({
  className,
  ...props
}: React.ComponentProps<"span">) {
  return (
    <span
      data-slot="attachment-title"
      className={cn(
        // The shimmer loops, so no duration token can stop it: it is drawn
        // only for readers who have not asked for less motion, by the OS
        // setting (motion-safe) or by the kit's switch (outside
        // [data-motion="reduced"]). A stopped shimmer would still paint its
        // gradient over the words, so it is not stopped but never drawn.
        // (The stylesheet's own reduced-motion rule names .shimmer alone, and
        // a variant-prefixed class never matched it.)
        "block max-w-full min-w-0 truncate font-medium group-data-[state=processing]/attachment:motion-safe:not-in-data-[motion=reduced]:shimmer group-data-[state=uploading]/attachment:motion-safe:not-in-data-[motion=reduced]:shimmer",
        className
      )}
      {...props}
    />
  )
}

function AttachmentDescription({
  className,
  ...props
}: React.ComponentProps<"span">) {
  return (
    <span
      data-slot="attachment-description"
      className={cn(
        "mt-0.5 block min-w-0 truncate text-xs text-muted-foreground group-data-[state=error]/attachment:text-destructive/80",
        "max-w-full",
        className
      )}
      {...props}
    />
  )
}

function AttachmentActions({
  className,
  ...props
}: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="attachment-actions"
      className={cn(
        "relative z-20 flex shrink-0 items-center group-data-[orientation=vertical]/attachment:absolute group-data-[orientation=vertical]/attachment:top-3 group-data-[orientation=vertical]/attachment:end-3 group-data-[orientation=vertical]/attachment:gap-1",
        className
      )}
      {...props}
    />
  )
}

function AttachmentAction({
  className,
  variant,
  size = "icon-xs",
  ...props
}: React.ComponentProps<typeof Button>) {
  return (
    <Button
      data-slot="attachment-action"
      variant={variant ?? "ghost"}
      size={size}
      className={cn(className)}
      {...props}
    />
  )
}

function AttachmentTrigger({
  className,
  render,
  type,
  ...props
}: useRender.ComponentProps<"button">) {
  return useRender({
    defaultTagName: "button",
    props: mergeProps<"button">(
      {
        type: render ? type : (type ?? "button"),
        // Stretched over the chip, it draws the kit's focus ring on the chip's
        // own corners; the chip's half-strength focus-within ring alone was
        // all a keyboard reader had to go on.
        className: cn("absolute inset-0 z-10 rounded-[inherit] focus-ring", className),
      },
      props
    ),
    render,
    state: {
      slot: "attachment-trigger",
    },
  })
}

function AttachmentGroup({ className, ...props }: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="attachment-group"
      className={cn(
        "flex min-w-0 scroll-fade-x snap-x snap-mandatory scroll-px-1 scrollbar-none gap-3 overflow-x-auto overscroll-x-contain py-1 *:data-[slot=attachment]:flex-none *:data-[slot=attachment]:snap-start",
        className
      )}
      {...props}
    />
  )
}

export {
  Attachment,
  AttachmentGroup,
  AttachmentMedia,
  AttachmentContent,
  AttachmentTitle,
  AttachmentDescription,
  AttachmentActions,
  AttachmentAction,
  AttachmentTrigger,
}