ui · 6 variants · 1 categories
Image
Image wrapper with caption, badge, ratio control, and placeholder fallback.
npx "@rueda.dev/gems-diamond" add image Display
6 variantsbasicAtlas Mug
captionpaircircularEP 03
Quiet shipping
overlayframedUsage Guide
How to wire up this component in your app — props, callbacks, customization, and the conventions Diamond shares across the library.
Sources
Pass src to render a native <img>, or placeholder with any ReactNode (gradient, SVG, blurhash). placeholder renders behind the image and shows when src fails to load.
caption renders inside the frame on the caption / overlay variants, and below the image on others. Use filter for a CSS filter string (e.g. "grayscale(1) contrast(1.1)").
Universal patterns
Every Diamond component shares the same prop conventions, so once you learn one you can predict the others.
variant— discriminated union of every visual option. Categories shown above are docs-only metadata; the prop is a flat string union.accent— any CSS color string. Overrides--diamond-accentjust for that instance via inlinestyle. Cascades into hover, ring, and selection states.asChild(when present) — renders the underlying primitive via@radix-ui/react-slot, letting you compose with<Link>,motion.button, etc.className— merged with internal Tailwind classes viacn(). Use it to override layout, spacing, or colors.- Native HTML attributes (
onClick,aria-*,data-*,ref, etc.) flow through to the root element without any whitelist. - Diamond is the skin: zero domain state, zero fetch, zero providers. You wire data and reactions in your app code; the components just render and emit events.