Preview
Radius
Matrix
Cell
Speed
Levels
Still time
Bloom
Bloom radius
Animate
Palette
<DitherEffect effect="eclipse" params={{"radius":0.22}} palette={["#000000","#1a0f2e","#6b3fa0","#ffb36b","#fff3d6"]} cell={2} matrix={8} speed={1} />Installation
pnpm add astro-dithernpm i astro-ditherbun add astro-ditherOr copy the source into your project:
npx astro-dither add effectUsage
---import { DitherEffect } from "astro-dither";---
<DitherEffect effect="eclipse" />A black disc edged by a bright ring, with a noise-streaked corona that slowly breathes. radius sizes the disc against the surface.
The props group like this:
Shape: radius.
Examples
Transit
A small disc reads as a distant transit over a quiet sky.
<DitherEffect effect="eclipse" params={{"radius":0.12}} palette={["#000000","#1a0f2e","#6b3fa0","#ffb36b","#fff3d6"]} cell={2} matrix={8} speed={1} />Annular
A large disc fills the frame, leaving only the corona.
<DitherEffect effect="eclipse" params={{"radius":0.4}} palette={["#000000","#1a0f2e","#6b3fa0","#ffb36b","#fff3d6"]} cell={2} matrix={8} speed={1} />Props
| Prop | Type | Default | Description |
|---|---|---|---|
radius | number | 0.22 | Disc size relative to the surface. 0.05 to 0.45. |
palette | string[] | the effect's | 2 to 8 colours, paper first, brightest last. transparent works. |
cell | number | 2 | Size of one dither cell in CSS pixels. Rounded to whole device pixels so cells stay even. |
matrix | 2 | 4 | 8 | "noise" | 8 | The Bayer threshold size, or noise for a random look. |
speed | number | 1 | Playback speed. 0 draws one still frame. |
stillTime | number | the effect's | The moment drawn when motion is off or reduced, in seconds. |
levels | number | 0 (all) | Tones the field snaps to before dithering. Low values give hard, posterised steps. |
bloom | number | 0 | Bloom around lit cells, 0 to 1. Set a positive prop to create the overlay before overriding it with CSS --dither-bloom. |
bloomRadius | number | 10 | Bloom blur in CSS pixels. CSS --dither-bloom-radius overrides it. |
class | string | undefined | Classes on the surface element, for size and position. |
Notes
- Decorative and
aria-hidden. Put real text on top of it, not inside it. - With reduced motion it draws one still frame at 4s and stops.
- It pauses when scrolled out of view or when the tab is hidden.
- It shares one WebGL context with every other ordered effect on the page.