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

# CardHeader

Labels a card with a title and supporting text.

Generated from @oods/foundry 0.10.1

- Categories

  content

- 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 `card-header-supporting-text` : mount, h2 heading and visible supporting text.

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

The real CardHeader, live

React

## Account summary

Current subscription

Vue

## Account summary

Current subscription

## Code

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

**React**

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

export function Example() {
  return (
    <CardHeader
      title="Account summary"
      supportingText="Current 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 |
| - | - | - | - |
| `title` | `string \| undefined` | no | `Account summary` |
| `label` | `string \| undefined` | no | |
| `text` | `string \| undefined` | no | |
| `supporting` | `string \| undefined` | no | |
| `supportingText` | `string \| undefined` | no | `Current subscription` |
| `subtitle` | `string \| undefined` | no | |
| `description` | `string \| undefined` | no | |
| `level` | `HeaderLevel \| undefined` | no | |
| `as` | `HeaderElement \| undefined` | no | |

### Slots

default

### Events

none

## States

default

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

- A real heading element follows as/level with default h3
- Supporting text remains visible beside the heading

Mirrors renderCardHeader title and supporting-text aliases and headingTag(level, 3); as selects a heading element, and authored default-slot content is preserved.

## Tokens

The token roles this component reads.

- `header.title`
- `header.subtitle`

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

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

## 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/card-header/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.CardHeader` `sha256:7f20d86371d0…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios card-header-supporting-text` `sha256:d57037e69291…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json CardHeader` `sha256:1ded754e9850…`
- **React readiness**: `@oods/components-react@0.10.1 readiness CardHeader` `sha256:84083a07301f…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness CardHeader` `sha256:cb2353542d53…`
- **Prop types**: `generated/0.10.1/components/prop-types.json CardHeader` `sha256:a3d81244ed41…`