tsParticles - v4.0.0-beta.12
    Preparing search index...

    Interface IConfettiOptions

    Confetti options interface

    interface IConfettiOptions {
        angle: number;
        colors: SingleOrMultiple<string>;
        count: number;
        decay: number;
        disableForReducedMotion: boolean;
        drift: number;
        flat: boolean;
        gravity: number;
        origin: ICoordinates;
        particleCount: number;
        position: ICoordinates;
        scalar: number;
        shapeOptions: Record<string, SingleOrMultiple<unknown>>;
        shapes: SingleOrMultiple<string>;
        spread: number;
        startVelocity: number;
        ticks: number;
        zIndex: number;
    }

    Implemented by

    Index

    Properties

    angle colors count decay disableForReducedMotion drift flat gravity origin particleCount position scalar shapeOptions shapes spread startVelocity ticks zIndex

    Properties

    angle: number

    Confetti emission angle

    colors: SingleOrMultiple<string>

    Confetti colors

    count: number

    Number of confetti particles

    decay: number

    Confetti decay rate

    disableForReducedMotion: boolean

    Disables confetti for users who prefer reduced motion

    drift: number

    Confetti drift

    flat: boolean

    Enables flat confetti

    gravity: number

    Confetti gravity

    origin: ICoordinates

    use position instead

    particleCount: number

    use count instead

    position: ICoordinates

    Confetti position in percent

    scalar: number

    Confetti size scalar

    shapeOptions: Record<string, SingleOrMultiple<unknown>>

    Per-shape options

    shapes: SingleOrMultiple<string>

    Confetti shape types

    spread: number

    Confetti spread

    startVelocity: number

    Confetti initial velocity

    ticks: number

    Number of animation ticks

    zIndex: number

    Confetti z-index

    Settings

    Member Visibility

    On This Page

    Properties