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

# ArchivedRowOverlay

Marks an archived collection row while retaining its content.

Generated from @oods/foundry 0.10.1

- Categories

  lifecycle

- Contexts

  list

- Readiness

  `proven-in-generated-apps`

## Playground

This component's contract doesn't list typed props, so the playground shows its documented example.

Documented example `archived-row-presentation` : mount, Archived row stays accessible and its badge and tab label agree.

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

The real ArchivedRowOverlay, live

React

Archived

Vue

Archived

## Code

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

**React**

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

export function Example() {
  return (
    <ArchivedRowOverlay
      isArchived={true}
      showBadge={true}
      separateTab={true}
      tabLabel="Archived"
      label="Team subscription"
    />
  );
}
```

## 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 |
| - | - | - | - |
| `isArchived` | `boolean \| undefined` | no | `true` |
| `showBadge` | `boolean \| undefined` | no | `true` |
| `separateTab` | `boolean \| undefined` | no | `true` |
| `tabLabel` | `string \| undefined` | no | `Archived` |
| `label` | `string \| undefined` | no | `Team subscription` |

### Slots

default

### Events

none

## States

active, archived

## Accessibility

- Role

  `none`

- How it gets its name

  `none` on `:root`

### Keyboard

The contract lists no keyboard behaviour.

### Obligations in the contract

- Native semantic elements retain their names and content
- Trait-declared grayed presentation: only archived rows are dimmed and optionally badged, retain aria-hidden=false and announce Archived plus the supplied entity label. Active content has no state announcement or opacity. archivedField lowers to isArchived. The authored style=grayed directive is consumed as the one supported token presentation; other values fail. separateTab and tabLabel are presentation metadata used by the generated workflow list to separate archived records; this row primitive owns no collection or navigation.

Trait-declared grayed presentation: only archived rows are dimmed and optionally badged, retain aria-hidden=false and announce Archived plus the supplied entity label. Active content has no state announcement or opacity. archivedField lowers to isArchived. The authored style=grayed directive is consumed as the one supported token presentation; other values fail. separateTab and tabLabel are presentation metadata used by the generated workflow list to separate archived records; this row primitive owns no collection or navigation.

## Tokens

The token roles this component reads.

- `billing.text`
- `billing.surface`
- `billing.border`

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

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

## 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/archived-row-overlay/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.ArchivedRowOverlay` `sha256:784916a78734…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios archived-row-presentation` `sha256:537a104dd8fa…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json ArchivedRowOverlay` `sha256:1cc4987c4eca…`
- **React readiness**: `@oods/components-react@0.10.1 readiness ArchivedRowOverlay` `sha256:fcf41145365d…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness ArchivedRowOverlay` `sha256:5729718b997a…`
- **Prop types**: `generated/0.10.1/components/prop-types.json ArchivedRowOverlay` `sha256:b90d93b13aa5…`