@tsparticles/updater-stroke-color 3.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Matteo Bruni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
+
+# tsParticles Stroke Color Updater
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-updater-stroke-color/badge)](https://www.jsdelivr.com/package/npm/tsparticles-updater-stroke-color)
+[![npmjs](https://badge.fury.io/js/tsparticles-updater-stroke-color.svg)](https://www.npmjs.com/package/tsparticles-updater-stroke-color)
+[![npmjs](https://img.shields.io/npm/dt/tsparticles-updater-stroke-color)](https://www.npmjs.com/package/tsparticles-updater-stroke-color) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) updater plugin for stroke color animations.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.updater.stroke-color.min.js` file will export the function to load the updater plugin:
+
+```javascript
+loadStrokeColorUpdater;
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the updater plugin like this:
+
+```javascript
+(async () => {
+  await loadStrokeColorUpdater();
+
+  await tsParticles.load({
+    id: "tsparticles",
+    options: {
+      /* options */
+    },
+  });
+})();
+```
+
+### ESM / CommonJS
+
+This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:
+
+```shell
+$ npm install tsparticles-updater-stroke-color
+```
+
+or
+
+```shell
+$ yarn add tsparticles-updater-stroke-color
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("tsparticles-engine");
+const { loadStrokeColorUpdater } = require("tsparticles-updater-stroke-color");
+
+loadStrokeColorUpdater(tsParticles);
+```
+
+or
+
+```javascript
+import { tsParticles } from "tsparticles-engine";
+import { loadStrokeColorUpdater } from "tsparticles-updater-stroke-color";
+
+loadStrokeColorUpdater(tsParticles);
+```

package/browser/StrokeColorUpdater.js

@@ -0,0 +1,94 @@
+import { getHslAnimationFromHsl, getRangeValue, itemFromSingleOrMultiple, randomInRange, rangeColorToHsl, } from "@tsparticles/engine";
+function updateColorValue(delta, value, valueAnimation, max, decrease) {
+    var _a, _b;
+    const colorValue = value;
+    if (!colorValue ||
+        !colorValue.enable ||
+        (colorValue.loops !== undefined &&
+            colorValue.maxLoops !== undefined &&
+            colorValue.maxLoops > 0 &&
+            colorValue.loops >= colorValue.maxLoops)) {
+        return;
+    }
+    const offset = randomInRange(valueAnimation.offset), velocity = ((_a = value.velocity) !== null && _a !== void 0 ? _a : 0) * delta.factor + offset * 3.6, decay = (_b = value.decay) !== null && _b !== void 0 ? _b : 1;
+    if (!decrease || colorValue.status === "increasing") {
+        colorValue.value += velocity;
+        if (colorValue.value > max) {
+            if (!colorValue.loops) {
+                colorValue.loops = 0;
+            }
+            colorValue.loops++;
+            if (decrease) {
+                colorValue.status = "decreasing";
+                colorValue.value -= colorValue.value % max;
+            }
+        }
+    }
+    else {
+        colorValue.value -= velocity;
+        if (colorValue.value < 0) {
+            if (!colorValue.loops) {
+                colorValue.loops = 0;
+            }
+            colorValue.loops++;
+            colorValue.status = "increasing";
+            colorValue.value += colorValue.value;
+        }
+    }
+    if (colorValue.velocity && decay !== 1) {
+        colorValue.velocity *= decay;
+    }
+    if (colorValue.value > max) {
+        colorValue.value %= max;
+    }
+}
+function updateStrokeColor(particle, delta) {
+    if (!particle.strokeColor || !particle.strokeAnimation) {
+        return;
+    }
+    const h = particle.strokeColor.h;
+    if (h) {
+        updateColorValue(delta, h, particle.strokeAnimation.h, 360, false);
+    }
+    const s = particle.strokeColor.s;
+    if (s) {
+        updateColorValue(delta, s, particle.strokeAnimation.s, 100, true);
+    }
+    const l = particle.strokeColor.l;
+    if (l) {
+        updateColorValue(delta, l, particle.strokeAnimation.l, 100, true);
+    }
+}
+export class StrokeColorUpdater {
+    constructor(container) {
+        this.container = container;
+    }
+    init(particle) {
+        var _a, _b, _c;
+        const container = this.container;
+        const stroke = itemFromSingleOrMultiple(particle.options.stroke, particle.id, particle.options.reduceDuplicates);
+        particle.strokeWidth = getRangeValue(stroke.width) * container.retina.pixelRatio;
+        particle.strokeOpacity = getRangeValue((_a = stroke.opacity) !== null && _a !== void 0 ? _a : 1);
+        particle.strokeAnimation = (_b = stroke.color) === null || _b === void 0 ? void 0 : _b.animation;
+        const strokeHslColor = (_c = rangeColorToHsl(stroke.color)) !== null && _c !== void 0 ? _c : particle.getFillColor();
+        if (strokeHslColor) {
+            particle.strokeColor = getHslAnimationFromHsl(strokeHslColor, particle.strokeAnimation, container.retina.reduceFactor);
+        }
+    }
+    isEnabled(particle) {
+        var _a, _b, _c;
+        const color = particle.strokeAnimation;
+        return (!particle.destroyed &&
+            !particle.spawning &&
+            !!color &&
+            ((((_a = particle.strokeColor) === null || _a === void 0 ? void 0 : _a.h.value) !== undefined && particle.strokeColor.h.enable) ||
+                (((_b = particle.strokeColor) === null || _b === void 0 ? void 0 : _b.s.value) !== undefined && particle.strokeColor.s.enable) ||
+                (((_c = particle.strokeColor) === null || _c === void 0 ? void 0 : _c.l.value) !== undefined && particle.strokeColor.l.enable)));
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateStrokeColor(particle, delta);
+    }
+}

package/browser/index.js

@@ -0,0 +1,4 @@
+import { StrokeColorUpdater } from "./StrokeColorUpdater";
+export async function loadStrokeColorUpdater(engine) {
+    await engine.addParticleUpdater("strokeColor", (container) => new StrokeColorUpdater(container));
+}

package/cjs/StrokeColorUpdater.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StrokeColorUpdater = void 0;
+const engine_1 = require("@tsparticles/engine");
+function updateColorValue(delta, value, valueAnimation, max, decrease) {
+    var _a, _b;
+    const colorValue = value;
+    if (!colorValue ||
+        !colorValue.enable ||
+        (colorValue.loops !== undefined &&
+            colorValue.maxLoops !== undefined &&
+            colorValue.maxLoops > 0 &&
+            colorValue.loops >= colorValue.maxLoops)) {
+        return;
+    }
+    const offset = (0, engine_1.randomInRange)(valueAnimation.offset), velocity = ((_a = value.velocity) !== null && _a !== void 0 ? _a : 0) * delta.factor + offset * 3.6, decay = (_b = value.decay) !== null && _b !== void 0 ? _b : 1;
+    if (!decrease || colorValue.status === "increasing") {
+        colorValue.value += velocity;
+        if (colorValue.value > max) {
+            if (!colorValue.loops) {
+                colorValue.loops = 0;
+            }
+            colorValue.loops++;
+            if (decrease) {
+                colorValue.status = "decreasing";
+                colorValue.value -= colorValue.value % max;
+            }
+        }
+    }
+    else {
+        colorValue.value -= velocity;
+        if (colorValue.value < 0) {
+            if (!colorValue.loops) {
+                colorValue.loops = 0;
+            }
+            colorValue.loops++;
+            colorValue.status = "increasing";
+            colorValue.value += colorValue.value;
+        }
+    }
+    if (colorValue.velocity && decay !== 1) {
+        colorValue.velocity *= decay;
+    }
+    if (colorValue.value > max) {
+        colorValue.value %= max;
+    }
+}
+function updateStrokeColor(particle, delta) {
+    if (!particle.strokeColor || !particle.strokeAnimation) {
+        return;
+    }
+    const h = particle.strokeColor.h;
+    if (h) {
+        updateColorValue(delta, h, particle.strokeAnimation.h, 360, false);
+    }
+    const s = particle.strokeColor.s;
+    if (s) {
+        updateColorValue(delta, s, particle.strokeAnimation.s, 100, true);
+    }
+    const l = particle.strokeColor.l;
+    if (l) {
+        updateColorValue(delta, l, particle.strokeAnimation.l, 100, true);
+    }
+}
+class StrokeColorUpdater {
+    constructor(container) {
+        this.container = container;
+    }
+    init(particle) {
+        var _a, _b, _c;
+        const container = this.container;
+        const stroke = (0, engine_1.itemFromSingleOrMultiple)(particle.options.stroke, particle.id, particle.options.reduceDuplicates);
+        particle.strokeWidth = (0, engine_1.getRangeValue)(stroke.width) * container.retina.pixelRatio;
+        particle.strokeOpacity = (0, engine_1.getRangeValue)((_a = stroke.opacity) !== null && _a !== void 0 ? _a : 1);
+        particle.strokeAnimation = (_b = stroke.color) === null || _b === void 0 ? void 0 : _b.animation;
+        const strokeHslColor = (_c = (0, engine_1.rangeColorToHsl)(stroke.color)) !== null && _c !== void 0 ? _c : particle.getFillColor();
+        if (strokeHslColor) {
+            particle.strokeColor = (0, engine_1.getHslAnimationFromHsl)(strokeHslColor, particle.strokeAnimation, container.retina.reduceFactor);
+        }
+    }
+    isEnabled(particle) {
+        var _a, _b, _c;
+        const color = particle.strokeAnimation;
+        return (!particle.destroyed &&
+            !particle.spawning &&
+            !!color &&
+            ((((_a = particle.strokeColor) === null || _a === void 0 ? void 0 : _a.h.value) !== undefined && particle.strokeColor.h.enable) ||
+                (((_b = particle.strokeColor) === null || _b === void 0 ? void 0 : _b.s.value) !== undefined && particle.strokeColor.s.enable) ||
+                (((_c = particle.strokeColor) === null || _c === void 0 ? void 0 : _c.l.value) !== undefined && particle.strokeColor.l.enable)));
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateStrokeColor(particle, delta);
+    }
+}
+exports.StrokeColorUpdater = StrokeColorUpdater;

package/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadStrokeColorUpdater = void 0;
+const StrokeColorUpdater_1 = require("./StrokeColorUpdater");
+function loadStrokeColorUpdater(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addParticleUpdater("strokeColor", (container) => new StrokeColorUpdater_1.StrokeColorUpdater(container));
+    });
+}
+exports.loadStrokeColorUpdater = loadStrokeColorUpdater;

package/esm/StrokeColorUpdater.js

@@ -0,0 +1,94 @@
+import { getHslAnimationFromHsl, getRangeValue, itemFromSingleOrMultiple, randomInRange, rangeColorToHsl, } from "@tsparticles/engine";
+function updateColorValue(delta, value, valueAnimation, max, decrease) {
+    var _a, _b;
+    const colorValue = value;
+    if (!colorValue ||
+        !colorValue.enable ||
+        (colorValue.loops !== undefined &&
+            colorValue.maxLoops !== undefined &&
+            colorValue.maxLoops > 0 &&
+            colorValue.loops >= colorValue.maxLoops)) {
+        return;
+    }
+    const offset = randomInRange(valueAnimation.offset), velocity = ((_a = value.velocity) !== null && _a !== void 0 ? _a : 0) * delta.factor + offset * 3.6, decay = (_b = value.decay) !== null && _b !== void 0 ? _b : 1;
+    if (!decrease || colorValue.status === "increasing") {
+        colorValue.value += velocity;
+        if (colorValue.value > max) {
+            if (!colorValue.loops) {
+                colorValue.loops = 0;
+            }
+            colorValue.loops++;
+            if (decrease) {
+                colorValue.status = "decreasing";
+                colorValue.value -= colorValue.value % max;
+            }
+        }
+    }
+    else {
+        colorValue.value -= velocity;
+        if (colorValue.value < 0) {
+            if (!colorValue.loops) {
+                colorValue.loops = 0;
+            }
+            colorValue.loops++;
+            colorValue.status = "increasing";
+            colorValue.value += colorValue.value;
+        }
+    }
+    if (colorValue.velocity && decay !== 1) {
+        colorValue.velocity *= decay;
+    }
+    if (colorValue.value > max) {
+        colorValue.value %= max;
+    }
+}
+function updateStrokeColor(particle, delta) {
+    if (!particle.strokeColor || !particle.strokeAnimation) {
+        return;
+    }
+    const h = particle.strokeColor.h;
+    if (h) {
+        updateColorValue(delta, h, particle.strokeAnimation.h, 360, false);
+    }
+    const s = particle.strokeColor.s;
+    if (s) {
+        updateColorValue(delta, s, particle.strokeAnimation.s, 100, true);
+    }
+    const l = particle.strokeColor.l;
+    if (l) {
+        updateColorValue(delta, l, particle.strokeAnimation.l, 100, true);
+    }
+}
+export class StrokeColorUpdater {
+    constructor(container) {
+        this.container = container;
+    }
+    init(particle) {
+        var _a, _b, _c;
+        const container = this.container;
+        const stroke = itemFromSingleOrMultiple(particle.options.stroke, particle.id, particle.options.reduceDuplicates);
+        particle.strokeWidth = getRangeValue(stroke.width) * container.retina.pixelRatio;
+        particle.strokeOpacity = getRangeValue((_a = stroke.opacity) !== null && _a !== void 0 ? _a : 1);
+        particle.strokeAnimation = (_b = stroke.color) === null || _b === void 0 ? void 0 : _b.animation;
+        const strokeHslColor = (_c = rangeColorToHsl(stroke.color)) !== null && _c !== void 0 ? _c : particle.getFillColor();
+        if (strokeHslColor) {
+            particle.strokeColor = getHslAnimationFromHsl(strokeHslColor, particle.strokeAnimation, container.retina.reduceFactor);
+        }
+    }
+    isEnabled(particle) {
+        var _a, _b, _c;
+        const color = particle.strokeAnimation;
+        return (!particle.destroyed &&
+            !particle.spawning &&
+            !!color &&
+            ((((_a = particle.strokeColor) === null || _a === void 0 ? void 0 : _a.h.value) !== undefined && particle.strokeColor.h.enable) ||
+                (((_b = particle.strokeColor) === null || _b === void 0 ? void 0 : _b.s.value) !== undefined && particle.strokeColor.s.enable) ||
+                (((_c = particle.strokeColor) === null || _c === void 0 ? void 0 : _c.l.value) !== undefined && particle.strokeColor.l.enable)));
+    }
+    update(particle, delta) {
+        if (!this.isEnabled(particle)) {
+            return;
+        }
+        updateStrokeColor(particle, delta);
+    }
+}

package/esm/index.js

@@ -0,0 +1,4 @@
+import { StrokeColorUpdater } from "./StrokeColorUpdater";
+export async function loadStrokeColorUpdater(engine) {
+    await engine.addParticleUpdater("strokeColor", (container) => new StrokeColorUpdater(container));
+}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@tsparticles/updater-stroke-color",
+  "version": "3.0.0-alpha.0",
+  "description": "tsParticles particles stroke color updater",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "updaters/strokeColor"
+  },
+  "keywords": [
+    "front-end",
+    "frontend",
+    "tsparticles",
+    "particles.js",
+    "particlesjs",
+    "particles",
+    "particle",
+    "canvas",
+    "jsparticles",
+    "xparticles",
+    "particles-js",
+    "particles-bg",
+    "particles-bg-vue",
+    "particles-ts",
+    "particles.ts",
+    "react-particles-js",
+    "react-particles.js",
+    "react-particles",
+    "react",
+    "reactjs",
+    "vue-particles",
+    "ngx-particles",
+    "angular-particles",
+    "particleground",
+    "vue",
+    "vuejs",
+    "preact",
+    "preactjs",
+    "jquery",
+    "angularjs",
+    "angular",
+    "typescript",
+    "javascript",
+    "animation",
+    "web",
+    "html5",
+    "web-design",
+    "webdesign",
+    "css",
+    "html",
+    "css3",
+    "animated",
+    "background",
+    "confetti",
+    "canvas",
+    "fireworks",
+    "fireworks-js",
+    "confetti-js",
+    "confettijs",
+    "fireworksjs",
+    "canvas-confetti",
+    "@tsparticles/plugin",
+    "@tsparticles/updater"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/matteobruni/tsparticles/issues"
+  },
+  "main": "cjs/index.js",
+  "jsdelivr": "tsparticles.updater.stroke-color.min.js",
+  "unpkg": "tsparticles.updater.stroke-color.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-alpha.0"
+  }
+}