Tunnel | astro-dither docs

Preview

<DitherEffect effect={"tunnel"} params={{"twist":3,"spokes":4}} palette={["#020610","#123a6b","#2a7fd4","#9fd8ff"]} cell={2} matrix={8} speed={1} />

pnpm add astro-dither

npm i astro-dither

bun add astro-dither

Or copy the source into your project: npx astro-dither add effect

---
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.

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} />

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} />

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, 1 to 8.
`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.
`class`	`string`	undefined	Classes on the surface element, for size and position.