DitherEffect | astro-dither docs

Preview

Installation

pnpm add astro-dither

Or copy the source into your project:

npx astro-dither add effect

Usage

---
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. Use DitherGlobe for the globe: it supplies the required land mask. Effect pages document each field's own params.

Props

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. 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.
`src`	`string`	undefined	Image texture for effects that sample one (globe).

Notes

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.