Documentation
Actions
ThemeToggle
Switches between the configured light and dark color themes.
01
See it in context
Preview
Change the site theme
02
Copy a working example
Usage
---
import { ThemeToggle } from '@santi020k/lumen-astro'
---
<div class="flex items-center gap-3">
<ThemeToggle />
<span class="text-sm text-ink-soft">Change the site theme</span>
</div>---
import { ThemeToggle } from '@santi020k/lumen-astro'
---
<div class="flex items-center gap-3">
<ThemeToggle />
<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 />
<span className="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 />
<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></lumen-theme-toggle>
<span class="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></lumen-theme-toggle>
<span class="text-sm text-ink-soft">Change the site theme</span>
</div>03
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-astropnpm add @santi020k/lumen-astrolumen add ThemeTogglelumen add ThemeTogglepnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add ThemeToggle --target reactlumen add ThemeToggle --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add ThemeToggle --target elementslumen add ThemeToggle --target elementsAPI 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 |
|---|---|---|---|
| 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. |