Badge¶
Display compact categorical metadata with a named tone.
| Import | from hedron import Badge |
| Distribution | hedron |
| Backend activity | No |
| Normal render mode | RenderMode.FRAGMENT |
Live demo¶
The preview is a local docs simulation (not a running Hedron server). Interactive demos show a “Simulated HTMX” trace when applicable.
Basic use¶
from hedron import Badge, Inline
component = Inline(Badge('Beta', tone='info'), Badge('Healthy', tone='success'))
Compose under Page for full documents, or return from a fragment route for HTMX swaps.
How it works¶
Badge emits visible text and a tone data attribute for theming. Tones are finite so products can keep color usage consistent.
This component's core behavior is server-rendered HTML and does not require a browser runtime. The preview is ordinary semantic HTML, so keyboard, form, link, and disclosure behavior comes from the platform.
Constructor and parameters¶
| Parameter | Type | Meaning |
|---|---|---|
text |
str |
Short badge label. |
tone |
neutral | info | success | warning | danger |
Semantic styling token. |
Composition and backend behavior¶
Keep Badge at the smallest semantic boundary. Fragment routes should return only
the replaced region and preserve stable target IDs across success, validation, empty,
loading, and error responses.
Badge is primarily presentational; keep any mutation on an explicit action or component route.
Accessibility¶
The text must carry the meaning; tone color is supplementary.
Security¶
Escaping and SafeUrl / TrustedHtml are framework concerns; authorization and data
exposure remain application code. Redact secrets before rendering.
Common mistakes¶
- Do not use a badge as a live announcement or interactive control.
- Do not copy docs-preview JavaScript into an application server.