Skip to content

Butterflies API

Butterflies

Extends Effect.

Factory Function

typescript
createButterflies(config?: ButterfliesConfig)

Methods

See Effect for the full method reference.


ButterfliesConfig

typescript
interface ButterfliesConfig {
    colors?: string[];
    count?: number;
    scale?: number;
    size?: number;
    speed?: number;
}
PropertyTypeDefaultDescription
colorsstring[]['#f4a261', '#e76f51', ...]Array of wing colors, one picked randomly per butterfly.
countnumber12Number of butterflies.
scalenumber1Scales all sizes proportionally.
sizenumber20Base wing size in pixels.
speednumber1Speed multiplier for flight and flapping.