Skip to main content

Design system components

WipBadge

Storybook-only maturity badge for non-stable components.

Status: beta. Group: feedback. Markdown version: /design-system/components/wip-badge.md

When to use

The Storybook maturity badge shown on non-stable components' stories. Docs chrome; never ships in product UI.

When not to use

The contract records no forbidden uses.

Look-alikes

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

Props

WipBadge props
PropTypeDefaultDescriptionRequired
status"alpha" | "beta" | "stable" | "deprecated"alphaNo description in the contract.No
variant"canvas" | "docs"canvasNo description in the contract.No

Variants

  • Available variants: canvas, docs (default canvas).
  • Allowed status values: alpha, beta, stable, deprecated (default alpha).

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.

WipBadge rules
LevelRuleHow it is checked
MUSTARIA: Role=status.Not yet verified: no evidence record. WCAG 4.1.2.
MUSTThe 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.
MUSTThe component remains legible and operable under a real browser forced-colors: active pass.Automated by npm run test:stories:hc.
MUSTA human completed an end-to-end accessibility review of this component.Manual review, last on 2026-05-28.
MUST NOTMaintainers: Do not bypass design tokens or skip forced-colors verification at beta.Release review; not machine-checked.

Install and import

  • In-repo only. WipBadge is not exported from @digitaltableteur/react, so there is no public import path.