Aurora API
Aurora
Extends Effect.
Factory Function
typescript
createAurora(config?: AuroraConfig)Methods
See Effect for the full method reference: mount(), start(), pause(), resume(), configure(), withFade(), and destroy().
AuroraConfig
typescript
interface AuroraConfig {
bands?: number;
colors?: string[];
speed?: number;
intensity?: number;
waveAmplitude?: number;
verticalPosition?: number;
scale?: number;
}| Property | Type | Default | Description |
|---|---|---|---|
bands | number | 5 | Number of aurora curtain rays. |
colors | string[] | ['#9922ff', '#4455ff', '#0077ee', '#00aabb', '#22ddff'] | Base hex colors for each ray. Colors cycle if fewer than bands. |
speed | number | 1 | Animation speed multiplier. |
intensity | number | 0.8 | Overall brightness/opacity (0-1). |
waveAmplitude | number | 1 | Base wave undulation amplitude multiplier. |
verticalPosition | number | 0.68 | Normalized Y base for the aurora rays (0=top, 1=bottom). |
scale | number | 1 | Global scale factor for ray height. |