[Components](https://oods-foundry.com/components) / lifecycle

# ArchiveSummary

Shows a record's archive status and related details.

Generated from @oods/foundry 0.10.1

- Categories

  lifecycle

- Contexts

  detail

- 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-summary-false-and-reason` : mount, No remains visible in its named term; archive date and reason remain associated terms; with hideWhenDefault this record keeps its card, and a false flag with no date or reason renders nothing.

The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.

The real ArchiveSummary, live

React

## Archive Summary

- Archived

  No

- Archived At

  Sep 5, 2026, 12:00 PM

- Reason

  Retention policy

Vue

## Archive Summary

- Archived

  No

- Archived At

  Sep 5, 2026, 12:00 PM

- Reason

  Retention policy

## Code

The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.

**React**

```
import { ArchiveSummary } from '@oods/components-react';
import '@oods/component-styles/css';

export function Example() {
  return (
    <ArchiveSummary
      isArchived={false}
      archivedAt="2026-09-05T12:00:00Z"
      reason="Retention policy"
    />
  );
}
```

## Props, slots and events

Contract version 1.1.0. Types are from the React declarations in @oods/components-react.

Props

| Prop | Type | Required | Documented example |
| - | - | - | - |
| `title` | `string \| undefined` | no | |
| `label` | `string \| undefined` | no | |
| `heading` | `string \| undefined` | no | |
| `name` | `string \| undefined` | no | |
| `isArchived` | `string \| boolean \| undefined` | no | `false` |
| `archived` | `string \| boolean \| undefined` | no | |
| `status` | `string \| boolean \| undefined` | no | |
| `archivedAt` | `string \| null \| undefined` | no | `2026-09-05T12:00:00Z` |
| `reason` | `string \| undefined` | no | `Retention policy` |
| `archiveReason` | `string \| undefined` | no | |
| `summary` | `string \| undefined` | no | |
| `text` | `string \| undefined` | no | |
| `description` | `string \| undefined` | no | |
| `hideWhenDefault` | `boolean \| undefined` | no | |

### Slots

default

### Events

none

## States

populated, fallback, empty

## Accessibility

- Role

  `none`

- How it gets its name

  `heading` on `h1,h2,h3,h4,h5,h6`

### Keyboard

The contract lists no keyboard behaviour.

### Obligations in the contract

- false renders No in its named term
- archive date and reason remain associated terms

Mirrors renderArchiveSummary: h3 heading and Archived (isArchived/archived/status), Archived At (archivedAt), Reason (reason/archiveReason) description-list terms. A nullable archivedAt omits its date term; boolean summary terms render No and Yes; an absent flag remains absent. summary/text/description fallback and authored body override preserve the heading. archivedField, archivedAtField and reasonField lower to their runtime keys. restoredAtField, archivedByField, metadataField, retainHistoryParameter, restoreWindowParameter and allowPartialRestoreParameter are consumed unbound: HTML has no restore, actor or archive metadata term or action. With hideWhenDefault the card renders nothing while it would only state the default: a false flag with no archive date, reason or authored content (s224-m01: a detail page does not state "Archived: No" as content); an archived record, or one with a date or reason, keeps its card. Noninteractive.

## Tokens

The token roles this component reads.

- `summary.background`
- `summary.border`
- `summary.text`
- `summary.label`

## 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.

Readiness evidence

| 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 |

ArchiveSummary 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": "<YourArchiveSummary>",
  "oodsTraits": [
    "Archivable"
  ],
  "substitution": {
    "component": "ArchiveSummary",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourArchiveSummary>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourArchiveSummary>"
    }
  }
}
```

## 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](https://oods-foundry.com/components/archive-summary/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.ArchiveSummary` `sha256:a5e79144f554…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios archive-summary-false-and-reason` `sha256:1704791b9662…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json ArchiveSummary` `sha256:fb8366dd3825…`
- **React readiness**: `@oods/components-react@0.10.1 readiness ArchiveSummary` `sha256:ec786362ee06…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness ArchiveSummary` `sha256:f9bf8f3e007d…`
- **Prop types**: `generated/0.10.1/components/prop-types.json ArchiveSummary` `sha256:cfdc1ad4618a…`