Documentation
Layout
Particles
Adds a density-controlled decorative particle field behind foreground content.
01
See it in context
Preview
02
Copy a working example
Usage
---
import { Particles } from '@santi020k/lumen-astro';
---
<Particles density="medium" />---
import { Particles } from '@santi020k/lumen-astro';
---
<Particles density="medium" />import { Particles } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Particles density="medium" />
</>
)import { Particles } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Particles density="medium" />
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-particles density="medium"></lumen-particles><script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-particles density="medium"></lumen-particles>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 Particleslumen add Particlespnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Particles --target reactlumen add Particles --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Particles --target elementslumen add Particles --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 |
|---|---|---|---|
| density | "low" | "medium" | "high" | "medium" | Controls the density of the particles. |
| 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. |