Smoke | astro-dither docs

Preview

<DitherEffect effect={"smoke"} params={{"scale":3,"rise":0.15,"gain":1.2}} palette={["#000000","#151a1f","#3c4750","#8ea4b5","#dce9f2"]} 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="smoke" />

Rising fractal noise masked to the lower half, so the surface clears for text on top. scale sets the blob size, rise the speed of the drift, gain the density.

The props group like this:

Texture: scale, rise. Density: gain.

Examples

Embers

An ember palette turns the smoke into heat under a dark sky.

<DitherEffect effect={"smoke"} params={{"scale":3,"rise":0.15,"gain":1.2}} palette={["#000000","#2a0a02","#7a2808","#e86a20","#ffd9a0"]} cell={2} matrix={8} speed={1} />

Dense fog

Low scale and high gain fill the bottom with a solid bank.

<DitherEffect effect={"smoke"} params={{"scale":1.5,"rise":0.15,"gain":2.2}} palette={["#000000","#151a1f","#3c4750","#8ea4b5","#dce9f2"]} cell={2} matrix={8} speed={1} />

Props

Prop	Type	Default	Description
`scale`	`number`	3	Blob size. 1 to 8.
`rise`	`number`	0.15	Upward drift speed. 0 to 0.6.
`gain`	`number`	1.2	Density. 0.2 to 3.
`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.