Brand
VisualEffect
Adds optional token-based backgrounds, highlights, and drawing effects.
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.
A clearer project workspace
Mesh colors follow the active semantic theme.
Gradient edges frame a single useful highlight.
Move your pointer to explore the light.
View VisualEffect code
Framework usage
Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.---
import { Stack, Typography, VisualEffect } from '@santi020k/lumen-astro'
---
<Stack gap="group">
<VisualEffect variant="mesh"><Typography>A clearer project workspace</Typography><Typography>Mesh colors follow the active semantic theme.</Typography></VisualEffect>
<VisualEffect intensity={0.75} variant="border"><Typography>Gradient edges frame a single useful highlight.</Typography></VisualEffect>
<VisualEffect variant="spotlight"><Typography>Move your pointer to explore the light.</Typography></VisualEffect>
</Stack>import { Stack, Typography, VisualEffect } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Stack gap="group">
<VisualEffect variant="mesh"><Typography>A clearer project workspace</Typography><Typography>Mesh colors follow the active semantic theme.</Typography></VisualEffect>
<VisualEffect intensity={0.75} variant="border"><Typography>Gradient edges frame a single useful highlight.</Typography></VisualEffect>
<VisualEffect variant="spotlight"><Typography>Move your pointer to explore the light.</Typography></VisualEffect>
</Stack>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-stack gap="group">
<lumen-visual-effect variant="mesh"><lumen-typography>A clearer project workspace</lumen-typography><lumen-typography>Mesh colors follow the active semantic theme.</lumen-typography></lumen-visual-effect>
<lumen-visual-effect intensity="0.75" variant="border"><lumen-typography>Gradient edges frame a single useful highlight.</lumen-typography></lumen-visual-effect>
<lumen-visual-effect variant="spotlight"><lumen-typography>Move your pointer to explore the light.</lumen-typography></lumen-visual-effect>
</lumen-stack>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.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add VisualEffectlumen add VisualEffectpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add VisualEffect --target reactlumen add VisualEffect --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add VisualEffect --target elementslumen add VisualEffect --target elementsAPI reference
Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.
| Attribute | Values | Default | Description |
|---|---|---|---|
| variant | "mesh" | "aurora" | "spotlight" | "grain" | "border" | "draw" | "depth" | "mesh" | Selects a token-based decorative treatment behind ordinary readable content. |
| intensity | number (0–1) | 0.5 | Bounds effect strength; nonfinite values use the default. |
| animated | boolean | false | Opts into aurora movement, SVG path drawing, or scroll-linked depth. System and local reduced motion disable animation. |
| draw children | SVG paths with pathLength="1" | - | Normalizes drawing lengths without measuring or rewriting application-owned SVG paths. |
| UIPrimitives | Astro runtime | spotlight only | Enhances pointer tracking. Other variants retain CSS or static fallbacks without a runtime. |
| 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. |