Starfield | astro-dither docs

Preview

<DitherEffect effect={"starfield"} params={{"gain":1.2}} palette={["#000000","#101a33","#3d5a99","#cdd9ff","#ffffff"]} 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="starfield" />

Three layers of hashed stars, each drifting at a different speed and twinkling on its own clock. gain scales the overall brightness.

The props group like this:

Brightness: gain.

Examples

Sparse

Low gain thins the field to a few bright stars.

<DitherEffect effect={"starfield"} params={{"gain":0.5}} palette={["#000000","#101a33","#3d5a99","#cdd9ff","#ffffff"]} cell={2} matrix={8} speed={1} />

Dense

High gain lets the far layers show through too.

<DitherEffect effect={"starfield"} params={{"gain":2.4}} palette={["#000000","#101a33","#3d5a99","#cdd9ff","#ffffff"]} cell={2} matrix={8} speed={1} />

Props

Prop	Type	Default	Description
`gain`	`number`	1.2	Overall star brightness. 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 4s 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.