@tsparticles/effect-trail 3.0.0-beta.4

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,75 @@
+[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)
+
+# tsParticles Trail Effect
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/effect-trail/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/effect-trail)
+[![npmjs](https://badge.fury.io/js/@tsparticles/effect-trail.svg)](https://www.npmjs.com/package/@tsparticles/effect-trail)
+[![npmjs](https://img.shields.io/npm/dt/@tsparticles/effect-trail)](https://www.npmjs.com/package/@tsparticles/effect-trail) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/tsparticles/tsparticles) additional trail effect.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.effect.trail.min.js` file will export the function to load the effect:
+
+```text
+loadTrailEffect
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the effect like this:
+
+```javascript
+(async () => {
+  await loadTrailEffect(tsParticles);
+
+  await tsParticles.load({
+    id: "tsparticles",
+    options: {
+      /* options */
+      /* here you can use particles.effect.type: "trail" */
+    },
+  });
+})();
+```
+
+### ESM / CommonJS
+
+This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:
+
+```shell
+$ npm install @tsparticles/effect-trail
+```
+
+or
+
+```shell
+$ yarn add @tsparticles/effect-trail
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("@tsparticles/engine");
+const { loadTrailEffect } = require("@tsparticles/effect-trail");
+
+(async () => {
+  await loadTrailEffect(tsParticles);
+})();
+```
+
+or
+
+```javascript
+import { tsParticles } from "@tsparticles/engine";
+import { loadTrailEffect } from "@tsparticles/effect-trail";
+
+(async () => {
+  await loadTrailEffect(tsParticles);
+})();
+```

package/browser/TrailDrawer.js

@@ -0,0 +1,53 @@
+import { getDistance, getRangeValue, } from "@tsparticles/engine";
+export class TrailDrawer {
+    draw(data) {
+        const { context, radius, particle } = data, pxRatio = particle.container.retina.pixelRatio, currentPos = particle.getPosition();
+        if (!particle.trail || !particle.trailLength) {
+            return;
+        }
+        const pathLength = particle.trailLength;
+        particle.trail.push({
+            color: context.fillStyle ?? context.strokeStyle,
+            position: {
+                x: currentPos.x,
+                y: currentPos.y,
+            },
+        });
+        if (particle.trail.length < 2) {
+            return;
+        }
+        if (particle.trail.length > pathLength) {
+            particle.trail.shift();
+        }
+        const trailLength = Math.min(particle.trail.length, pathLength), offsetPos = {
+            x: currentPos.x,
+            y: currentPos.y,
+        };
+        let lastPos = particle.trail[trailLength - 1].position;
+        for (let i = trailLength; i > 0; i--) {
+            const step = particle.trail[i - 1], position = step.position;
+            if (getDistance(lastPos, position) > radius * 2) {
+                continue;
+            }
+            context.beginPath();
+            context.moveTo(lastPos.x - offsetPos.x, lastPos.y - offsetPos.y);
+            context.lineTo(position.x - offsetPos.x, position.y - offsetPos.y);
+            const width = Math.max((i / trailLength) * radius * 2, pxRatio, particle.trailMinWidth ?? -1);
+            context.lineWidth = particle.trailMaxWidth ? Math.min(width, particle.trailMaxWidth) : width;
+            context.strokeStyle = step.color;
+            context.stroke();
+            lastPos = position;
+        }
+    }
+    particleInit(container, particle) {
+        particle.trail = [];
+        const effectData = particle.effectData;
+        particle.trailLength = getRangeValue(effectData?.length ?? 10) * container.retina.pixelRatio;
+        particle.trailMaxWidth = effectData?.maxWidth
+            ? getRangeValue(effectData.maxWidth) * container.retina.pixelRatio
+            : undefined;
+        particle.trailMinWidth = effectData?.minWidth
+            ? getRangeValue(effectData.minWidth) * container.retina.pixelRatio
+            : undefined;
+    }
+}

package/browser/index.js

@@ -0,0 +1,4 @@
+import { TrailDrawer } from "./TrailDrawer.js";
+export async function loadTrailEffect(engine, refresh = true) {
+    await engine.addEffect("trail", new TrailDrawer(), refresh);
+}

package/browser/package.json

@@ -0,0 +1 @@
+{ "type": "module" }

package/cjs/TrailDrawer.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrailDrawer = void 0;
+const engine_1 = require("@tsparticles/engine");
+class TrailDrawer {
+    draw(data) {
+        const { context, radius, particle } = data, pxRatio = particle.container.retina.pixelRatio, currentPos = particle.getPosition();
+        if (!particle.trail || !particle.trailLength) {
+            return;
+        }
+        const pathLength = particle.trailLength;
+        particle.trail.push({
+            color: context.fillStyle ?? context.strokeStyle,
+            position: {
+                x: currentPos.x,
+                y: currentPos.y,
+            },
+        });
+        if (particle.trail.length < 2) {
+            return;
+        }
+        if (particle.trail.length > pathLength) {
+            particle.trail.shift();
+        }
+        const trailLength = Math.min(particle.trail.length, pathLength), offsetPos = {
+            x: currentPos.x,
+            y: currentPos.y,
+        };
+        let lastPos = particle.trail[trailLength - 1].position;
+        for (let i = trailLength; i > 0; i--) {
+            const step = particle.trail[i - 1], position = step.position;
+            if ((0, engine_1.getDistance)(lastPos, position) > radius * 2) {
+                continue;
+            }
+            context.beginPath();
+            context.moveTo(lastPos.x - offsetPos.x, lastPos.y - offsetPos.y);
+            context.lineTo(position.x - offsetPos.x, position.y - offsetPos.y);
+            const width = Math.max((i / trailLength) * radius * 2, pxRatio, particle.trailMinWidth ?? -1);
+            context.lineWidth = particle.trailMaxWidth ? Math.min(width, particle.trailMaxWidth) : width;
+            context.strokeStyle = step.color;
+            context.stroke();
+            lastPos = position;
+        }
+    }
+    particleInit(container, particle) {
+        particle.trail = [];
+        const effectData = particle.effectData;
+        particle.trailLength = (0, engine_1.getRangeValue)(effectData?.length ?? 10) * container.retina.pixelRatio;
+        particle.trailMaxWidth = effectData?.maxWidth
+            ? (0, engine_1.getRangeValue)(effectData.maxWidth) * container.retina.pixelRatio
+            : undefined;
+        particle.trailMinWidth = effectData?.minWidth
+            ? (0, engine_1.getRangeValue)(effectData.minWidth) * container.retina.pixelRatio
+            : undefined;
+    }
+}
+exports.TrailDrawer = TrailDrawer;

package/cjs/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadTrailEffect = void 0;
+const TrailDrawer_js_1 = require("./TrailDrawer.js");
+async function loadTrailEffect(engine, refresh = true) {
+    await engine.addEffect("trail", new TrailDrawer_js_1.TrailDrawer(), refresh);
+}
+exports.loadTrailEffect = loadTrailEffect;

package/cjs/package.json

@@ -0,0 +1 @@
+{ "type": "commonjs" }

package/esm/TrailDrawer.js

@@ -0,0 +1,53 @@
+import { getDistance, getRangeValue, } from "@tsparticles/engine";
+export class TrailDrawer {
+    draw(data) {
+        const { context, radius, particle } = data, pxRatio = particle.container.retina.pixelRatio, currentPos = particle.getPosition();
+        if (!particle.trail || !particle.trailLength) {
+            return;
+        }
+        const pathLength = particle.trailLength;
+        particle.trail.push({
+            color: context.fillStyle ?? context.strokeStyle,
+            position: {
+                x: currentPos.x,
+                y: currentPos.y,
+            },
+        });
+        if (particle.trail.length < 2) {
+            return;
+        }
+        if (particle.trail.length > pathLength) {
+            particle.trail.shift();
+        }
+        const trailLength = Math.min(particle.trail.length, pathLength), offsetPos = {
+            x: currentPos.x,
+            y: currentPos.y,
+        };
+        let lastPos = particle.trail[trailLength - 1].position;
+        for (let i = trailLength; i > 0; i--) {
+            const step = particle.trail[i - 1], position = step.position;
+            if (getDistance(lastPos, position) > radius * 2) {
+                continue;
+            }
+            context.beginPath();
+            context.moveTo(lastPos.x - offsetPos.x, lastPos.y - offsetPos.y);
+            context.lineTo(position.x - offsetPos.x, position.y - offsetPos.y);
+            const width = Math.max((i / trailLength) * radius * 2, pxRatio, particle.trailMinWidth ?? -1);
+            context.lineWidth = particle.trailMaxWidth ? Math.min(width, particle.trailMaxWidth) : width;
+            context.strokeStyle = step.color;
+            context.stroke();
+            lastPos = position;
+        }
+    }
+    particleInit(container, particle) {
+        particle.trail = [];
+        const effectData = particle.effectData;
+        particle.trailLength = getRangeValue(effectData?.length ?? 10) * container.retina.pixelRatio;
+        particle.trailMaxWidth = effectData?.maxWidth
+            ? getRangeValue(effectData.maxWidth) * container.retina.pixelRatio
+            : undefined;
+        particle.trailMinWidth = effectData?.minWidth
+            ? getRangeValue(effectData.minWidth) * container.retina.pixelRatio
+            : undefined;
+    }
+}

package/esm/index.js

@@ -0,0 +1,4 @@
+import { TrailDrawer } from "./TrailDrawer.js";
+export async function loadTrailEffect(engine, refresh = true) {
+    await engine.addEffect("trail", new TrailDrawer(), refresh);
+}

package/esm/package.json

@@ -0,0 +1 @@
+{ "type": "module" }

package/package.json

@@ -0,0 +1,108 @@
+{
+  "name": "@tsparticles/effect-trail",
+  "version": "3.0.0-beta.4",
+  "description": "tsParticles trail effect",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tsparticles/tsparticles.git",
+    "directory": "effects/trail"
+  },
+  "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-effect"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tsparticles/tsparticles/issues"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/matteobruni"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/tsparticles"
+    },
+    {
+      "type": "buymeacoffee",
+      "url": "https://www.buymeacoffee.com/matteobruni"
+    }
+  ],
+  "sideEffects": false,
+  "jsdelivr": "tsparticles.effect.trail.min.js",
+  "unpkg": "tsparticles.effect.trail.min.js",
+  "browser": "browser/index.js",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "browser": "./browser/index.js",
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js",
+      "umd": "./umd/index.js",
+      "default": "./cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-beta.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}