Skip to content

control · Canvas 2D

FlameSwitch

An on/off switch with a pilot flame on its knob that catches when you turn it on.

On/off switch with a live pilot flame on its knob

  • Canvas 2D
  • Reduced motion: static
  • 2.98 KB gzip
  • Layout shift 0
View the source Spec sheet as Markdown

Install

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

Playground

Palette
Your code
import { FlameSwitch } from "@/components/ui/flame-switch";

<FlameSwitch label="Pilot flame" />

In a full example

The full example loads as you scroll to it.

Accessibility

  • A native <button role="switch"> with aria-checked and the required `label` as its accessible name. The flame canvas is aria-hidden; the visible status text under the switch follows the state.
  • Keyboard: A native button with role=switch: Space and Enter toggle, focus ring visible
  • Touch: Tap toggles; no hover effect
  • WCAG criteria it is built for: 1.4.11, 2.1.1, 2.4.7, 4.1.2

Props

PropTypeDefaultWhat it does
labelstringnoneRequired. The switch's accessible name.
checkedbooleannoneControlled state. Leave undefined for an uncontrolled switch.
defaultCheckedbooleanfalseInitial state when uncontrolled.
onCheckedChange(checked: boolean) => voidnoneCalled with the new state on every press.
statusText{ on: string; off: string } | null"{ on: \"Pilot on\", off: \"Pilot off\" }"Visible status under the switch; null hides it.
disabledbooleanfalseDisables the switch.
palette"fire" | "ice" | "neon" | "mono" | "custom""fire"Flame colours (DESIGN.md A8). custom reads --fb-heat-0..4 from the page.
pausedbooleanfalseUniversal pause prop: the flame stops drawing; the switch still works.
maxTiernumber3Hard ceiling on the capability tier (0 = switch only).
noncestringnoneCSP nonce for the component's <style> element.
classNamestring""Extra classes on the root (fb-flame-switch is kept).
styleReact.CSSPropertiesnoneInline styles on the root, merged after the palette variables.
refReact.Ref<HTMLDivElement>noneReceives the root <div>.

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, gzip2.98 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 (static): The switch alone: no canvas, no flame, the knob moves without a transition. The state and the status text work as usual.

TierWhat it does
T3 FullFlame on a canvas at DPR ≤ 2 with the full particle count
T2 StandardFlame on a canvas at DPR ≤ 1.5 with half the flame particles
T1 LiteSame as tier 2
T0 StaticThe switch only (server render, reduced motion, Save-Data, no WebGL2): no canvas

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