# BrandLockup

> The Digitaltableteur lockup: the mark in its brand disc beside the name in live Satoshi Bold, sized as one unit from the disc height so the parts never drift apart.

- Status: alpha
- Group: display
- Page: https://www.digitaltableteur.com/design-system/components/brand-lockup
- Contract: https://www.digitaltableteur.com/contracts/v1/BrandLockup.contract.json

## When to use

The Digitaltableteur lockup: the mark in its brand disc beside the name in live Satoshi Bold, sized as one unit from the disc height so the parts never drift apart.

## 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 |
| --- | --- | --- | --- | --- |
| `size` | `"sm" \| "md" \| "lg" \| "xl"` | `md` | Disc height 32, 40, 64 or 80 px; the name and the gap scale with it. Defaults to `"md"`. | No |
| `animated` | `boolean` | `false` | Pulses the mark's three leading bars while true, driven by the consumer's hover or focus. Defaults to `false`. | No |
| `className` | `string` | none | Extra class names on the root; set `--brand-lockup-height` here to resize at a breakpoint. | No |

## Variants

- Available sizes: `sm`, `md`, `lg`, `xl` (default `md`).

## Invalid combinations

The contract records no invalid combinations.

## Keyboard

| Key | Behaviour |
| --- | --- |
| General | BrandLockup has no tab stop; wrap it in a link or button to make it interactive. |

## 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 | ARIA: The mark is decorative (aria-hidden); the visible name is the accessible name, also for a link around the lockup. | Not yet verified: no evidence record. WCAG 4.1.2. |
| MUST | ARIA: Inside a link or button, hover and focus-visible scale the disc and recolour the name. | Not yet verified: no evidence record. WCAG 4.1.2. |
| MUST | Required stories produce no axe violations at the configured severity. | Automated by `npm run test:stories:matrix:ci`. WCAG 2.5.8. |
| MUST | The accessibility tree (role, name, state) matches the committed snapshot for every required story. | Automated by `npm run test:stories:matrix:ci`. WCAG 1.3.1, 4.1.2. |
| MUST | The component remains legible and operable under a real browser forced-colors: active pass. | Automated by `npm run test:stories:hc`. |
| MUST | Positional, scale, and opacity motion is suppressed under prefers-reduced-motion. | Not yet verified: no evidence record. WCAG 2.2.2, 2.3.3. |
| MUST | Every documented keyboard interaction works as specified. | Not yet verified: no evidence record. WCAG 2.1.1, 2.1.2. |

## Install and import

- In-repo only. BrandLockup 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/BrandLockup.contract.json
- Markdown version of this page: https://www.digitaltableteur.com/design-system/components/brand-lockup.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.