Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Web docs
Data displayGlass surface

ThemeBuilder

Builds scoped token previews with hue, scheme, manual color, and export controls.

FrameworksAstro · React · Elements

Registry commandlumen add ThemeBuilder

InteractionEnhanced runtime

01

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.

AstroSame visual contract, native framework API

Brand 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.
astro
---
import { Label, ThemeBuilder } from '@santi020k/lumen-astro'
---

<ThemeBuilder data-ui-theme-target="#ex-theme-preview">
  <header><h3>Brand theme</h3></header>
  <div style="display: grid; gap: 0.45rem;">
    <Label for="ex-theme-hue">Brand hue</Label>
    <input
      id="ex-theme-hue"
      data-ui-theme-brand-hue
      type="range"
      class="ui-slider"
      min="0"
      max="359"
      value="264"
    />
    <Label for="ex-theme-accent">Accent hue</Label>
    <input
      id="ex-theme-accent"
      data-ui-theme-accent-hue
      type="range"
      class="ui-slider"
      min="0"
      max="359"
      value="54"
    />
  </div>
  <div id="ex-theme-preview" style="display: flex; gap: 0.5rem; padding: 0.5rem;">
    <span data-ui-swatch style="--ui-swatch:hsl(var(--brand))"></span>
    <span data-ui-swatch style="--ui-swatch:hsl(var(--accent))"></span>
  </div>
  <div style="display: flex; gap: 0.5rem; flex-wrap: wrap;">
    <button class="ui-button" data-ui-theme-export type="button">Export CSS</button>
    <button class="ui-button ui-button--outline" data-ui-theme-import type="button">Import CSS</button>
    <button class="ui-button ui-button--secondary" data-ui-theme-check-contrast type="button">Fix Contrast</button>
  </div>
  <textarea class="ui-textarea" data-ui-theme-output aria-label="Theme CSS"></textarea>
</ThemeBuilder>
Edit ThemeBuilder in browser
02

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.

bash@santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
bashAstro wrapper
lumen add ThemeBuilder
lumen add ThemeBuilder

Glass

Add the glass prop to apply the shared blur, saturation, border, and highlight tokens. Glass reads best over vivid content, so place the surface above imagery or color.

AstroSame visual contract, native framework API

Brand 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.
astro
---
import { Label, ThemeBuilder } from '@santi020k/lumen-astro'
---

<div class="docs-glass-demo">
  <ThemeBuilder data-ui-theme-target="#ex-glass-theme-preview" glass>
    <header><h2>Brand theme</h2></header>
    <div style="display: grid; gap: 0.45rem;">
      <Label for="ex-glass-theme-hue">Brand hue</Label>
      <input
        id="ex-glass-theme-hue"
        data-ui-theme-brand-hue
        type="range"
        class="ui-slider"
        min="0"
        max="359"
        value="264"
      />
      <Label for="ex-glass-theme-accent">Accent hue</Label>
      <input
        id="ex-glass-theme-accent"
        data-ui-theme-accent-hue
        type="range"
        class="ui-slider"
        min="0"
        max="359"
        value="54"
      />
    </div>
    <div id="ex-glass-theme-preview" style="display: flex; gap: 0.5rem; padding: 0.5rem;">
      <span data-ui-swatch style="--ui-swatch:hsl(var(--brand))"></span>
      <span data-ui-swatch style="--ui-swatch:hsl(var(--accent))"></span>
    </div>
    <div style="display: flex; gap: 0.5rem; flex-wrap: wrap;">
      <button class="ui-button" data-ui-theme-export type="button">Export CSS</button>
      <button class="ui-button ui-button--outline" data-ui-theme-import type="button">Import CSS</button>
      <button class="ui-button ui-button--secondary" data-ui-theme-check-contrast type="button">Fix Contrast</button>
    </div>
    <textarea class="ui-textarea" data-ui-theme-output aria-label="Theme CSS"></textarea>
  </ThemeBuilder>
</div>
Edit ThemeBuilder in browser

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.

AttributeValuesDefaultDescription
glassboolean | "subtle" | "strong"falseApplies the tokenized liquid-glass surface treatment with backdrop-filter fallbacks; "subtle" and "strong" adjust the fill intensity.
data-ui-theme-targetCSS selectordocumentElementSelects the element that receives generated theme variables.
data-ui-theme-brand-huerange or number input-Controls the generated brand hue.
data-ui-theme-exportbutton attribute-Exports the current theme in the selected CSS, Figma, or design-token format.
class, classNamestring""Merges custom classes with the generated ui-* root classes.
...native attributesHTML attributes-Forwards standard attributes to the root element unless the component consumes them.

Runtime events

CustomEvents dispatched by the Astro UIPrimitives runtime for this component.

EventTargetDetailWhen
ui:theme-changeThemeToggle control ([data-ui-theme-toggle]){ previousTheme?: string, storageKey: string, theme: string }Fires after ThemeToggle applies and persists a new document theme.
ui:theme-changeThemeBuilder root ([data-ui-theme-builder]){ hue: number, accentHue: number, mode: 'generated' | 'manual', scheme: 'dark' | 'light', tokens: Record<string, string> }Fires after ThemeBuilder hue, manual color, mode, or scheme controls update theme tokens on the target element.
ui:theme-exportThemeBuilder root ([data-ui-theme-builder]){ css?: string, format: 'css' | 'figma' | 'tokens', tokens: Record<string, string> | null, value: string }Fires after a [data-ui-theme-export] control writes the selected CSS, Figma, or design-token export to the output and clipboard when available.

Web docsFull catalog