Waves | astro-dither docs

Preview

<DitherEffect effect={"waves"} params={{"horizon":0.62,"gain":1}} palette={["#000208","#07294d","#0f6b8f","#5fd4c9","#d8fff4"]} cell={2} matrix={8} speed={1} />

Installation

pnpm add astro-dither

npm i astro-dither

bun add astro-dither

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

Usage

---
import { DitherEffect } from "astro-dither";
---

<DitherEffect effect="waves" />

Three stacked swells rolling toward a bright edge. horizon moves the glow line up and down the frame, gain pushes the bands brighter.

The props group like this:

Placement: horizon. Brightness: gain.

Examples

Low tide

Drop horizon for a taller sea under a thin sky.

<DitherEffect effect={"waves"} params={{"horizon":0.4,"gain":1}} palette={["#000208","#07294d","#0f6b8f","#5fd4c9","#d8fff4"]} cell={2} matrix={8} speed={1} />

Overexposed

High gain burns the crests to the lightest palette colour.

<DitherEffect effect={"waves"} params={{"horizon":0.62,"gain":1.8}} palette={["#000208","#07294d","#0f6b8f","#5fd4c9","#d8fff4"]} cell={2} matrix={8} speed={1} />

Props

Prop	Type	Default	Description
`horizon`	`number`	0.62	Height of the glowing edge, 0 to 1. 0.2 to 0.9.
`gain`	`number`	1	Band brightness. 0.2 to 2.
`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.

Notes

Decorative and aria-hidden. Put real text on top of it, not inside it.
With reduced motion it draws one still frame at 5s 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.