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

# AuditTimeline

Lists entries from a record's audit log.

Generated from @oods/foundry 0.10.1

- Categories

  lifecycle

- Contexts

  detail, timeline

- Readiness

  `react-and-vue`

## Playground

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

Documented example `audit-timeline-transitions` : mount, one ordered audit event is visible.

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

The real AuditTimeline, live

React

## Audit Timeline

1. Subscription created

   Sep 5, 2026, 12:00 PM

Vue

## Audit Timeline

1. Subscription created

   Sep 5, 2026, 12:00 PM

## Code

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

**React**

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

const events = [
  {
    "label": "Subscription created",
    "timestamp": "2026-09-05T12:00:00Z"
  }
];

export function Example() {
  return (
    <AuditTimeline
      events={events}
    />
  );
}
```

## 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` | `ReactNode` | no | |
| `events` | `readonly unknown[] \| undefined` | no | `[{"label":"Subscription created","timestamp":"2026-09-05T12:00:00Z"}]` |
| `history` | `readonly unknown[] \| undefined` | no | |
| `entries` | `readonly unknown[] \| undefined` | no | |
| `auditLog` | `readonly unknown[] \| undefined` | no | |
| `maxVisible` | `number \| undefined` | no | |
| `showFromState` | `boolean \| undefined` | no | |
| `showActorId` | `boolean \| undefined` | no | |
| `showReason` | `boolean \| undefined` | no | |

### Slots

default

### Events

none

## States

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

- Ordered audit events retain chronological semantics
- Empty history is named

Configures the shared timeline primitive with audit semantics.

## Tokens

The token roles this component reads.

- `timeline.background`
- `timeline.border`
- `timeline.text`
- `timeline.marker`

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

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 |

AuditTimeline 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": "<YourAuditTimeline>",
  "oodsTraits": [
    "Auditable",
    "Timestampable"
  ],
  "substitution": {
    "component": "AuditTimeline",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourAuditTimeline>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourAuditTimeline>"
    }
  }
}
```

## 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/audit-timeline/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.AuditTimeline` `sha256:01c5c27e424a…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios audit-timeline-transitions` `sha256:5a9874a6ef8b…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json AuditTimeline` `sha256:28049d3d9e26…`
- **React readiness**: `@oods/components-react@0.10.1 readiness AuditTimeline` `sha256:6341b4eee6d8…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness AuditTimeline` `sha256:822614aab958…`
- **Prop types**: `generated/0.10.1/components/prop-types.json AuditTimeline` `sha256:bb73138169ca…`
