Preview
<DitherEffect effect={"retro-grid"} params={{}} palette={["#0b0021","#3d0a67","#c71f85","#ff7a3d","#ffd23e"]} cell={2} matrix={8} speed={1} />Installation
pnpm add astro-dithernpm i astro-ditherbun add astro-ditherOr copy the source into your project: npx astro-dither add effect
Usage
---
import { DitherEffect } from "astro-dither";
---
<DitherEffect effect="retro-grid" />The synthwave floor: a perspective grid under a sunset with scanline stripes. It takes no params; palette and cell size do the styling.
The props group like this:
No params. Style it with palette, cell and matrix.
Examples
Neon
A cold palette turns the sunset into a neon signboard.
<DitherEffect effect={"retro-grid"} params={{}} palette={["#02060d","#0b3d80","#00b2ff","#d6efff"]} cell={2} matrix={8} speed={1} />Coarse print
Bigger cells give the grid a chunkier, poster-like grain.
<DitherEffect effect={"retro-grid"} params={{}} palette={["#0b0021","#3d0a67","#c71f85","#ff7a3d","#ffd23e"]} cell={5} matrix={4} speed={1} />Props
| Prop | Type | Default | Description |
|---|---|---|---|
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 6s 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.