# Eclipse

A dark disc with a glowing rim and a breathing corona.

## Installation

```sh
pnpm add astro-dither
```

Or copy the source into your project:

```sh
npx astro-dither add effect
```

## Usage

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

<DitherEffect effect="eclipse" />
```

A black disc edged by a bright ring, with a noise-streaked corona that slowly breathes. `radius` sizes the disc against the surface.

The props group like this:

Shape: `radius`.

## Examples

### Transit

A small disc reads as a distant transit over a quiet sky.

```astro
<DitherEffect effect="eclipse" params={{"radius":0.12}} />
```

### Annular

A large disc fills the frame, leaving only the corona.

```astro
<DitherEffect effect="eclipse" params={{"radius":0.4}} />
```

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `radius` | `number` | 0.22 | Disc size relative to the surface. 0.05 to 0.45. |
| `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, 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.
* Shares one WebGL context with every other ordered effect on the page.