# ArticleLayout

> Blog article page layout shell.

- Status: alpha
- Group: layout
- Page: https://www.digitaltableteur.com/design-system/components/article-layout
- Contract: https://www.digitaltableteur.com/contracts/v1/ArticleLayout.contract.json

## When to use

Blog article page layout shell.

## 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 |
| --- | --- | --- | --- | --- |
| `nav` | `ReactNode` | none | Navigation slot (back link, etc.) | No |
| `hero` | `ReactNode` | none | Hero section. | Yes |
| `children` | `ReactNode` | none | Main content area. | Yes |
| `sidebar` | `ReactNode` | none | Sidebar content (TOC, etc.) | No |
| `relatedPosts` | `ReactNode` | none | Related posts section. | No |
| `showReadingProgress` | `boolean` | `true` | Show reading progress indicator. | No |
| `contentRef` | `RefObject<HTMLElement \| null>` | none | Ref for reading progress tracking. | No |
| `className` | `string` | none | Custom className. | No |
| `lang` | `string` | `en` | Document language for the article root. | No |

## Variants

No variant dimensions and no props with a fixed set of values.

## 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. ArticleLayout 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/ArticleLayout.contract.json
- Markdown version of this page: https://www.digitaltableteur.com/design-system/components/article-layout.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.
