@tsparticles/engine 3.0.3 → 3.2.0

package/umd/Core/Canvas.js

@@ -15,9 +15,29 @@
     const ColorUtils_js_1 = require("../Utils/ColorUtils.js");
     const Constants_js_1 = require("./Utils/Constants.js");
     function setTransformValue(factor, newFactor, key) {
-        const newValue = newFactor[key];
+        const newValue = newFactor[key], defaultValue = 1;
         if (newValue !== undefined) {
-            factor[key] = (factor[key] ?? 1) * newValue;
+            factor[key] = (factor[key] ?? defaultValue) * newValue;
+        }
+    }
+    function setStyle(canvas, style, important = false) {
+        if (!style) {
+            return;
+        }
+        const element = canvas;
+        if (!element) {
+            return;
+        }
+        const elementStyle = element.style;
+        if (!elementStyle) {
+            return;
+        }
+        for (const key in style) {
+            const value = style[key];
+            if (!value) {
+                continue;
+            }
+            elementStyle.setProperty(key, value, important ? "important" : "");
         }
     }
     class Canvas {
@@ -25,7 +45,7 @@
             this.container = container;
             this._applyPostDrawUpdaters = (particle) => {
                 for (const updater of this._postDrawUpdaters) {
-                    updater.afterDraw && updater.afterDraw(particle);
+                    updater.afterDraw?.(particle);
                 }
             };
             this._applyPreDrawUpdaters = (ctx, particle, radius, zOpacity, colorStyles, transform) => {
@@ -45,12 +65,12 @@
                             setTransformValue(transform, updaterTransform, key);
                         }
                     }
-                    updater.beforeDraw && updater.beforeDraw(particle);
+                    updater.beforeDraw?.(particle);
                 }
             };
             this._applyResizePlugins = () => {
                 for (const plugin of this._resizePlugins) {
-                    plugin.resize && plugin.resize();
+                    plugin.resize?.();
                 }
             };
             this._getPluginParticleColors = (particle) => {
@@ -68,14 +88,36 @@
                 }
                 return [fColor, sColor];
             };
