Skip to main content

Design system components

ThemeProvider

Theme context for light, dark, and high-contrast modes.

Status: beta. Group: utility. Markdown version: /design-system/components/theme-provider.md

When to use

Context provider owning the light/dark/high-contrast theme state, class application, and persistence. Mounted once by the app shell.

When not to use

The contract records no forbidden uses.

Look-alikes

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

Props

ThemeProvider props
PropTypeDefaultDescriptionRequired
childrenReact.ReactNodenoneSubtree that receives the theme context.Yes
forcedTheme"light" | "dark" | "hcb" | "hcw"nonePin the theme regardless of stored/system preference (e.g. external embeds).No

Variants

  • Allowed forcedTheme values: light, dark, hcb, hcw.

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.

ThemeProvider rules
LevelRuleHow it is checked
MUSTRequired stories produce no axe violations at the configured severity.Automated by npm run test:stories:matrix:ci. WCAG 2.5.8.
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

  • Install: npm install @digitaltableteur/react (version 0.9.1, restricted access on npm).
  • Import: import { ThemeProvider } from "@digitaltableteur/react";
  • Entry point: @digitaltableteur/react/runtime exports it too.
  • Styles: import @digitaltableteur/react/style.css once at the app boundary.