Composition & layoutExplore · Adapt · Compose
Card
Surface for grouped content and actions — shadcn-aligned slots, `size="sm"`, header grid with `CardAction`, image hero, and RTL. Build a clear hierarchy with reusable structure, consistent spacing and semantic surfaces. Keep layout decisions close to the content they organize. Explore the live examples, inspect their source and choose the composition that fits your interface before connecting it to your application's data.
The examples use @/components/kamod-ui/card in a Preact project. Follow the live result and its source together: compare supported options in the API reference, refine presentation with the component styles guide, and use shared theme tokens for consistent colors and surfaces. Preserve keyboard behavior and meaningful labels as you replace the sample content.
In this guide 7 sections
Installation
Import Card and subcomponents from @/components/kamod-ui/card.
pnpm add @kamod-ch/uiThe @/components/kamod-ui/… imports in these examples refer to local source files. Configure that alias when copying source, or use the corresponding exports from @kamod-ch/ui when installing the package. Connect the global theme CSS and Tailwind source detection before your first render.
Usage
Compose CardHeader (title, description, optional CardAction), CardContent, and CardFooter. Set size="sm" on Card for tighter padding. For cover images, use class="pt-0" on the card and place the image as the first block; pair with DirectionProvider for RTL layouts.
import { Card } from "@/components/kamod-ui/card";Choose a complete composition from the examples below; required child components and props vary by pattern.
Component examples & variants
Explore Card in different contexts, from the starting pattern to the compositions below. Begin with Demo, 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.
Demo
Login-style layout with header action, form fields, and stacked footer buttons (shadcn CardDemo).
import { Button } from "@/components/kamod-ui/button";
import { Card, CardAction, CardContent, CardDescription, CardFooter, CardHeader, CardTitle } from "@/components/kamod-ui/card";
import { Input } from "@/components/kamod-ui/input";
import { Label } from "@/components/kamod-ui/label";
export const Example = () => (
<Card class="w-full max-w-sm">
<CardHeader>
<CardTitle>Login to your account</CardTitle>
<CardDescription>
Enter your email below to login to your account
</CardDescription>
<CardAction>
<Button variant="link">Sign Up</Button>
</CardAction>
</CardHeader>
<CardContent>
<form>
<div class="flex flex-col gap-6">
<div class="grid gap-2">
<Label htmlFor="email">Email</Label>
<Input
id="email"
type="email"
placeholder="m@example.com"
required
/>
</div>
<div class="grid gap-2">
<div class="flex items-center">
<Label htmlFor="password">Password</Label>
<a
href="#"
class="ms-auto inline-block text-sm underline-offset-4 hover:underline"
>
Forgot your password?
</a>
</div>
<Input id="password" type="password" required />
</div>
</div>
</form>
</CardContent>
<CardFooter class="flex-col gap-2">
<Button type="submit" class="w-full">
Login
</Button>
<Button variant="outline" class="w-full">
Login with Google
</Button>
</CardFooter>
</Card>
);Size
Use size="sm" for reduced vertical padding and smaller type scale on the card.
Image
Hero image with overlay, badge action in the header, and a full-width primary button (shadcn CardImage).
Props and data
Configure Card 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.
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.TypeScriptComponent 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.Card
Card component props and accepted values.
| Prop / type | Description |
|---|---|
Card `size` | Documented Card `size` option for Card. Check its type alongside the usage examples before supplying a value. Documented default |
Card `class` | Documented Card `class` option for Card. Check its type alongside the usage examples before supplying a value. Documented default |
CardHeader `class` | Documented CardHeader `class` option for Card. Check its type alongside the usage examples before supplying a value. Documented default |
CardTitle `class` | Documented CardTitle `class` option for Card. Check its type alongside the usage examples before supplying a value. Documented default |
CardDescription `class` | Documented CardDescription `class` option for Card. Check its type alongside the usage examples before supplying a value. Documented default |
CardAction `class` | Documented CardAction `class` option for Card. Check its type alongside the usage examples before supplying a value. Documented default |
CardContent `class` | Documented CardContent `class` option for Card. Check its type alongside the usage examples before supplying a value. Documented default |
CardFooter `class` | Documented CardFooter `class` option for Card. Check its type alongside the usage examples before supplying a value. Documented default |
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.
CardPropsCardActionPropsCardContentPropsCardDescriptionPropsCardFooterPropsCardHeaderPropsCardTitlePropsAccessibility
Build the complete interaction, including the parts outside Card. The notes below distinguish the current implementation from the labels, content and behavior your application supplies. Start with the live preview, check the props and data reference, and test the finished composition with real content rather than assuming that an unchanged visual example covers every use case.
Built-in behavior and defaults
Card supplies visual composition rather than an automatic document outline. CardTitle currently renders a div, so its large type does not make it a semantic heading. Add the appropriate heading element when the card introduces a section.
Labels and relationships
Give a card a clear subject and name its actions by outcome. Link text should remain understandable when several cards share the same layout. If the entire card is a destination, avoid nesting additional interactive controls inside that link.
Keyboard and focus
Only actual actions and destinations should receive keyboard focus. Keep reading order aligned with visual order and preserve the focus indicator when content is clipped, rounded or stretched into a clickable surface.
States and integration details
Do not turn every decorative card into a landmark or focusable group. A title, image, price and button need a useful reading sequence, while supplementary actions should remain distinct from the primary destination.
Verify the complete interaction
Check behavior as well as markup. Work through these scenarios in the application where the component will be used. Automated checks can help find structural problems; also review the reading experience with a screen reader, keyboard focus and the actual feedback from your application.
- Review the document heading outline rather than relying on title size.
- Tab through a grid and identify each action's target from its name and context.
- Increase text size and verify cards expand without hiding descriptions, prices or actions.
Recheck the result after changing theme tokens, translations or class overrides. Include text enlargement, narrow layouts and reduced-motion settings where animation is present. Inspect the component source when a behavior differs from your expectation; a role or state attribute does not implement keyboard interaction by itself.
For background, read the WAI-ARIA authoring guidance and keyboard interface guidance. These explain the patterns; verify browser and assistive-technology behavior for the implementation and audience you actually support.
Build it into your interface
Use the Card examples as a starting point, then review the behavior in the context of your own screen. Layout, state and content should work together.
Connect the behavior
Start from the smallest example that expresses your intent. Keep document order meaningful, use native semantics for headings and landmarks, and let the parent layout own page-level spacing. Avoid nesting interactive elements just to match a visual treatment.
Copy the composition, then connect its intent. Replace sample records and callbacks with your own data flow. For options such as value, defaultValue, open or onChange, use only those documented in this component's API; different components expose different contracts.
Give each piece of state one owner. Keep a temporary selection inside the interface when nothing else needs it; lift shared values into a parent when other controls depend on them. Read the prop reference before combining controlled values with defaults. A default normally initializes a control; it is not a substitute for updating its current value.
Connect requests in an event handler or your application’s data layer, never as a side effect of rendering. Keep pending, completed and failed outcomes distinct, preserve useful input after an error, and offer a clear recovery action. If the integration subscribes to an external source, remove that subscription when its owner unmounts; cancel or ignore obsolete requests so an earlier response cannot replace newer results.
Start with the live preview, then exercise the same interaction with your actual data. The type definitions describe accepted values; they do not implement persistence, navigation or server-side validation for you. Keep those responsibilities in the application that composes the UI.
Refine the presentation
Let a parent own the surrounding spacing. Keep related elements together with gap and use semantic surface/foreground pairs so the composition follows the active theme. The wrapper below changes the surrounding layout without assuming extra props on Card.
import type { ComponentChildren } from "preact";
export function ExampleSurface({ children }: { children: ComponentChildren }) {
return (
<div class="grid min-w-0 gap-4 rounded-lg border border-border bg-card p-4 text-card-foreground sm:p-6">
{children}
</div>
);
}Put the chosen example inside ExampleSurface, then refine supported variants and sizes using the API above. For application-wide changes, adjust theme tokens instead of repeating fixed colors. See Component styles for hierarchy, density and focus treatments.
Review the complete interaction
- Review long content, empty content and narrow containers without relying on a fixed height.
- Check text zoom, visible focus and contrast in light and dark appearances.
- Use documented extension points and verify class overrides do not erase essential interaction styles.
The preview's narrow control changes its container width. Also resize the browser when checking viewport-based Tailwind utilities such as sm: and md:, and test overlays in the full page where their portals render.
Compose a complete interface
Card is one part of the interaction. Choose companion components for the information or actions that still need a place on the screen. The references below are suggestions to compose deliberately, not extra dependencies you must add to every example.
Keep one source of truth for the operation and let each component communicate a different part of it. For example, waiting, no results and failure need different explanations. Avoid showing contradictory states together, and keep recovery actions close to the message that explains them.
Start with the smallest composition that explains the task. Browse the component library for individual controls or the block collections for complete layouts. Reuse shared theme tokens so these pieces feel consistent in light and dark mode.
Sources & design references
Follow Card from its implementation to the ideas behind your own composition. Start with the local API, explore a visual direction, then bring the result back to your app’s shared styles.
Bring it back to your app
A reference becomes useful when it fits your real content. Work through these decisions in order:
- Keep the behavior grounded. Start with the interactive examples, then connect your data and callbacks using the integration guidance. Preserve labels, keyboard access and disabled states as you change the presentation.
- Make the styling repeatable. Use the styles guide for local
classadjustments and theming documentation for shared color decisions. Keep semantic surface and foreground pairs together in both light and dark mode. - Check the complete screen. See how components combine in the block collections, then try long labels, loading states and narrow layouts in your own composition. The Theme Toggle guide helps you expose a scheme switch in the finished interface.