Skip to content

Popcorn API

Popcorn

Extends Effect.

Factory Function

typescript
createPopcorn(config?: PopcornConfig)

Methods

See Effect for the full method reference.


PopcornConfig

typescript
interface PopcornConfig {
    bounciness?: number;
    color?: string;
    count?: number;
    gravity?: number;
    popRate?: number;
    scale?: number;
    speed?: number;
}
PropertyTypeDefaultDescription
bouncinessnumber0.6Energy retained on each bounce (0–1).
colorstring'#fff8dc'Base color of the popcorn kernels.
countnumber25Maximum number of kernels visible at once.
gravitynumber1Gravity strength pulling kernels down.
popRatenumber2Number of new kernels popping per second.
scalenumber1Scales all sizes proportionally.
speednumber1Overall speed multiplier.

PopcornKernel

Represents a single popcorn kernel. Used internally by the effect.