@tsparticles/updater-twinkle 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 Twinkle Updater
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-updater-twinkle/badge)](https://www.jsdelivr.com/package/npm/tsparticles-updater-twinkle)
+[![npmjs](https://badge.fury.io/js/tsparticles-updater-twinkle.svg)](https://www.npmjs.com/package/tsparticles-updater-twinkle)
+[![npmjs](https://img.shields.io/npm/dt/tsparticles-updater-twinkle)](https://www.npmjs.com/package/tsparticles-updater-twinkle) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) updater plugin for twinkle 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.twinkle.min.js` file will export the function to load the updater plugin:
+
+```javascript
+loadTwinkleUpdater;
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the updater plugin like this:
+
+```javascript
+(async () => {
+  await loadTwinkleUpdater();
+
+  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-twinkle
+```
+
+or
+
+```shell
+$ yarn add tsparticles-updater-twinkle
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("tsparticles-engine");
+const { loadTwinkleUpdater } = require("tsparticles-updater-twinkle");
+
+loadTwinkleUpdater(tsParticles);
+```
+
+or
+
+```javascript
+import { tsParticles } from "tsparticles-engine";
+import { loadTwinkleUpdater } from "tsparticles-updater-twinkle";
+
+loadTwinkleUpdater(tsParticles);
+```

package/browser/Options/Classes/Twinkle.js

@@ -0,0 +1,14 @@
+import { TwinkleValues } from "./TwinkleValues";
+export class Twinkle {
+    constructor() {
+        this.lines = new TwinkleValues();
+        this.particles = new TwinkleValues();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        this.lines.load(data.lines);
+        this.particles.load(data.particles);
+    }
+}

package/browser/Options/Classes/TwinkleValues.js

@@ -0,0 +1,25 @@
+import { OptionsColor, setRangeValue } from "@tsparticles/engine";
+export class TwinkleValues {
+    constructor() {
+        this.enable = false;
+        this.frequency = 0.05;
+        this.opacity = 1;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.color !== undefined) {
+            this.color = OptionsColor.create(this.color, data.color);
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.frequency !== undefined) {
+            this.frequency = data.frequency;
+        }
+        if (data.opacity !== undefined) {
+            this.opacity = setRangeValue(data.opacity);
+        }
+    }
+}

package/browser/Options/Interfaces/ITwinkle.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/ITwinkleValues.js

@@ -0,0 +1 @@
+export {};

package/browser/TwinkleUpdater.js

@@ -0,0 +1,33 @@
+import { getRandom, getRangeValue, getStyleFromHsl, rangeColorToHsl } from "@tsparticles/engine";
+import { Twinkle } from "./Options/Classes/Twinkle";
+export class TwinkleUpdater {
+    getColorStyles(particle, context, radius, opacity) {
+        const pOptions = particle.options, twinkleOptions = pOptions.twinkle;
+        if (!twinkleOptions) {
+            return {};
+        }
+        const twinkle = twinkleOptions.particles, twinkling = twinkle.enable && getRandom() < twinkle.frequency, zIndexOptions = particle.options.zIndex, zOpacityFactor = (1 - particle.zIndexFactor) ** zIndexOptions.opacityRate, twinklingOpacity = twinkling ? getRangeValue(twinkle.opacity) * zOpacityFactor : opacity, twinkleRgb = rangeColorToHsl(twinkle.color), twinkleStyle = twinkleRgb ? getStyleFromHsl(twinkleRgb, twinklingOpacity) : undefined, res = {}, needsTwinkle = twinkling && twinkleStyle;
+        res.fill = needsTwinkle ? twinkleStyle : undefined;
+        res.stroke = needsTwinkle ? twinkleStyle : undefined;
+        return res;
+    }
+    init() {
+    }
+    isEnabled(particle) {
+        const pOptions = particle.options, twinkleOptions = pOptions.twinkle;
+        if (!twinkleOptions) {
+            return false;
+        }
+        return twinkleOptions.particles.enable;
+    }
+    loadOptions(options, ...sources) {
+        if (!options.twinkle) {
+            options.twinkle = new Twinkle();
+        }
+        for (const source of sources) {
+            options.twinkle.load(source === null || source === void 0 ? void 0 : source.twinkle);
+        }
+    }
+    update() {
+    }
+}

package/browser/index.js

@@ -0,0 +1,4 @@
+import { TwinkleUpdater } from "./TwinkleUpdater";
+export async function loadTwinkleUpdater(engine) {
+    await engine.addParticleUpdater("twinkle", () => new TwinkleUpdater());
+}

package/cjs/Options/Classes/Twinkle.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Twinkle = void 0;
+const TwinkleValues_1 = require("./TwinkleValues");
+class Twinkle {
+    constructor() {
+        this.lines = new TwinkleValues_1.TwinkleValues();
+        this.particles = new TwinkleValues_1.TwinkleValues();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        this.lines.load(data.lines);
+        this.particles.load(data.particles);
+    }
+}
+exports.Twinkle = Twinkle;

package/cjs/Options/Classes/TwinkleValues.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TwinkleValues = void 0;
+const engine_1 = require("@tsparticles/engine");
+class TwinkleValues {
+    constructor() {
+        this.enable = false;
+        this.frequency = 0.05;
+        this.opacity = 1;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.color !== undefined) {
+            this.color = engine_1.OptionsColor.create(this.color, data.color);
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.frequency !== undefined) {
+            this.frequency = data.frequency;
+        }
+        if (data.opacity !== undefined) {
+            this.opacity = (0, engine_1.setRangeValue)(data.opacity);
+        }
+    }
+}
+exports.TwinkleValues = TwinkleValues;

package/cjs/Options/Interfaces/ITwinkle.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/Options/Interfaces/ITwinkleValues.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/TwinkleUpdater.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TwinkleUpdater = void 0;
+const engine_1 = require("@tsparticles/engine");
+const Twinkle_1 = require("./Options/Classes/Twinkle");
+class TwinkleUpdater {
+    getColorStyles(particle, context, radius, opacity) {
+        const pOptions = particle.options, twinkleOptions = pOptions.twinkle;
+        if (!twinkleOptions) {
+            return {};
+        }
+        const twinkle = twinkleOptions.particles, twinkling = twinkle.enable && (0, engine_1.getRandom)() < twinkle.frequency, zIndexOptions = particle.options.zIndex, zOpacityFactor = Math.pow((1 - particle.zIndexFactor), zIndexOptions.opacityRate), twinklingOpacity = twinkling ? (0, engine_1.getRangeValue)(twinkle.opacity) * zOpacityFactor : opacity, twinkleRgb = (0, engine_1.rangeColorToHsl)(twinkle.color), twinkleStyle = twinkleRgb ? (0, engine_1.getStyleFromHsl)(twinkleRgb, twinklingOpacity) : undefined, res = {}, needsTwinkle = twinkling && twinkleStyle;
+        res.fill = needsTwinkle ? twinkleStyle : undefined;
+        res.stroke = needsTwinkle ? twinkleStyle : undefined;
+        return res;
+    }
+    init() {
+    }
+    isEnabled(particle) {
+        const pOptions = particle.options, twinkleOptions = pOptions.twinkle;
+        if (!twinkleOptions) {
+            return false;
+        }
+        return twinkleOptions.particles.enable;
+    }
+    loadOptions(options, ...sources) {
+        if (!options.twinkle) {
+            options.twinkle = new Twinkle_1.Twinkle();
+        }
+        for (const source of sources) {
+            options.twinkle.load(source === null || source === void 0 ? void 0 : source.twinkle);
+        }
+    }
+    update() {
+    }
+}
+exports.TwinkleUpdater = TwinkleUpdater;

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.loadTwinkleUpdater = void 0;
+const TwinkleUpdater_1 = require("./TwinkleUpdater");
+function loadTwinkleUpdater(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addParticleUpdater("twinkle", () => new TwinkleUpdater_1.TwinkleUpdater());
+    });
+}
+exports.loadTwinkleUpdater = loadTwinkleUpdater;

package/esm/Options/Classes/Twinkle.js

@@ -0,0 +1,14 @@
+import { TwinkleValues } from "./TwinkleValues";
+export class Twinkle {
+    constructor() {
+        this.lines = new TwinkleValues();
+        this.particles = new TwinkleValues();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        this.lines.load(data.lines);
+        this.particles.load(data.particles);
+    }
+}

package/esm/Options/Classes/TwinkleValues.js

@@ -0,0 +1,25 @@
+import { OptionsColor, setRangeValue } from "@tsparticles/engine";
+export class TwinkleValues {
+    constructor() {
+        this.enable = false;
+        this.frequency = 0.05;
+        this.opacity = 1;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.color !== undefined) {
+            this.color = OptionsColor.create(this.color, data.color);
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.frequency !== undefined) {
+            this.frequency = data.frequency;
+        }
+        if (data.opacity !== undefined) {
+            this.opacity = setRangeValue(data.opacity);
+        }
+    }
+}

package/esm/Options/Interfaces/ITwinkle.js

@@ -0,0 +1 @@
+export {};

package/esm/Options/Interfaces/ITwinkleValues.js

@@ -0,0 +1 @@
+export {};

package/esm/TwinkleUpdater.js

@@ -0,0 +1,33 @@
+import { getRandom, getRangeValue, getStyleFromHsl, rangeColorToHsl } from "@tsparticles/engine";
+import { Twinkle } from "./Options/Classes/Twinkle";
+export class TwinkleUpdater {
+    getColorStyles(particle, context, radius, opacity) {
+        const pOptions = particle.options, twinkleOptions = pOptions.twinkle;
+        if (!twinkleOptions) {
+            return {};
+        }
+        const twinkle = twinkleOptions.particles, twinkling = twinkle.enable && getRandom() < twinkle.frequency, zIndexOptions = particle.options.zIndex, zOpacityFactor = (1 - particle.zIndexFactor) ** zIndexOptions.opacityRate, twinklingOpacity = twinkling ? getRangeValue(twinkle.opacity) * zOpacityFactor : opacity, twinkleRgb = rangeColorToHsl(twinkle.color), twinkleStyle = twinkleRgb ? getStyleFromHsl(twinkleRgb, twinklingOpacity) : undefined, res = {}, needsTwinkle = twinkling && twinkleStyle;
+        res.fill = needsTwinkle ? twinkleStyle : undefined;
+        res.stroke = needsTwinkle ? twinkleStyle : undefined;
+        return res;
+    }
+    init() {
+    }
+    isEnabled(particle) {
+        const pOptions = particle.options, twinkleOptions = pOptions.twinkle;
+        if (!twinkleOptions) {
+            return false;
+        }
+        return twinkleOptions.particles.enable;
+    }
+    loadOptions(options, ...sources) {
+        if (!options.twinkle) {
+            options.twinkle = new Twinkle();
+        }
+        for (const source of sources) {
+            options.twinkle.load(source === null || source === void 0 ? void 0 : source.twinkle);
+        }
+    }
+    update() {
+    }
+}

package/esm/index.js

@@ -0,0 +1,4 @@
+import { TwinkleUpdater } from "./TwinkleUpdater";
+export async function loadTwinkleUpdater(engine) {
+    await engine.addParticleUpdater("twinkle", () => new TwinkleUpdater());
+}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@tsparticles/updater-twinkle",
+  "version": "3.0.0-alpha.0",
+  "description": "tsParticles particles twinkle updater",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "updaters/twinkle"
+  },
+  "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.twinkle.min.js",
+  "unpkg": "tsparticles.updater.twinkle.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-alpha.0"
+  }
+}