konfeti - v0.6.0
    Preparing search index...

    Type Alias KonfetiEmitter

    KonfetiEmitter: PromiseLike<void> & {
        clear(): void;
        getParticleCount(): number;
        isEmitting(): boolean;
        isFinished(): boolean;
        isPaused(): boolean;
        moveTo(target: EmitterTarget): void;
        pause(): void;
        resume(): void;
        stop(): void;
    }

    Continuous Emitter Handle. Returned by emit(). Awaiting it resolves once the emitter was stopped and its last particle is gone.

    Type Declaration

    • clear: function
      • clear(): void

        Stop and Remove Everything Now. Ends the emitter and clears its particles immediately.

        Returns void

    • getParticleCount: function
      • getParticleCount(): number

        Return Live Particle Count.

        Returns number

        Particles Currently on Screen

    • isEmitting: function
      • isEmitting(): boolean

        Check Whether It Still Creates Particles (false after stop() / clear()).

        Returns boolean

        Emitting Flag

    • isFinished: function
      • isFinished(): boolean

        Check Whether It Stopped and Every Particle Is Gone.

        Returns boolean

        Finished Flag

    • isPaused: function
      • isPaused(): boolean

        Check Whether pause() Is in Effect.

        Returns boolean

        Paused Flag

    • moveTo: function
      • moveTo(target: EmitterTarget): void

        Change What the Emitter Follows.

        Parameters

        Returns void

    • pause: function
      • pause(): void

        Freeze the Emitter and Its Particles.

        Returns void

    • resume: function
      • resume(): void

        Continue After pause().

        Returns void

    • stop: function
      • stop(): void

        Stop Emitting. No new particles are created; the ones already out keep flying until their lifetime ends.

        Returns void

    const fountain = Konfeti.emit({ rate: 40, follow: button });
    fountain.moveTo("pointer"); // follow the pointer instead
    fountain.stop();
    await fountain; // every particle has finished

    Settings
    Member Visibility