Components / lifecycle
ArchivePill
Marks whether a record is archived.
Generated from @oods/foundry 0.10.1
- Categories
- lifecycle
- Contexts
- card
- Readiness
proven-in-generated-apps
Playground
This component's contract doesn't list typed props, so the playground shows its documented example.
Documented example archive-pill-false : mount, Not archived remains visible; machine status remains false; archive is the badge variant; with hideWhenFalse a false flag renders nothing and a true flag reads Archived.
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 { ArchivePill } from '@oods/components-react';
import '@oods/component-styles/css';
export function Example() {
return (
<ArchivePill
isArchived={false}
/>
);
}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 | |
text | string | undefined | no | |
status | string | undefined | no | |
state | string | undefined | no | |
value | string | boolean | undefined | no | |
variant | string | undefined | no | |
tone | ComponentTone | undefined | no | |
emphasis | ComponentEmphasis | undefined | no | |
is | string | boolean | undefined | no | false |
hide | boolean | undefined | no |
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
- false remains visible
- archive is the badge variant
Mirrors renderArchivePill over renderBadgePrimitive: label/text/status/state/isArchived/value label precedence, status/state/isArchived/value status precedence, Archive fallback and archive variant. Boolean flags read Not archived / Archived while preserving their recorded status; absent flags remain absent and authored labels or children win. field binds isArchived. With hideWhenFalse a false flag renders nothing (s223-m01: a card shows "Archived", never the default "Not archived"); a true flag still reads Archived. archivedAtField is consumed unbound because the HTML pill has no date term. Noninteractive; no archive or restore action.
Tokens
The token roles this component reads.
badge.backgroundbadge.text
Readiness
The evidence recorded for this component, with its label.
proven-in-generated-apps: catalog_list gives this label when generated React and Vue apps in the runtime sweep that ships with this version both use the component. That sweep was measured on the published 0.4.1, not on this version.
| 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 |
ArchivePill 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": "<YourArchivePill>",
"oodsTraits": [
"Archivable"
],
"substitution": {
"component": "ArchivePill",
"react": {
"package": "<your-package>/react",
"version": "<exact version>",
"export": "<YourArchivePill>"
},
"vue": {
"package": "<your-package>/vue",
"version": "<exact version>",
"export": "<YourArchivePill>"
}
}
} 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.ArchivePillsha256:ff9ff594f05f… - Documented example:
@oods/component-contracts@0.10.1 sharedScenarios archive-pill-falsesha256:9295a3409264… - Catalog entry (catalog_list):
generated/0.10.1/system/catalog.json ArchivePillsha256:3ce883c3e320… - React readiness:
@oods/components-react@0.10.1 readiness ArchivePillsha256:efd5f16d37e5… - Vue readiness:
@oods/components-vue@0.10.1 readiness ArchivePillsha256:bff1bc990de4… - Prop types:
generated/0.10.1/components/prop-types.json ArchivePillsha256:6c4162295a7c…