Streamers API

Streamers

Extends Effect.

Factory Function

createStreamers(config?: StreamersConfig)

Methods

See Effect for the full method reference: mount(), start(), pause(), resume(), configure(), withFade(), and destroy().

---

StreamersConfig

interface StreamersConfig {
    count?: number;
    colors?: string[];
    speed?: number;
    scale?: number;
}

Property	Type	Default	Description
count	number	20	Number of streamers. Automatically halved on small screens.
colors	string[]	STREAMER_COLORS	Array of hex color strings for the streamers.
speed	number	1	Fall speed multiplier. Higher values make streamers fall faster.
scale	number	1	Scales streamer sizes, widths, and physics proportionally.