@tsparticles/move-parallax 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 Parallax Mover
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-move-parallax/badge)](https://www.jsdelivr.com/package/npm/tsparticles-move-parallax)
+[![npmjs](https://badge.fury.io/js/tsparticles-move-parallax.svg)](https://www.npmjs.com/package/tsparticles-move-parallax)
+[![npmjs](https://img.shields.io/npm/dt/tsparticles-move-parallax)](https://www.npmjs.com/package/tsparticles-move-parallax) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) move plugin for parallax effect.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.move.parallax.min.js` file will export the function to load the interaction plugin:
+
+```javascript
+loadParallaxMover;
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the interaction plugin like this:
+
+```javascript
+(async () => {
+  await loadParallaxMover(tsParticles);
+
+  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-move-parallax
+```
+
+or
+
+```shell
+$ yarn add tsparticles-move-parallax
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("tsparticles-engine");
+const { loadParallaxMover } = require("tsparticles-move-parallax");
+
+loadParallaxMover(tsParticles); // awaitable
+```
+
+or
+
+```javascript
+import { tsParticles } from "tsparticles-engine";
+import { loadParallaxMover } from "tsparticles-move-parallax";
+
+loadParallaxMover(tsParticles); // awaitable
+```

package/browser/ParallaxMover.js

@@ -0,0 +1,29 @@
+import { isSsr } from "@tsparticles/engine";
+export class ParallaxMover {
+    init() {
+    }
+    isEnabled(particle) {
+        return (!isSsr() &&
+            !particle.destroyed &&
+            particle.container.actualOptions.interactivity.events.onHover.parallax.enable);
+    }
+    move(particle) {
+        const container = particle.container, options = container.actualOptions;
+        if (isSsr() || !options.interactivity.events.onHover.parallax.enable) {
+            return;
+        }
+        const parallaxForce = options.interactivity.events.onHover.parallax.force, mousePos = container.interactivity.mouse.position;
+        if (!mousePos) {
+            return;
+        }
+        const canvasCenter = {
+            x: container.canvas.size.width / 2,
+            y: container.canvas.size.height / 2,
+        }, parallaxSmooth = options.interactivity.events.onHover.parallax.smooth, factor = particle.getRadius() / parallaxForce, centerDistance = {
+            x: (mousePos.x - canvasCenter.x) * factor,
+            y: (mousePos.y - canvasCenter.y) * factor,
+        };
+        particle.offset.x += (centerDistance.x - particle.offset.x) / parallaxSmooth;
+        particle.offset.y += (centerDistance.y - particle.offset.y) / parallaxSmooth;
+    }
+}

package/browser/index.js

@@ -0,0 +1,4 @@
+import { ParallaxMover } from "./ParallaxMover";
+export async function loadParallaxMover(engine) {
+    engine.addMover("parallax", () => new ParallaxMover());
+}

package/cjs/ParallaxMover.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParallaxMover = void 0;
+const engine_1 = require("@tsparticles/engine");
+class ParallaxMover {
+    init() {
+    }
+    isEnabled(particle) {
+        return (!(0, engine_1.isSsr)() &&
+            !particle.destroyed &&
+            particle.container.actualOptions.interactivity.events.onHover.parallax.enable);
+    }
+    move(particle) {
+        const container = particle.container, options = container.actualOptions;
+        if ((0, engine_1.isSsr)() || !options.interactivity.events.onHover.parallax.enable) {
+            return;
+        }
+        const parallaxForce = options.interactivity.events.onHover.parallax.force, mousePos = container.interactivity.mouse.position;
+        if (!mousePos) {
+            return;
+        }
+        const canvasCenter = {
+            x: container.canvas.size.width / 2,
+            y: container.canvas.size.height / 2,
+        }, parallaxSmooth = options.interactivity.events.onHover.parallax.smooth, factor = particle.getRadius() / parallaxForce, centerDistance = {
+            x: (mousePos.x - canvasCenter.x) * factor,
+            y: (mousePos.y - canvasCenter.y) * factor,
+        };
+        particle.offset.x += (centerDistance.x - particle.offset.x) / parallaxSmooth;
+        particle.offset.y += (centerDistance.y - particle.offset.y) / parallaxSmooth;
+    }
+}
+exports.ParallaxMover = ParallaxMover;

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.loadParallaxMover = void 0;
+const ParallaxMover_1 = require("./ParallaxMover");
+function loadParallaxMover(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        engine.addMover("parallax", () => new ParallaxMover_1.ParallaxMover());
+    });
+}
+exports.loadParallaxMover = loadParallaxMover;

package/esm/ParallaxMover.js

@@ -0,0 +1,29 @@
+import { isSsr } from "@tsparticles/engine";
+export class ParallaxMover {
+    init() {
+    }
+    isEnabled(particle) {
+        return (!isSsr() &&
+            !particle.destroyed &&
+            particle.container.actualOptions.interactivity.events.onHover.parallax.enable);
+    }
+    move(particle) {
+        const container = particle.container, options = container.actualOptions;
+        if (isSsr() || !options.interactivity.events.onHover.parallax.enable) {
+            return;
+        }
+        const parallaxForce = options.interactivity.events.onHover.parallax.force, mousePos = container.interactivity.mouse.position;
+        if (!mousePos) {
+            return;
+        }
+        const canvasCenter = {
+            x: container.canvas.size.width / 2,
+            y: container.canvas.size.height / 2,
+        }, parallaxSmooth = options.interactivity.events.onHover.parallax.smooth, factor = particle.getRadius() / parallaxForce, centerDistance = {
+            x: (mousePos.x - canvasCenter.x) * factor,
+            y: (mousePos.y - canvasCenter.y) * factor,
+        };
+        particle.offset.x += (centerDistance.x - particle.offset.x) / parallaxSmooth;
+        particle.offset.y += (centerDistance.y - particle.offset.y) / parallaxSmooth;
+    }
+}

package/esm/index.js

@@ -0,0 +1,4 @@
+import { ParallaxMover } from "./ParallaxMover";
+export async function loadParallaxMover(engine) {
+    engine.addMover("parallax", () => new ParallaxMover());
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@tsparticles/move-parallax",
+  "version": "3.0.0-alpha.0",
+  "description": "tsParticles Parallax movement",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "move/parallax"
+  },
+  "keywords": [
+    "front-end",
+    "frontend",
+    "tsparticles",
+    "particles",
+    "particle",
+    "canvas",
+    "jsparticles",
+    "xparticles",
+    "particles-js",
+    "particles.js",
+    "particles-ts",
+    "particles.ts",
+    "typescript",
+    "javascript",
+    "animation",
+    "web",
+    "html5",
+    "web-design",
+    "webdesign",
+    "css",
+    "html",
+    "css3",
+    "animated",
+    "background",
+    "@tsparticles/shape"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/matteobruni/tsparticles/issues"
+  },
+  "main": "cjs/index.js",
+  "jsdelivr": "tsparticles.move.parallax.min.js",
+  "unpkg": "tsparticles.move.parallax.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-alpha.0"
+  }
+}