Media & Presentation
Image
Image renders responsive media with consistent styling. Give media a predictable place in the layout while keeping the surrounding content readable during loading, playback or failure. Import it from @/components/kamod-ui/image.
Source · API reference · Theming · Styles
Interactive preview
Preact example Local preview theme · Responsive styles follow the preview widthFull widthInstallation
Import Image from @/components/kamod-ui/image.
pnpm add @kamod-ch/uiCopy an example with @kamod-ch/ui or the matching @kamod-ch/ui/… subpath. The code block switches between those two installs. Connect The Global Theme CSS and Tailwind Source Detection before your first render.
Usage
Use alt text for accessibility and className for shape/size control.
import { Image } from "@kamod-ch/ui";Choose a complete composition from the examples below; required child components and props vary by pattern.
Component Examples & Variants
Explore Image in Different Contexts, from the starting pattern to the compositions below. Begin with Basic Image, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API Reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.
Read the Result and Its Implementation Together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the Component Styles Guide for hierarchy and the Theming Guide for shared surfaces and colors. The Accessibility Notes explain what to preserve when making those changes.
Basic Image
Reserve Space and Describe Meaningful Media. Place an image in a simple rounded frame to establish its role in the layout. Supply an appropriate text alternative and reserve sensible dimensions so the visual does not disrupt nearby content as it loads.
Provide useful alt text for informative images and an empty alternative for purely decorative ones; rounded corners change presentation, not the image's accessible meaning.
import { Image } from "@kamod-ch/ui";
export const Example = () => (
<Image
src="https://images.unsplash.com/photo-1500530855697-b586d89ba3ee?w=800"
alt="Mountain landscape"
class="h-40 w-full max-w-lg object-cover"
/>
);Image Thumbnail
Keep Compact Media Recognizable. Use a smaller image frame when media supports a list row or card rather than leading the page. Keep the crop and dimensions consistent across neighboring items so the text remains easy to scan alongside the previews.
Check cropping with real images and use Aspect Ratio when different source dimensions need a consistent frame; preserve a clear destination if the preview is clickable.
Interactive preview
Preact example Local preview theme · Responsive styles follow the preview widthFull widthProps and Data
Configure Image using the contracts below. Read the documented options alongside the Source Definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.
Props, slots and variants for this component.
Type cards are extracted from this checkout’s TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.
Component Props
? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.Image
ImageProps
| Prop / type | Description |
|---|---|
alt | Configure
|
class | Configure
|
Data Type Reference
Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the Implementation Source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.
Image Props
DeclarationImagePropsImage.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of ImageProps before adapting it.Accessibility
Image renders a native img and defaults alt to an empty string. This treats an unspecified image as decorative; it does not automatically describe a meaningful photograph, chart or screenshot.
You have the pieces. Put them into one real interaction, keep its state in one place, and check the result with the content your application will actually show.
Connect the Foundation
Return to Choose and Compose Components to connect this reference to a working screen. Keep global CSS in one entrypoint and import only the components that screen needs.
Build the Surrounding Screen
Find a neighboring interaction in the Component Library, or start with a complete Block. Replace sample content and destinations before refining the layout; a local class change can stay with the composition.
Make the Result Hold Up
Use shared theme roles for changes that belong everywhere. Then review the whole journey: keyboard focus, long labels, narrow screens and a clear way to recover when something fails.
Keep a link to the source and note your intentional changes. Your next edit should begin with a clear decision, not another search.