DitherEffect | astro-dither docs

Preview

<DitherEffect effect={"plasma"} />

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="plasma" params={{ scale: 3 }} />

The generic surface: pick an effect, pass its typed params, and the engine does the rest. Effect pages document each field's own params.

Prop	Type	Default	Description
`effect`	`EffectName`	required	One of the 19 registry names.
`params`	`Record<string, number>`	{}	The effect's own settings, typed per effect.
`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.
`src`	`string`	undefined	Image texture for effects that sample one (globe).

Decorative surfaces render aria-hidden. Put real text on top, not inside them.
With reduced motion it draws one still frame and stops.
It pauses when scrolled out of view or when the tab is hidden.