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

# CancellationSummary

Shows the recorded cancellation terms for an item.

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 `cancellation-summary-boolean` : mount, scheduled cancellation label is visible; with hideWhenDefault a scheduled or recorded cancellation keeps its card, and a false flag with nothing recorded renders nothing.

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

The real CancellationSummary, live

React

## Cancellation Summary

- Cancel at period end

  Yes

- Requested at

  Sep 5, 2026, 12:00 PM

- Reason

  Customer request

Vue

## Cancellation Summary

- Cancel at period end

  Yes

- Requested at

  Sep 5, 2026, 12:00 PM

- Reason

  Customer request

## Code

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

**React**

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

export function Example() {
  return (
    <CancellationSummary
      cancelAtPeriodEnd={true}
      requestedAt="2026-09-05T12:00:00Z"
      reason="Customer request"
    />
  );
}
```

## 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 | |
| `label` | `ReactNode` | no | |
| `cancelAtPeriodEnd` | `boolean \| undefined` | no | `true` |
| `requestedAt` | `string \| undefined` | no | `2026-09-05T12:00:00Z` |
| `reason` | `ReactNode` | no | `Customer request` |
| `code` | `string \| undefined` | no | |
| `hideWhenDefault` | `boolean \| undefined` | no | |

### Slots

default

### Events

none

## States

scheduled, not-scheduled

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

- Summary terms and values preserve description-list relationships

Boolean cancellation state renders a declared label, never a raw boolean literal. With hideWhenDefault the card renders nothing while it would only state the default: cancelAtPeriodEnd false with no request time, reason, code or authored content (s224-m01: a detail page does not state "Cancel at period end: No" as content); a scheduled or recorded cancellation keeps its card.

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

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

## 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/cancellation-summary/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.CancellationSummary` `sha256:bc11810173f6…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios cancellation-summary-boolean` `sha256:e1ae4a62fcda…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json CancellationSummary` `sha256:c6b49d9d72f5…`
- **React readiness**: `@oods/components-react@0.10.1 readiness CancellationSummary` `sha256:39e85aa08ea6…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness CancellationSummary` `sha256:8884fd83aba7…`
- **Prop types**: `generated/0.10.1/components/prop-types.json CancellationSummary` `sha256:752a5806ccb0…`