Theme Switcher
The UI half of the two-axis theme contract (`styles/index.css`, `src/lib/use-theme.ts`). Two controls, because the two axes are genuinely different questions and a single control that tries to serve both ends up as a four-item list called "Light / Dark /…
Preview
Rendered from the story the storybook (a11y) CI gate runs axe against — the preview can't show something that hasn't been verified.
Install
Two equivalent paths — the URL works in any shadcn-CLI setup; the alias works once you've registered @interlace in your components.json.
npx shadcn@latest add https://ds.interlace.tools/r/theme-switcher.jsonnpx shadcn@latest add @interlace/theme-switcherBehavior
What this component does — the keyboard path, the measured colour, the text equivalent and the states it can be in. Every figure below is read out of the test or the source that enforces it by scripts/build-behavior-map.mjs, so nothing here can outlive the gate that keeps it true.
5 steps, 4 key presses — replayed on every PR by the play function of KeyboardFlow. Axe cannot press a key, so this — not the a11y scan — is what proves the component is operable without a mouse.
- 1The trigger advertises the menu it owns
- 2Enter opens the menu and focuses a radio itemEnterTab
- 3The active theme is announced as checked
- 4ArrowDown roves to the next itemArrowDown
- 5Escape closes and restores focus to the triggerEscape
Measured contrast
packages/ui/__tests__/theme-contract-lock.test.ts ↗Every semantic colour pair this component's own source uses, measured against the shipped hexes in all 4 theme × scheme combinations. The tightest is input on card at 3.11:1 (interlace · dark), against a floor of 3:1.
| Pair | interlacelight | interlacedark | harborlight | harbordark | Floor |
|---|---|---|---|---|---|
| input on cardcontrol border inside a card | 3.62:1 | 3.11:1 | 3.62:1 | 3.85:1 | 3.0:1SC 1.4.11 |
| input on backgroundcontrol border (SC 1.4.11) | 3.62:1 | 3.35:1 | 3.43:1 | 4.25:1 | 3.0:1SC 1.4.11 |
| ring on backgroundfocus ring (SC 2.4.13) | 8.80:1 | 11.79:1 | 8.39:1 | 10.03:1 | 3.0:1SC 1.4.11 |
| ring on cardfocus ring inside a card | 8.80:1 | 10.92:1 | 8.86:1 | 9.10:1 | 3.0:1SC 1.4.11 |
| accent-foreground on accenthover/highlight face | 8.98:1 | 10.46:1 | 8.95:1 | 9.65:1 | 4.5:1SC 1.4.3 |
| foreground on backgroundbody copy | 19.65:1 | 16.97:1 | 17.74:1 | 16.19:1 | 4.5:1SC 1.4.3 |
Text pairs are held to 4.5:1 (WCAG 2.2 SC 1.4.3); borders, rings and chart axes to 3:1 (SC 1.4.11 non-text). Bold is the worst cell in the row — the one a brand fork has to keep an eye on.
Runtime contract
packages/ui/vitest.config.ts ↗Where it renders, how narrow it survives, and whether its lines are inside the coverage gate — three answers a consumer needs before the paste, not after the bug.
- Render boundary
'use client'Hydrates. It brings JavaScript to any route that imports it — put the boundary here, not at the page.
- Minimum viewport
MIN_VIEWPORT = 320Declared, not assumed. Below 320 CSS px the preflight contract draws a dev-mode outline — how to switch it on.
- Coverage gate
not in the gateThe 100% gate currently covers
src/charts/**/*.{ts,tsx}andsrc/lib/**/*.{ts,tsx}andsrc/primitives/{button-variants,data-state-model,meter-scale,skeleton-variants}.tsandsrc/primitives/{alert,aspect-ratio,avatar,badge,box,breadcrumb,button,callout,card,checkbox,container,data-state,focus-ring,grade-badge,grid,input,label,meter,pagination,published-date,reading-time,section,section-boundary,separator,skip-link,stack,stat-strip,tag,textarea,typography,visually-hidden}.tsx. This file is outside it — the glob widens in phase 7.2.
History
This component is at v1.0.0, first shipped in @interlace/ui 1.0.0. The version is stamped as a banner into the file the install writes, so the copy in your tree says which one you have — compare it with the number above before deciding whether to re-run the install.
@interlace/ui 1.1.01 entry
- Changedpatch
Two theme defects that only a browser could find, both of which read as "the theme system does not work".
useTheme()now keeps every instance in the SAME document in sync. Each instance owned private React state and only listened forstorageevents — which fire in OTHER documents — so a switcher in the nav updated itself and nothing else. A page with a switcher plus any second theme-aware component repainted the switcher and left the component on the previous theme, permanently. Harbor now declares its dark palette for[data-theme='harbor'] .darkand[data-theme='harbor'] [data-scheme='dark']as well as the same-element forms. The bare.darkblock is unscoped, so it means "Interlace dark": it re-declares every--interlace-*literal on whatever element carries it, and[data-theme='harbor'].darkneeds both on the same element. A<div class="dark">anywhere inside a Harbor page therefore repainted that subtree in the default brand.theme-contract-locknow requires the descendant forms from every registered theme.
Import
4 named exports — pull the parts you need.
import { MIN_VIEWPORT, ThemeSchemeToggle, ThemeSwitcher, themeSwitcherVariants } from '@/components/ui/theme-switcher';Anatomy
Extracted from the primitive's JSDoc header. The source is the only documentation that can't drift.
<ThemeSwitcher> ← DropdownMenuTrigger (button)
└ popup ← data-min-viewport, role="menu"
├ "Theme" radiogroup ← one item per registered theme
├ separator
└ "Appearance" radiogroup ← Light / Dark / System
<ThemeSchemeToggle> ← Base UI Toggle, aria-pressedVariants
Closed prop unions enforced by class-variance-authority. See Storybook's Variants story for the rendered matrix.
- size
- sm
- defaultdefault
API reference
Parsed from the type declarations in the source — the same file the install writes into your tree, so this table can't drift from the component you get.
ThemeSwitcherProps
Plus the variant props listed above.
| Prop | Type | Description |
|---|---|---|
| label | string | Accessible name for the trigger. Default: `'Theme'`. |
| align | React.ComponentProps<typeof DropdownMenuContent>['align'] | Popup alignment against the trigger. |
| side | React.ComponentProps<typeof DropdownMenuContent>['side'] | Popup side. |
ThemeSchemeToggleProps
| Prop | Type | Description |
|---|---|---|
| label | string | Accessible name. Default: `'Dark mode'`. |
Accessibility
Every story for this component is rendered headlessly and checked with axe-core (wcag2aa, wcag22aa, best-practice, ACT) on every PR. That gate has no continue-on-error, so what ships has zero known violations.
What follows is what static analysis can see. Axe cannot press a key and never sees an overlay open, so the operable-without-a-mouse claim lives in Behavior instead, where the keyboard path is replayed step by step.
- Focus + keyboard behaviour
- Native element semantics — no interaction layer to get wrong.
- Focus ring (WCAG 2.2 SC 2.4.13)
- Inherited from the preflight focus contract shipped in @interlace/theme.
- Reduced motion
- No animation to gate.
- ARIA in the source
role="menu"aria-currentaria-hiddenaria-label
Examples
4 more states from the same story file.
R-rule compliance
Every primitive in @interlace/ui models to the portable 26-rule floor enforced by the componentApi ESLint preset. The cells below pin exactly where each rule applies in this file.
| Rule | Concept | Where |
|---|---|---|
| R4 | Extends the underlying part | `ComponentProps<typeof DropdownMenuTrigger> & VariantProps<…>` |
| R6 | data-slot on every part | `theme-switcher` / `-content` / `-item` / `theme-scheme-toggle` |
| R7 | className merged + ...rest | `cn(themeSwitcherVariants(…), className)` + `{...props}` |
| R8 | No `isXxx`; enums for >2 states | `size` (sm/default); scheme is a 3-value enum, not a boolean |
| R11 | One variable per part | Trigger owns `size`; the menu owns nothing configurable |
| R12 | Reuse over wrap | Composes DropdownMenu / Toggle rather than re-implementing them |
| R13 | Ecosystem first | `@base-ui/react/menu` owns menuitemradio + typeahead + Escape |
| R14 | Declares min viewport | `data-min-viewport={String(MIN_VIEWPORT)}` + exported const |
| R17 | API parity | `value`/`onValueChange` naming inherited from Base UI + MUI |
| R18 | Tailwind only | Zero inline `style`; cva classes only |
| R19 | Tokens only | bg-background / text-foreground / ring — no hex, no palette escape |
| R20 | AA contrast | Every pair is a theme token measured by `theme-contract-lock` |
| R25 | Client component | localStorage + matchMedia + DOM writes |
| R26 | A11y from upstream | role=menuitemradio + aria-checked (menu), aria-pressed (toggle) |
Minimum viewport
This primitive declares MIN_VIEWPORT = 320 CSS px (DESIGN_PRINCIPLES #14). When mounted in a container narrower than this, the preflight contract draws a dev-mode outline so the regression is visible during local development.
<body data-interlace-dev>...</body>
Add the data-interlace-dev attribute to the body in development builds only — preflight then outlines any primitive whose container is below its declared data-min-viewport.
Dependencies
- Base UI primitive
- Native / no Base UI dependency
- Lucide icons
MonitorIconMoonIconSunIcon
- NPM dependencies
class-variance-authoritylucide-react
Source
The full implementation — components/ui/theme-switcher.tsx once installed.
'use client';
import * as React from 'react';
// @interlace/theme-switcher v1.0.0 — Interlace design system.
// Docs, props and live preview: https://ds.interlace.tools/c/theme-switcher
// What changed since: https://ds.interlace.tools/c/theme-switcher#history
// Generated banner — keep it, the upgrade diff reads this version.
/**
* @interlace/ui — ThemeSwitcher + ThemeSchemeToggle
*
* The UI half of the two-axis theme contract (`styles/index.css`,
* `src/lib/use-theme.ts`). Two controls, because the two axes are genuinely
* different questions and a single control that tries to serve both ends up
* as a four-item list called "Light / Dark / Harbor / Harbor Dark" — a
* cross-product that grows multiplicatively with every theme added.
*
* ThemeSwitcher menu: which THEME × which SCHEME (two radio groups)
* ThemeSchemeToggle one-click light ⇄ dark, for a nav bar
…292 more lines…Registry JSON
The raw registry record — what the shadcn CLI fetches.