-            this._initCover = () => {
-                const options = this.container.actualOptions, cover = options.backgroundMask.cover, color = cover.color, coverRgb = (0, ColorUtils_js_1.rangeColorToRgb)(color);
-                if (coverRgb) {
-                    const coverColor = {
-                        ...coverRgb,
-                        a: cover.opacity,
-                    };
-                    this._coverColorStyle = (0, ColorUtils_js_1.getStyleFromRgb)(coverColor, coverColor.a);
+            this._initCover = async () => {
+                const options = this.container.actualOptions, cover = options.backgroundMask.cover, color = cover.color;
+                if (color) {
+                    const coverRgb = (0, ColorUtils_js_1.rangeColorToRgb)(color);
+                    if (coverRgb) {
+                        const coverColor = {
+                            ...coverRgb,
+                            a: cover.opacity,
+                        };
+                        this._coverColorStyle = (0, ColorUtils_js_1.getStyleFromRgb)(coverColor, coverColor.a);
+                    }
+                }
+                else {
+                    await new Promise((resolve, reject) => {
+                        if (!cover.image) {
+                            return;
+                        }
+                        const img = document.createElement("img");
+                        img.addEventListener("load", () => {
+                            this._coverImage = {
+                                image: img,
+                                opacity: cover.opacity,
+                            };
+                            resolve();
+                        });
+                        img.addEventListener("error", (evt) => {
+                            reject(evt.error);
+                        });
+                        img.src = cover.image;
+                    });
                 }
             };
             this._initStyle = () => {
@@ -106,17 +148,17 @@
                 if (!trail.enable) {
                     return;
                 }
+                const factorNumerator = 1, opacity = factorNumerator / trail.length;
                 if (trailFill.color) {
                     const fillColor = (0, ColorUtils_js_1.rangeColorToRgb)(trailFill.color);
                     if (!fillColor) {
                         return;
                     }
-                    const trail = options.particles.move.trail;
                     this._trailFill = {
                         color: {
                             ...fillColor,
                         },
-                        opacity: 1 / trail.length,
+                        opacity,
                     };
                 }
                 else {
@@ -128,7 +170,7 @@
                         img.addEventListener("load", () => {
                             this._trailFill = {
                                 image: img,
-                                opacity: 1 / trail.length,
+                                opacity,
                             };
                             resolve();
                         });
@@ -160,13 +202,7 @@
                 if (!(element && originalStyle)) {
                     return;
                 }
-                const style = element.style;
-                style.position = originalStyle.position;
-                style.zIndex = originalStyle.zIndex;
-                style.top = originalStyle.top;
-                style.left = originalStyle.left;
-                style.width = originalStyle.width;
-                style.height = originalStyle.height;
+                setStyle(element, originalStyle);
             };
             this._safeMutationObserver = (callback) => {
                 if (!this._mutationObserver) {
@@ -179,13 +215,15 @@
                 if (!element) {
                     return;
                 }
-                const priority = "important", style = element.style;
-                style.setProperty("position", "fixed", priority);
-                style.setProperty("z-index", this.container.actualOptions.fullScreen.zIndex.toString(10), priority);
-                style.setProperty("top", "0", priority);
-                style.setProperty("left", "0", priority);
-                style.setProperty("width", "100%", priority);
-                style.setProperty("height", "100%", priority);
+                const radix = 10;
+                setStyle(element, {
+                    position: "fixed",
+                    zIndex: this.container.actualOptions.fullScreen.zIndex.toString(radix),
+                    top: "0",
+                    left: "0",
+                    width: "100%",
+                    height: "100%",
+                }, true);
             };
             this.size = {
                 height: 0,
@@ -202,11 +240,11 @@
             return this.container.actualOptions.fullScreen.enable;
         }
         clear() {
-            const options = this.container.actualOptions, trail = options.particles.move.trail, trailFill = this._trailFill;
+            const options = this.container.actualOptions, trail = options.particles.move.trail, trailFill = this._trailFill, minimumLength = 0;
             if (options.backgroundMask.enable) {
                 this.paint();
             }
-            else if (trail.enable && trail.length > 0 && trailFill) {
+            else if (trail.enable && trail.length > minimumLength && trailFill) {
                 if (trailFill.color) {
                     this._paintBase((0, ColorUtils_js_1.getStyleFromRgb)(trailFill.color, trailFill.opacity));
                 }
@@ -224,7 +262,7 @@
             this.stop();
             if (this._generated) {
                 const element = this.element;
-                element && element.remove();
+                element?.remove();
             }
             else {
                 this._resetOriginalStyle();
@@ -241,12 +279,19 @@
             }
             return cb(ctx);
         }
-        drawParticle(particle, delta) {
+        drawAsync(cb) {
+            const ctx = this._context;
+            if (!ctx) {
+                return Promise.resolve(undefined);
+            }
+            return cb(ctx);
+        }
+        async drawParticle(particle, delta) {
             if (particle.spawning || particle.destroyed) {
                 return;
             }
-            const radius = particle.getRadius();
-            if (radius <= 0) {
+            const radius = particle.getRadius(), minimumSize = 0;
+            if (radius <= minimumSize) {
                 return;
             }
             const pfColor = particle.getFillColor(), psColor = particle.getStrokeColor() ?? pfColor;
@@ -260,13 +305,13 @@
             if (!fColor && !sColor) {
                 return;
             }
-            this.draw((ctx) => {
-                const container = this.container, options = container.actualOptions, zIndexOptions = particle.options.zIndex, zOpacityFactor = (1 - particle.zIndexFactor) ** zIndexOptions.opacityRate, opacity = particle.bubble.opacity ?? particle.opacity?.value ?? 1, strokeOpacity = particle.strokeOpacity ?? opacity, zOpacity = opacity * zOpacityFactor, zStrokeOpacity = strokeOpacity * zOpacityFactor, transform = {}, colorStyles = {
+            await this.drawAsync(async (ctx) => {
+                const container = this.container, options = container.actualOptions, zIndexOptions = particle.options.zIndex, zIndexFactorOffset = 1, zIndexFactor = zIndexFactorOffset - particle.zIndexFactor, zOpacityFactor = zIndexFactor ** zIndexOptions.opacityRate, defaultOpacity = 1, opacity = particle.bubble.opacity ?? particle.opacity?.value ?? defaultOpacity, strokeOpacity = particle.strokeOpacity ?? opacity, zOpacity = opacity * zOpacityFactor, zStrokeOpacity = strokeOpacity * zOpacityFactor, transform = {}, colorStyles = {
                     fill: fColor ? (0, ColorUtils_js_1.getStyleFromHsl)(fColor, zOpacity) : undefined,
                 };
                 colorStyles.stroke = sColor ? (0, ColorUtils_js_1.getStyleFromHsl)(sColor, zStrokeOpacity) : colorStyles.fill;
                 this._applyPreDrawUpdaters(ctx, particle, radius, zOpacity, colorStyles, transform);
-                (0, CanvasUtils_js_1.drawParticle)({
+                await (0, CanvasUtils_js_1.drawParticle)({
                     container,
                     context: ctx,
                     particle,
@@ -274,7 +319,7 @@
                     colorStyles,
                     backgroundMask: options.backgroundMask.enable,
                     composite: options.backgroundMask.composite,
-                    radius: radius * (1 - particle.zIndexFactor) ** zIndexOptions.sizeRate,
+                    radius: radius * zIndexFactor ** zIndexOptions.sizeRate,
                     opacity: zOpacity,
                     shadow: particle.options.shadow,
                     transform,
@@ -282,11 +327,11 @@
                 this._applyPostDrawUpdaters(particle);
             });
         }
-        drawParticlePlugin(plugin, particle, delta) {
-            this.draw((ctx) => (0, CanvasUtils_js_1.drawParticlePlugin)(ctx, plugin, particle, delta));
+        async drawParticlePlugin(plugin, particle, delta) {
+            await this.drawAsync((ctx) => (0, CanvasUtils_js_1.drawParticlePlugin)(ctx, plugin, particle, delta));
         }
-        drawPlugin(plugin, delta) {
-            this.draw((ctx) => (0, CanvasUtils_js_1.drawPlugin)(ctx, plugin, delta));
+        async drawPlugin(plugin, delta) {
+            await this.drawAsync((ctx) => (0, CanvasUtils_js_1.drawPlugin)(ctx, plugin, delta));
         }
         async init() {
             this._safeMutationObserver((obs) => obs.disconnect());
@@ -299,7 +344,7 @@
             });
             this.resize();
             this._initStyle();
-            this._initCover();
+            await this._initCover();
             try {
                 await this._initTrail();
             }
@@ -344,7 +389,7 @@
                 if (plugin.resize) {
                     this._resizePlugins.push(plugin);
                 }
-                if (plugin.particleFillColor || plugin.particleStrokeColor) {
+                if (plugin.particleFillColor ?? plugin.particleStrokeColor) {
                     this._colorPlugins.push(plugin);
                 }
             }
@@ -356,7 +401,7 @@
                 if (updater.afterDraw) {
                     this._postDrawUpdaters.push(updater);
                 }
-                if (updater.getColorStyles || updater.getTransformValues || updater.beforeDraw) {
+                if (updater.getColorStyles ?? updater.getTransformValues ?? updater.beforeDraw) {
                     this._preDrawUpdaters.push(updater);
                 }
             }
@@ -389,7 +434,15 @@
             this.draw((ctx) => {
                 if (options.backgroundMask.enable && options.backgroundMask.cover) {
                     (0, CanvasUtils_js_1.clear)(ctx, this.size);
-                    this._paintBase(this._coverColorStyle);
+                    if (this._coverImage) {
+                        this._paintImage(this._coverImage.image, this._coverImage.opacity);
+                    }
+                    else if (this._coverColorStyle) {
+                        this._paintBase(this._coverColorStyle);
+                    }
+                    else {
+                        this._paintBase();
+                    }
                 }
                 else {
                     this._paintBase();
@@ -431,7 +484,7 @@
                 return;
             }
             const container = this.container, needsRefresh = container.updateActualOptions();
-            container.particles.setDensity();
+            await container.particles.setDensity();
             this._applyResizePlugins();
             if (needsRefresh) {
                 await container.refresh();

package/umd/Core/Container.js

@@ -4,28 +4,29 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "../Utils/Utils.js", "./Canvas.js", "./Utils/EventListeners.js", "../Options/Classes/Options.js", "./Particles.js", "./Retina.js", "./Utils/Constants.js", "../Utils/NumberUtils.js", "../Utils/OptionsUtils.js"], factory);
+        define(["require", "exports", "./Utils/Constants.js", "../Utils/Utils.js", "./Canvas.js", "./Utils/EventListeners.js", "../Options/Classes/Options.js", "./Particles.js", "./Retina.js", "../Utils/NumberUtils.js", "../Utils/OptionsUtils.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.Container = void 0;
+    const Constants_js_1 = require("./Utils/Constants.js");
     const Utils_js_1 = require("../Utils/Utils.js");
     const Canvas_js_1 = require("./Canvas.js");
     const EventListeners_js_1 = require("./Utils/EventListeners.js");
     const Options_js_1 = require("../Options/Classes/Options.js");
     const Particles_js_1 = require("./Particles.js");
     const Retina_js_1 = require("./Retina.js");
-    const Constants_js_1 = require("./Utils/Constants.js");
     const NumberUtils_js_1 = require("../Utils/NumberUtils.js");
     const OptionsUtils_js_1 = require("../Utils/OptionsUtils.js");
     function guardCheck(container) {
         return container && !container.destroyed;
     }
-    function initDelta(value, fpsLimit = 60, smooth = false) {
+    const defaultFps = 60;
+    function initDelta(value, fpsLimit = defaultFps, smooth = false) {
         return {
             value,
-            factor: smooth ? 60 / fpsLimit : (60 * value) / 1000,
+            factor: smooth ? defaultFps / fpsLimit : (defaultFps * value) / Constants_js_1.millisecondsToSeconds,
         };
     }
     function loadContainerOptions(engine, container, ...sourceOptionsArr) {
@@ -43,14 +44,19 @@
                     if (entry.target !== this.interactivity.element) {
                         continue;
                     }
-                    (entry.isIntersecting ? this.play : this.pause)();
+                    if (entry.isIntersecting) {
+                        this.play();
+                    }
+                    else {
+                        this.pause();
+                    }
                 }
             };
             this._nextFrame = async (timestamp) => {
                 try {
                     if (!this._smooth &&
                         this._lastFrameTime !== undefined &&
-                        timestamp < this._lastFrameTime + 1000 / this.fpsLimit) {
+                        timestamp < this._lastFrameTime + Constants_js_1.millisecondsToSeconds / this.fpsLimit) {
                         this.draw(false);
                         return;
                     }
@@ -58,7 +64,7 @@
                     const delta = initDelta(timestamp - this._lastFrameTime, this.fpsLimit, this._smooth);
                     this.addLifeTime(delta.value);
                     this._lastFrameTime = timestamp;
-                    if (delta.value > 1000) {
+                    if (delta.value > Constants_js_1.millisecondsToSeconds) {
                         this.draw(false);
                         return;
                     }
@@ -67,7 +73,7 @@
                         this.destroy();
                         return;
                     }
-                    if (this.getAnimationStatus()) {
+                    if (this.animationStatus) {
                         this.draw(false);
                     }
                 }
@@ -110,6 +116,9 @@
             this._intersectionObserver = (0, Utils_js_1.safeIntersectionObserver)((entries) => this._intersectionManager(entries));
             this._engine.dispatchEvent("containerBuilt", { container: this });
         }
+        get animationStatus() {
+            return !this._paused && !this.pageHidden && guardCheck(this);
+        }
         get options() {
             return this._options;
         }
@@ -141,8 +150,8 @@
                 const mouseEvent = e, pos = {
                     x: mouseEvent.offsetX || mouseEvent.clientX,
                     y: mouseEvent.offsetY || mouseEvent.clientY,
-                };
-                clickOrTouchHandler(e, pos, 1);
+                }, radius = 1;
+                clickOrTouchHandler(e, pos, radius);
             };
             const touchStartHandler = () => {
                 if (!guardCheck(this)) {
@@ -163,16 +172,17 @@
                 }
                 if (touched && !touchMoved) {
                     const touchEvent = e;
-                    let lastTouch = touchEvent.touches[touchEvent.touches.length - 1];
+                    const lengthOffset = 1;
+                    let lastTouch = touchEvent.touches[touchEvent.touches.length - lengthOffset];
                     if (!lastTouch) {
-                        lastTouch = touchEvent.changedTouches[touchEvent.changedTouches.length - 1];
+                        lastTouch = touchEvent.changedTouches[touchEvent.changedTouches.length - lengthOffset];
                         if (!lastTouch) {
                             return;
                         }
                     }
-                    const element = this.canvas.element, canvasRect = element ? element.getBoundingClientRect() : undefined, pos = {
-                        x: lastTouch.clientX - (canvasRect ? canvasRect.left : 0),
-                        y: lastTouch.clientY - (canvasRect ? canvasRect.top : 0),
+                    const element = this.canvas.element, canvasRect = element ? element.getBoundingClientRect() : undefined, minCoordinate = 0, pos = {
+                        x: lastTouch.clientX - (canvasRect ? canvasRect.left : minCoordinate),
+                        y: lastTouch.clientY - (canvasRect ? canvasRect.top : minCoordinate),
                     };
                     clickOrTouchHandler(e, pos, Math.max(lastTouch.radiusX, lastTouch.radiusY));
                 }
@@ -214,10 +224,10 @@
             this.particles.destroy();
             this.canvas.destroy();
             for (const [, effectDrawer] of this.effectDrawers) {
-                effectDrawer.destroy && effectDrawer.destroy(this);
+                effectDrawer.destroy?.(this);
             }
             for (const [, shapeDrawer] of this.shapeDrawers) {
-                shapeDrawer.destroy && shapeDrawer.destroy(this);
+                shapeDrawer.destroy?.(this);
             }
             for (const key of this.effectDrawers.keys()) {
                 this.effectDrawers.delete(key);
@@ -227,9 +237,10 @@
             }
             this._engine.clearPlugins(this);
             this.destroyed = true;
-            const mainArr = this._engine.dom(), idx = mainArr.findIndex((t) => t === this);
-            if (idx >= 0) {
-                mainArr.splice(idx, 1);
+            const mainArr = this._engine.dom(), idx = mainArr.findIndex((t) => t === this), minIndex = 0;
+            if (idx >= minIndex) {
+                const deleteCount = 1;
+                mainArr.splice(idx, deleteCount);
             }
             this._engine.dispatchEvent("containerDestroyed", { container: this });
         }
@@ -238,13 +249,14 @@
                 return;
             }
             let refreshTime = force;
-            this._drawAnimationFrame = requestAnimationFrame(async (timestamp) => {
+            const frame = async (timestamp) => {
                 if (refreshTime) {
                     this._lastFrameTime = undefined;
                     refreshTime = false;
                 }
                 await this._nextFrame(timestamp);
-            });
+            };
+            this._drawAnimationFrame = requestAnimationFrame((timestamp) => void frame(timestamp));
         }
         async export(type, options = {}) {
             for (const [, plugin] of this.plugins) {
@@ -259,16 +271,13 @@
             }
             (0, Utils_js_1.getLogger)().error(`${Constants_js_1.errorPrefix} - Export plugin with type ${type} not found`);
         }
-        getAnimationStatus() {
-            return !this._paused && !this.pageHidden && guardCheck(this);
-        }
         handleClickMode(mode) {
             if (!guardCheck(this)) {
                 return;
             }
             this.particles.handleClickMode(mode);
             for (const [, plugin] of this.plugins) {
-                plugin.handleClickMode && plugin.handleClickMode(mode);
+                plugin.handleClickMode?.(mode);
             }
         }
         async init() {
@@ -289,9 +298,10 @@
                     this.shapeDrawers.set(type, drawer);
                 }
             }
+            await this.particles.initPlugins();
             this._options = loadContainerOptions(this._engine, this, this._initialSourceOptions, this.sourceOptions);
             this.actualOptions = loadContainerOptions(this._engine, this, this._options);
-            const availablePlugins = this._engine.getAvailablePlugins(this);
+            const availablePlugins = await this._engine.getAvailablePlugins(this);
             for (const [id, plugin] of availablePlugins) {
                 this.plugins.set(id, plugin);
             }
@@ -301,25 +311,26 @@
             this.canvas.initBackground();
             this.canvas.resize();
             this.zLayers = this.actualOptions.zLayers;
-            this._duration = (0, NumberUtils_js_1.getRangeValue)(this.actualOptions.duration) * 1000;
-            this._delay = (0, NumberUtils_js_1.getRangeValue)(this.actualOptions.delay) * 1000;
+            this._duration = (0, NumberUtils_js_1.getRangeValue)(this.actualOptions.duration) * Constants_js_1.millisecondsToSeconds;
+            this._delay = (0, NumberUtils_js_1.getRangeValue)(this.actualOptions.delay) * Constants_js_1.millisecondsToSeconds;
             this._lifeTime = 0;
-            this.fpsLimit = this.actualOptions.fpsLimit > 0 ? this.actualOptions.fpsLimit : 120;
+            const defaultFpsLimit = 120, minFpsLimit = 0;
+            this.fpsLimit = this.actualOptions.fpsLimit > minFpsLimit ? this.actualOptions.fpsLimit : defaultFpsLimit;
             this._smooth = this.actualOptions.smooth;
             for (const [, drawer] of this.effectDrawers) {
-                drawer.init && (await drawer.init(this));
+                await drawer.init?.(this);
             }
             for (const [, drawer] of this.shapeDrawers) {
-                drawer.init && (await drawer.init(this));
+                await drawer.init?.(this);
             }
             for (const [, plugin] of this.plugins) {
-                plugin.init && (await plugin.init());
+                await plugin.init?.();
             }
             this._engine.dispatchEvent("containerInit", { container: this });
-            this.particles.init();
-            this.particles.setDensity();
+            await this.particles.init();
+            await this.particles.setDensity();
             for (const [, plugin] of this.plugins) {
-                plugin.particlesSetup && plugin.particlesSetup();
+                plugin.particlesSetup?.();
             }
             this._engine.dispatchEvent("particlesSetup", { container: this });
         }
@@ -342,7 +353,7 @@
                 return;
             }
             for (const [, plugin] of this.plugins) {
-                plugin.pause && plugin.pause();
+                plugin.pause?.();
             }
             if (!this.pageHidden) {
                 this._paused = true;
@@ -369,7 +380,7 @@
                 }
             }
             this._engine.dispatchEvent("containerPlay", { container: this });
-            this.draw(needsUpdate || false);
+            this.draw(needsUpdate ?? false);
         }
         async refresh() {
             if (!guardCheck(this)) {
@@ -394,18 +405,19 @@
             await this.init();
             this.started = true;
             await new Promise((resolve) => {
-                this._delayTimeout = setTimeout(async () => {
+                const start = async () => {
                     this._eventListeners.addListeners();
                     if (this.interactivity.element instanceof HTMLElement && this._intersectionObserver) {
                         this._intersectionObserver.observe(this.interactivity.element);
                     }
                     for (const [, plugin] of this.plugins) {
-                        plugin.start && (await plugin.start());
+                        await plugin.start?.();
                     }
                     this._engine.dispatchEvent("containerStarted", { container: this });
                     this.play();
                     resolve();
-                }, this._delay);
+                };
+                this._delayTimeout = setTimeout(() => void start(), this._delay);
             });
         }
         stop() {
@@ -426,7 +438,7 @@
                 this._intersectionObserver.unobserve(this.interactivity.element);
             }
             for (const [, plugin] of this.plugins) {
-                plugin.stop && plugin.stop();
+                plugin.stop?.();
             }
             for (const key of this.plugins.keys()) {
                 this.plugins.delete(key);