Skip to content

control · Canvas 2D

EclipseSwitch

A light and dark switch where the moon slides across the sun until only the corona is left.

Light/dark theme switch: the moon slides across the sun until only the corona remains

  • Canvas 2D
  • Reduced motion: still-frame
  • 3.18 KB gzip
  • Layout shift 0
View the source Spec sheet as Markdown

Install

Install
pnpm dlx shadcn@4.21.1 add @frictionborn/eclipse-switch

Playground

Palette
Your code
import { EclipseSwitch } from "@/components/ui/eclipse-switch";

<EclipseSwitch />

In a full example

The full example loads as you scroll to it.

Accessibility

  • A native <button role="switch"> with aria-checked; its visible label is its name. The status (Day / Totality) is aria-live=polite. Before the canvas mounts a CSS sun shows the state. The sky canvas is aria-hidden.
  • Keyboard: A native <button role=switch>: Space and Enter toggle
  • Touch: Tap the switch
  • WCAG criteria it is built for: 1.4.3, 2.1.1, 4.1.2, 4.1.3

Props

PropTypeDefaultWhat it does
checkedbooleannoneControlled state: true is the eclipse (dark).
defaultCheckedbooleanfalseInitial state when uncontrolled.
onCheckedChange(checked: boolean) => voidnoneCalled with the new state.
labelstring"Eclipse mode"Visible label and accessible name of the switch.
statusText{ on: string; off: string } | null"{ on: \"Totality\", off: \"Day\" }"Visible, announced status; null hides it.
palette"fire" | "ice" | "neon" | "mono" | "custom""fire"Colours of the effect (DESIGN.md A8). custom reads --fb-heat-0..4 from the page.
pausedbooleanfalseUniversal pause prop: the effect stops drawing; the control keeps working.
maxTiernumber3Hard ceiling on the capability tier.
noncestringnoneCSP nonce for the component's <style> element.
classNamestring""Extra classes on the root.
styleReact.CSSPropertiesnoneInline styles on the root, merged after the palette variables.
refReact.Ref<HTMLDivElement>noneReceives the root element.

Measured on the bench

Measured by the automated bench at commit 801163e on 2026-10-21. These numbers are written by the bench, never by hand.

MeasureResult
Size, gzip3.18 KB at load, 0.02 KB loaded later
Layout shift0
Frames when nothing should moveoff screen 0, hidden tab 0, reduced motion 0
axe accessibility scan0 serious, 0 critical

Browsers it ran in

Automated Playwright runs, some with device emulation. Results from physical phones and tablets are still pending, so none are listed.

EnvironmentTierResultDateNotes
Chromium Desktop (SwiftShader)3pass2026-10-2116 passed, 0 failed
Chromium Mobile (Pixel 7 emulation)2pass2026-10-2115 passed, 0 failed
Firefox Desktop3pass2026-10-2114 passed, 0 failed
WebKit Desktop3pass2026-10-2115 passed, 0 failed
WebKit Mobile (iPhone 14 emulation)2pass2026-10-2115 passed, 0 failed

On different devices

Reduced motion (still-frame): The sky jumps straight to day or totality: one frame per change, no sliding moon.

TierWhat it does
T3 FullAnimated at DPR <= 2 with the full particle count
T2 StandardAnimated at DPR <= 1.5 with half the particles
T1 LiteSame as tier 2
T0 StaticOne still frame on the canvas (reduced motion, Save-Data, no WebGL2), redrawn only when the value changes

Content Security Policy

  • Works without 'unsafe-eval'.
  • Uses the reveal gate ([data-motion="ok"]): render <MotionReadyScript /> in <head> (with your nonce), or call initMotionReady() in Vite.
  • Sets inline style attributes, so allow style-src-attr 'unsafe-inline'.

Goes well with