import { Image } from "@elabs-ai/components-ui";npm install @elabs-ai/components-tokens @elabs-ai/components-uiPrompt for your coding agent
Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.
Add the brand-ui Image component (from @elabs-ai/components-ui) to this project. 1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`. 2. Look Image up before writing code: `npx -y @elabs-ai/components-cli docs Image` prints its real props, variants, what it pairs with and what to avoid. 3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`. 4. Use it here: [the screen or file, and what it should show] 5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop. 6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.
Avoid
- Zoom/rotation on Image — that is the viewer shell's job (ADR 0026).
- A `loading` boolean — use native `loading="lazy"`; an <img> has no external not-ready signal.
- No `width`+`height` or `aspectRatio` on a late image — the skeleton cannot reserve the box.
- A person/agent mark with initials — that is Avatar.
Works with
Contains
Pairs with
Examples
Fit
Every `fit` value on a tall source inside the same square box.
With Aspect Ratio
`aspectRatio` reserves the box before decode; the image fills it (`fit="cover"`).
Thumbnails
Small fixed sizes with no skeleton — the bare `<img>` is the root.
Intrinsic
No size given: intrinsic size, native lazy loading, no reserved box.
Broken
Terminal error: the `<img>` is replaced by a named `ImageOff` box.
Decorative Broken
A decorative image that fails stays hidden from assistive tech.
Custom Fallback
`fallback` replaces the default box after an error.
API
Image
| Prop | Type | Description |
|---|---|---|
altrequired | string | Required. `""` marks the image decorative (no live region, `aria-hidden` fallback). |
fit | ImageFit | CSS `object-fit` of the image inside its box. @default "contain" |
showSkeleton | boolean | Show a `Skeleton` in a reserved box until the image decodes. A box can only be reserved when its size is known, so the default is on only with both `width` and `height`, or an `aspectRatio`. @default Boolean(width && height) || aspectRatio !== undefined |
aspectRatio | number | Reserve a box of this ratio (e.g. `16 / 9`); the image fills it. |
fallback | ReactNode | Rendered instead of the default `ImageOff` box after a terminal load error (or when `src` is empty). `null` renders nothing. |
Skeleton
Theming
The tokens each state resolves to. Change the token and every theme follows.
| State | Token |
|---|---|
| loading | Skeleton fills the reserved frame; sr-only role=status only when `alt` is non-empty |
| error | bg-muted ImageOff box; role=img aria-label={alt}, or aria-hidden when alt is empty |