Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Web docs
Data display

AttachmentPreview

Previews browser-owned images with localized loading, error and unsupported-file fallbacks.

FrameworksAstro · React · Elements

Registry commandlumen add AttachmentPreview

InteractionEnhanced runtime

01

See it and copy it

Framework example

Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.

AstroCode target · live preview uses Astro
Lumen logo
Example image attachment
Download

Vista previa no disponible para este archivo.

Example PDF · unsupported preview
View AttachmentPreview code

Framework usage

Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.
astro
---
import { AttachmentPreview, Button, Link } from '@santi020k/lumen-astro'
---

<AttachmentPreview src="/logo.svg" contentType="image/svg+xml" alt="Lumen logo">
  <span slot="caption">Example image attachment</span>
  <Link slot="actions" href="/logo.svg" download>Download</Link>
  <Button slot="actions" type="button">Replace</Button>
</AttachmentPreview>
<AttachmentPreview contentType="application/pdf" alt="Example report" labels={{ unavailable: 'Vista previa no disponible para este archivo.' }}>
  <span slot="caption">Example PDF · unsupported preview</span>
</AttachmentPreview>
Edit AttachmentPreview in browser
02

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

bash@santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
bashAstro wrapper
lumen add AttachmentPreview
lumen add AttachmentPreview

API reference

Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.

AttributeValuesDefaultDescription
srcstring-Browser-owned image URL; the application owns authorization and object URL cleanup.
altstringrequiredAccessible description of the image.
contentType / content-typestring-Non-image MIME types use a fallback instead of rendering an image.
state"ready" | "loading" | "error" | "unavailable"derivedExplicit loading, error and unavailable states override automatic image status.
labelsPartial<LumenAttachmentPreviewLabels>English labelsLocalizes fallback messages. Elements uses error-label, loading-label and unavailable-label.
retryKey / retry-keystring | number-Changes the retry identity for the current image. Retry remains application controlled.
caption / actionsReact nodes / Astro named slots-Composes a caption and independent download, replace or remove actions.
onStateChange(state) => void-React callback for transitions after the initial render; DOM adapters emit ui:attachment-preview-change with { state }.
class, classNamestring""Merges custom classes with the generated ui-* root classes.
...native attributesHTML attributes-Forwards standard attributes to the root element unless the component consumes them.

Runtime events

CustomEvents dispatched by the Astro UIPrimitives runtime for this component.

EventTargetDetailWhen
ui:attachment-preview-changeAttachmentPreview root{ state: "error" | "loading" | "ready" | "unavailable" }Fires after a preview state changes. The event never includes the file URL.

Web docsFull catalog