Actions

ThemeToggle

Switches between the configured light and dark color themes.

View preview API reference View in Figma

FrameworksAstro · React · Elements

Registry commandlumen add ThemeToggle

InteractionNative markup

Design sourceLinked component node

See it and copy it

Framework example

Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.

Change the site theme

Framework usage

Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens and ui-* class contract.

---
import { ThemeToggle } from '@santi020k/lumen-astro'
---

<div class="flex items-center gap-3">
  <ThemeToggle controlled />
  <span class="text-sm text-ink-soft">Change the site theme</span>
</div>

import { ThemeToggle } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <div className="flex items-center gap-3">
      <ThemeToggle controlled />
      <span className="text-sm text-ink-soft">Change the site theme</span>
    </div>
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<div class="flex items-center gap-3">
  <lumen-theme-toggle controlled></lumen-theme-toggle>
  <span class="text-sm text-ink-soft">Change the site theme</span>
</div>

Edit ThemeToggle in browser

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

pnpm add @santi020k/lumen-astro

pnpm add @santi020k/lumen-astro

lumen add ThemeToggle

lumen add ThemeToggle

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add ThemeToggle --target react

lumen add ThemeToggle --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add ThemeToggle --target elements

lumen add ThemeToggle --target elements

API reference

Lumen-specific props and runtime attributes for the Astro primitive. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.

Attribute	Values	Default	Description
storageKey	string	"lumen-theme"	Sets the local-storage key used to persist the selected theme.
lightTheme, darkTheme	string	"light", "dark"	Sets the data-theme values toggled on the document element.
controlled	boolean	false	Disables automatic theme changes when the host application owns theme state.
class, className	string	""	Merges custom classes with the generated ui-* root classes.
...native attributes	HTML attributes	-	Forwards standard attributes to the root element unless the component consumes them.