# ProjectHero

> Case study hero with project title and summary.

- Status: alpha
- Group: content
- Page: https://www.digitaltableteur.com/design-system/components/project-hero
- Contract: https://www.digitaltableteur.com/contracts/v1/ProjectHero.contract.json

## When to use

Case study hero with project title and summary.

## When not to use

The contract records no forbidden uses.

## Look-alikes

The contract names no look-alike with a deciding condition.

## Props

| Prop | Type | Default | Description | Required |
| --- | --- | --- | --- | --- |
| `title` | `string` | none | Project title. | Yes |
| `description` | `string` | none | Project description/tagline. | No |
| `image` | `ProjectHeroImage` | none | Hero image. | No |
| `video` | `ProjectHeroVideo` | none | Hero video (takes precedence over image when provided) | No |
| `category` | `string` | none | Project category. | No |
| `tags` | `string[]` | none | Project tags. | No |
| `tagHref` | `(tag: string) => string` | none | Makes each tag a link, for example to the work index filtered by it. | No |
| `moreTags` | `string[]` | none | More tags, shown after a "+N more" chip so the hero stays compact. | No |
| `date` | `string` | none | Project date/duration. | No |
| `liveUrl` | `string` | none | Live project URL. | No |
| `variant` | `"contained" \| "full-width" \| "split"` | `contained` | Hero layout variant. | No |
| `className` | `string` | none | Custom className. | No |

## Variants

- Available variants: `full-width`, `contained`, `split` (default `full-width`).

## Invalid combinations

The contract records no invalid combinations.

## Keyboard

The contract records no keyboard interaction.

## Rules

Every item under When not to use is a MUST NOT. MUST and SHOULD follow RFC 2119.

| Level | Rule | How it is checked |
| --- | --- | --- |
| MUST | Required stories produce no axe violations at the configured severity. | Not yet verified: no evidence record. WCAG 2.5.8. |
| MUST | The accessibility tree (role, name, state) matches the committed snapshot for every required story. | Not yet verified: no evidence record. WCAG 1.3.1, 4.1.2. |
| MUST | The component remains legible and operable under a real browser forced-colors: active pass. | Not yet verified: no evidence record. |
| MUST NOT | Maintainers: Do not invent parallel primitives inside this folder. | Release review; not machine-checked. |
| MUST NOT | Maintainers: Do not promote to stable without production consumer evidence. | Release review; not machine-checked. |

## Install and import

- In-repo only. ProjectHero is not exported from `@digitaltableteur/react`, so there is no public import path.
- Alpha components are internal and never exported.

## Links

- Machine-readable contract (Design System Contract 1.0): https://www.digitaltableteur.com/contracts/v1/ProjectHero.contract.json
- Markdown version of this page: https://www.digitaltableteur.com/design-system/components/project-hero.md
- Component index as JSON: https://www.digitaltableteur.com/design-system/components.json
- All components: https://www.digitaltableteur.com/design-system/components
- Source: The implementation lives in a private repository. This page, its Markdown twin and the contract are generated from it at build time and are the public source of truth.