Preview
Twist
Spokes
Matrix
Cell
Speed
Levels
Still time
Bloom
Bloom radius
Animate
Palette
<DitherEffect effect="tunnel" params={{"twist":3,"spokes":4}} palette={["#020610","#123a6b","#2a7fd4","#9fd8ff"]} 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="tunnel" />Polar rings rushing inward with a spiral twist. twist sets the depth of the spiral and spokes how many wall segments wrap around.
The props group like this:
Pattern: twist, spokes.
Examples
Straight well
twist 0 and no spokes leave plain concentric rings.
<DitherEffect effect="tunnel" params={{"twist":0,"spokes":0}} palette={["#020610","#123a6b","#2a7fd4","#9fd8ff"]} cell={2} matrix={8} speed={1} />Fan
More spokes cut the walls into a spinning turbine.
<DitherEffect effect="tunnel" params={{"twist":6,"spokes":9}} palette={["#020610","#123a6b","#2a7fd4","#9fd8ff"]} cell={2} matrix={8} speed={1} />Props
| Prop | Type | Default | Description |
|---|---|---|---|
twist | number | 3 | Spiral depth. 0 to 12. |
spokes | number | 4 | Wall segments around the ring. 0 to 12. |
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.