Status & feedbackExplore · Adapt · Compose
Badge
Compact labels with shadcn-aligned variants (destructive, ghost, outline), optional asChild link, icons via data-icon, Spinner states, and extra semantic variants. Explain what is happening, what changed and what someone can do next. Pair visual status with language that still makes sense without its color. 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/badge 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 Badge from @/components/kamod-ui/badge.
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.
import { Badge } from "@/components/kamod-ui/badge";Usage
Pick a variant for emphasis; default renders a filled neutral chip. Use BreadcrumbPage or Button for navigation—Badge is for status and metadata.
import { Badge } from "@/components/kamod-ui/badge";Choose a complete composition from the examples below; required child components and props vary by pattern.
Component examples & variants
Explore Badge in different contexts, from the starting pattern to the compositions below. Begin with Variants, 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.
Variants
Shadcn-compatible set plus additional semantic colors for product UI.
With icon
Set data-icon="inline-start" or data-icon="inline-end" on the icon so padding stays balanced.
With spinner
Short-lived states: pair Spinner with the same data-icon attributes.
Link
Use asChild so an anchor (or router Link) receives badge styling. You can still pass href without asChild to render a native anchor.
Custom colors
Override with utility classes for brand-specific chips (including dark mode pairs).
Sizes
Kamod-specific density scale from xxs through lg.
Props and data
Configure Badge 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.
Badge props and accepted values.
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.Badge
Renders as span by default; href renders anchor; asChild merges onto a single child.
| Prop / type | Description |
|---|---|
variant | Documented variant option for Badge. Check its type alongside the usage examples before supplying a value. Documented default |
size | Documented size option for Badge. Check its type alongside the usage examples before supplying a value. Documented default |
asChild | Documented asChild option for Badge. Check its type alongside the usage examples before supplying a value. Documented default |
href | Documented href option for Badge. Check its type alongside the usage examples before supplying a value. Documented default |
class | Documented class option for Badge. 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.
BadgePropsAccessibility
Build the complete interaction, including the parts outside Badge. 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
Badge provides compact visual emphasis; it does not automatically announce state changes or turn its label into a control. Its color and variant remain presentation choices rather than a complete status description.
Labels and relationships
Write a short status word that makes sense without color, such as Pending review. When a count belongs to a button or link, include enough context in the parent action's name. Hide a badge from assistive technology only if it duplicates information already available.
Keyboard and focus
Keep static badges out of the tab order. If a badge is used as a removable filter, compose a real, named removal button instead of attaching a click handler to the visual label.
States and integration details
Do not make every count update a live announcement. Decide whether the change actually needs immediate attention, and keep the full status available when compact text is truncated or visually abbreviated.
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.
- Read the badge without its color and confirm its meaning is still clear.
- Check that static status labels do not create unnecessary keyboard stops.
- Inspect names of any parent links or removal actions containing the badge.
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 Badge 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
Tie feedback to the operation it describes. Distinguish waiting, success, failure and an empty result instead of reusing one message for every state. Keep essential recovery instructions available in the page even if a temporary notification disappears.
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 Badge.
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
- Confirm that status is understandable without color, animation or an icon alone.
- Exercise both completion and failure paths; stop loading indicators when the operation finishes.
- Use announcements only when needed and avoid repeatedly announcing unchanged background activity.
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
Badge 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 Badge 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.