Petals API

Petals

Extends Effect.

Factory Function

createPetals(config?: PetalsConfig)

Methods

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

---

PetalsConfig

interface PetalsConfig {
    count?: number;
    colors?: string[];
    size?: number;
    speed?: number;
    wind?: number;
    scale?: number;
}

Property	Type	Default	Description
count	number	100	Number of petals. Automatically halved on small screens.
colors	string[]	Sakura palette (7 pinks)	Array of CSS color strings for petal colors.
size	number	24	Maximum petal size in pixels (before scale).
speed	number	0.7	Fall speed multiplier.
wind	number	0.15	Horizontal wind strength. Positive = right, negative = left.
scale	number	1	Scales all petal sizes proportionally.

---

Petal

Internal representation of a petal particle.

type Petal = {
    x: number;          // Normalized X position (0-1)
    y: number;          // Normalized Y position (0-1)
    size: number;       // Petal size in pixels
    depth: number;      // Depth layer (0.3-1) for parallax
    rotation: number;   // Current rotation angle
    flipAngle: number;  // 3D flip angle for tumbling
    colorIndex: number; // Index into sprite array
};