Orbits API

Orbits

Extends Effect.

Factory Function

createOrbits(config?: OrbitsConfig)

Methods

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

---

OrbitsConfig

interface OrbitsConfig {
    centers?: number;
    orbitersPerCenter?: number;
    speed?: number;
    colors?: string[];
    trailLength?: number;
    showCenters?: boolean;
    scale?: number;
}

Property	Type	Default	Description
centers	number	3	Number of orbital center points.
orbitersPerCenter	number	8	Number of particles per center. Automatically halved on small screens.
speed	number	1	Orbital speed multiplier.
colors	string[]	ORBIT_COLORS	Array of hex color strings for the orbiters.
trailLength	number	15	Number of trail segments behind each orbiter.
showCenters	boolean	true	Whether to draw a subtle glow at each center point.
scale	number	1	Scales orbit radii and particle sizes proportionally.