Menu
Docs menu

Glow

A soft dithered spotlight from any point, breathing slowly.

Preview

Expanded preview

Installation

Terminal window
pnpm add astro-dither

Or copy the source into your project:

Terminal window
npx astro-dither add effect

Usage

src/pages/index.astro
---
import { DitherEffect } from "astro-dither";
---
<DitherEffect effect="glow" params={{ cx: 0.5, cy: 0.4, radius: 0.7 }} />

A single radial falloff from cx, cy. radius sets how far it reaches and power how sharply it drops. The field adds a slow breath on top, so the edge pulses a little even at full brightness.

The props group like this:

Placement: cx, cy. Falloff: radius, power.

Examples

Corner light

Push the centre to a corner and stretch the radius for a side-lit wall.

Expanded preview

Hard spotlight

High power tightens the falloff into a stage spotlight.

Expanded preview

Props

PropTypeDefaultDescription
cxnumber0.5Centre x, 0 to 1. 0 to 1.
cynumber0.55Centre y, 0 to 1. 0 to 1.
radiusnumber0.6How far the light reaches. 0.05 to 1.5.
powernumber2Falloff sharpness. 0.5 to 6.
palettestring[]the effect's2 to 8 colours, paper first, brightest last. transparent works.
cellnumber2Size of one dither cell in CSS pixels. Rounded to whole device pixels so cells stay even.
matrix2 | 4 | 8 | "noise"8The Bayer threshold size, or noise for a random look.
speednumber1Playback speed. 0 draws one still frame.
stillTimenumberthe effect'sThe moment drawn when motion is off or reduced, in seconds.
levelsnumber0 (all)Tones the field snaps to before dithering. Low values give hard, posterised steps.
bloomnumber0Bloom around lit cells, 0 to 1. Set a positive prop to create the overlay before overriding it with CSS --dither-bloom.
bloomRadiusnumber10Bloom blur in CSS pixels. CSS --dither-bloom-radius overrides it.
classstringundefinedClasses 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 2s 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.