Components / visual
ColorizedBadge
Shows a label using an explicitly supplied color treatment.
Generated from @oods/foundry 0.10.1
- Categories
- visual
- Contexts
- card
- Readiness
react-and-vue
Playground
This component's contract doesn't list typed props, so the playground shows its documented example.
Documented example colorized-badge-color-marker : mount in normal and forced-colors modes, noninteractive status label with a decorative color marker.
The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.
Code
The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.
import { ColorizedBadge } from '@oods/components-react';
import '@oods/component-styles/css';
export function Example() {
return (
<ColorizedBadge
label="Approved"
status="active"
color="#15803d"
tone="success"
emphasis="subtle"
/>
);
}Props, slots and events
Contract version 1.1.0. Types are from the React declarations in @oods/components-react.
| Prop | Type | Required | Documented example |
|---|---|---|---|
label | string | undefined | no | Approved |
text | string | undefined | no | |
state | string | undefined | no | |
value | string | undefined | no | |
status | string | undefined | no | active |
color | string | undefined | no | #15803d |
hue | string | undefined | no | |
swatch | string | undefined | no | |
variant | string | undefined | no | |
tone | ComponentTone | undefined | no | success |
emphasis | ComponentEmphasis | undefined | no | subtle |
Slots
default
Events
none
States
subtle, solid
Accessibility
- Role
none- How it gets its name
noneon:root
Keyboard
The contract lists no keyboard behaviour.
Obligations in the contract
- Inherits Badge inline noninteractive status label semantics
- A visible text label always accompanies the decorative color marker
- Color is never the sole status signal
Mirrors renderColorizedBadge over renderBadgePrimitive label/status/color aliases and default variant colorized; Badge tone and emphasis retain their shared behavior.
Tokens
The token roles this component reads.
badge.backgroundbadge.textbadge.iconbadge.color
Readiness
The evidence recorded for this component, with its label.
react-and-vue: catalog_list gives this label when the React and Vue components have complete readiness evidence, but the sweep's generated apps don't use the component in both.
| Evidence | React | Vue |
|---|---|---|
| state | implemented-evidence-complete | implemented-evidence-complete |
| versioned contract | passed | passed |
| target implementation | passed | passed |
| package export | passed | passed |
| public declaration | passed | passed |
| dependency closure | passed | passed |
| framework scenario | passed | passed |
| accessibility | verified | verified |
| interaction | not-applicable | not-applicable |
| visual themes | verified | verified |
ColorizedBadge presents content and owns no focusable control or action; authored child actions remain the consumer's responsibility.
Use your own
You can replace this component with your own React or Vue component. Map it, and generated code imports yours at the exact version you name. A contract report, run in a real browser, lists what your component met, what it didn't, and what wasn't checked.
The component_map call, with the parts in angle brackets yours to fill:
{
"action": "create",
"apply": true,
"externalSystem": "<your design system>",
"externalComponent": "<YourColorizedBadge>",
"oodsTraits": [
"Colorized"
],
"substitution": {
"component": "ColorizedBadge",
"react": {
"package": "<your-package>/react",
"version": "<exact version>",
"export": "<YourColorizedBadge>"
},
"vue": {
"package": "<your-package>/vue",
"version": "<exact version>",
"export": "<YourColorizedBadge>"
}
}
} How this page was made
Generated at build from the published data, each source with the hash of what was read. The page's manifest.
- Contract:
@oods/component-contracts@0.10.1 componentContracts.ColorizedBadgesha256:0d8daf6c497a… - Documented example:
@oods/component-contracts@0.10.1 sharedScenarios colorized-badge-color-markersha256:46a2e55f9986… - Catalog entry (catalog_list):
generated/0.10.1/system/catalog.json ColorizedBadgesha256:b912c20b6a0d… - React readiness:
@oods/components-react@0.10.1 readiness ColorizedBadgesha256:695d4fc421ef… - Vue readiness:
@oods/components-vue@0.10.1 readiness ColorizedBadgesha256:3b4dcab64475… - Prop types:
generated/0.10.1/components/prop-types.json ColorizedBadgesha256:6a5ea7632e76…