Ripples | astro-dither docs

Preview

<DitherEffect effect={"ripples"} params={{"freq":28}} palette={["#001018","#0b3a4d","#1d7d96","#8fd8e8","#eaffff"]} 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="ripples" />

Sine rings radiating from three fixed centres, crossing like drops on still water. freq controls how tight the rings sit.

The props group like this:

Pattern: freq.

Low freq widens the rings into slow, rolling circles.

<DitherEffect effect={"ripples"} params={{"freq":10}} palette={["#001018","#0b3a4d","#1d7d96","#8fd8e8","#eaffff"]} cell={2} matrix={8} speed={1} />

High freq packs the rings into fine interference bands.

<DitherEffect effect={"ripples"} params={{"freq":50}} palette={["#001018","#0b3a4d","#1d7d96","#8fd8e8","#eaffff"]} cell={2} matrix={8} speed={1} />

Prop	Type	Default	Description
`freq`	`number`	28	Ring density. 5 to 60.
`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.