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

package/browser/MotionInstance.js

@@ -0,0 +1,49 @@
+import { safeMatchMedia } from "@tsparticles/engine";
+export class MotionInstance {
+    constructor(container, engine) {
+        this._container = container;
+        this._engine = engine;
+    }
+    async init() {
+        const container = this._container, options = container.actualOptions.motion;
+        if (options && (options.disable || options.reduce.value)) {
+            const mediaQuery = safeMatchMedia("(prefers-reduced-motion: reduce)");
+            if (mediaQuery) {
+                this._handleMotionChange(mediaQuery);
+                const handleChange = async () => {
+                    this._handleMotionChange(mediaQuery);
+                    try {
+                        await container.refresh();
+                    }
+                    catch (_a) {
+                    }
+                };
+                if (mediaQuery.addEventListener !== undefined) {
+                    mediaQuery.addEventListener("change", handleChange);
+                }
+                else if (mediaQuery.addListener !== undefined) {
+                    mediaQuery.addListener(handleChange);
+                }
+            }
+            else {
+                container.retina.reduceFactor = 1;
+            }
+        }
+        else {
+            container.retina.reduceFactor = 1;
+        }
+    }
+    _handleMotionChange(mediaQuery) {
+        const container = this._container, motion = container.actualOptions.motion;
+        if (!motion) {
+            return;
+        }
+        container.retina.reduceFactor = mediaQuery.matches
+            ? motion.disable
+                ? 0
+                : motion.reduce.value
+                    ? 1 / motion.reduce.factor
+                    : 1
+            : 1;
+    }
+}

package/browser/Options/Classes/Motion.js

@@ -0,0 +1,16 @@
+import { MotionReduce } from "./MotionReduce";
+export class Motion {
+    constructor() {
+        this.disable = false;
+        this.reduce = new MotionReduce();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.disable !== undefined) {
+            this.disable = data.disable;
+        }
+        this.reduce.load(data.reduce);
+    }
+}

package/browser/Options/Classes/MotionReduce.js

@@ -0,0 +1,17 @@
+export class MotionReduce {
+    constructor() {
+        this.factor = 4;
+        this.value = true;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.factor !== undefined) {
+            this.factor = data.factor;
+        }
+        if (data.value !== undefined) {
+            this.value = data.value;
+        }
+    }
+}

package/browser/Options/Interfaces/IMotion.js

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

package/browser/Options/Interfaces/IMotionReduce.js

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

package/browser/index.js

@@ -0,0 +1,28 @@
+import { Motion } from "./Options/Classes/Motion";
+import { MotionInstance } from "./MotionInstance";
+class MotionPlugin {
+    constructor(engine) {
+        this.id = "motion";
+        this._engine = engine;
+    }
+    getPlugin(container) {
+        return new MotionInstance(container, this._engine);
+    }
+    loadOptions(options, source) {
+        if (!this.needsPlugin()) {
+            return;
+        }
+        let motionOptions = options.motion;
+        if ((motionOptions === null || motionOptions === void 0 ? void 0 : motionOptions.load) === undefined) {
+            options.motion = motionOptions = new Motion();
+        }
+        motionOptions.load(source === null || source === void 0 ? void 0 : source.motion);
+    }
+    needsPlugin() {
+        return true;
+    }
+}
+export async function loadMotionPlugin(engine) {
+    const plugin = new MotionPlugin(engine);
+    await engine.addPlugin(plugin);
+}

package/browser/types.js

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

package/cjs/MotionInstance.js

@@ -0,0 +1,64 @@
+"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.MotionInstance = void 0;
+const engine_1 = require("@tsparticles/engine");
+class MotionInstance {
+    constructor(container, engine) {
+        this._container = container;
+        this._engine = engine;
+    }
+    init() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const container = this._container, options = container.actualOptions.motion;
+            if (options && (options.disable || options.reduce.value)) {
+                const mediaQuery = (0, engine_1.safeMatchMedia)("(prefers-reduced-motion: reduce)");
+                if (mediaQuery) {
+                    this._handleMotionChange(mediaQuery);
+                    const handleChange = () => __awaiter(this, void 0, void 0, function* () {
+                        this._handleMotionChange(mediaQuery);
+                        try {
+                            yield container.refresh();
+                        }
+                        catch (_a) {
+                        }
+                    });
+                    if (mediaQuery.addEventListener !== undefined) {
+                        mediaQuery.addEventListener("change", handleChange);
+                    }
+                    else if (mediaQuery.addListener !== undefined) {
+                        mediaQuery.addListener(handleChange);
+                    }
+                }
+                else {
+                    container.retina.reduceFactor = 1;
+                }
+            }
+            else {
+                container.retina.reduceFactor = 1;
+            }
+        });
+    }
+    _handleMotionChange(mediaQuery) {
+        const container = this._container, motion = container.actualOptions.motion;
+        if (!motion) {
+            return;
+        }
+        container.retina.reduceFactor = mediaQuery.matches
+            ? motion.disable
+                ? 0
+                : motion.reduce.value
+                    ? 1 / motion.reduce.factor
+                    : 1
+            : 1;
+    }
+}
+exports.MotionInstance = MotionInstance;

package/cjs/Options/Classes/Motion.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Motion = void 0;
+const MotionReduce_1 = require("./MotionReduce");
+class Motion {
+    constructor() {
+        this.disable = false;
+        this.reduce = new MotionReduce_1.MotionReduce();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.disable !== undefined) {
+            this.disable = data.disable;
+        }
+        this.reduce.load(data.reduce);
+    }
+}
+exports.Motion = Motion;

package/cjs/Options/Classes/MotionReduce.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MotionReduce = void 0;
+class MotionReduce {
+    constructor() {
+        this.factor = 4;
+        this.value = true;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.factor !== undefined) {
+            this.factor = data.factor;
+        }
+        if (data.value !== undefined) {
+            this.value = data.value;
+        }
+    }
+}
+exports.MotionReduce = MotionReduce;

package/cjs/Options/Interfaces/IMotion.js

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

package/cjs/Options/Interfaces/IMotionReduce.js

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

package/cjs/index.js

@@ -0,0 +1,43 @@
+"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.loadMotionPlugin = void 0;
+const Motion_1 = require("./Options/Classes/Motion");
+const MotionInstance_1 = require("./MotionInstance");
+class MotionPlugin {
+    constructor(engine) {
+        this.id = "motion";
+        this._engine = engine;
+    }
+    getPlugin(container) {
+        return new MotionInstance_1.MotionInstance(container, this._engine);
+    }
+    loadOptions(options, source) {
+        if (!this.needsPlugin()) {
+            return;
+        }
+        let motionOptions = options.motion;
+        if ((motionOptions === null || motionOptions === void 0 ? void 0 : motionOptions.load) === undefined) {
+            options.motion = motionOptions = new Motion_1.Motion();
+        }
+        motionOptions.load(source === null || source === void 0 ? void 0 : source.motion);
+    }
+    needsPlugin() {
+        return true;
+    }
+}
+function loadMotionPlugin(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const plugin = new MotionPlugin(engine);
+        yield engine.addPlugin(plugin);
+    });
+}
+exports.loadMotionPlugin = loadMotionPlugin;

package/cjs/types.js

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

package/esm/MotionInstance.js

@@ -0,0 +1,49 @@
+import { safeMatchMedia } from "@tsparticles/engine";
+export class MotionInstance {
+    constructor(container, engine) {
+        this._container = container;
+        this._engine = engine;
+    }
+    async init() {
+        const container = this._container, options = container.actualOptions.motion;
+        if (options && (options.disable || options.reduce.value)) {
+            const mediaQuery = safeMatchMedia("(prefers-reduced-motion: reduce)");
+            if (mediaQuery) {
+                this._handleMotionChange(mediaQuery);
+                const handleChange = async () => {
+                    this._handleMotionChange(mediaQuery);
+                    try {
+                        await container.refresh();
+                    }
+                    catch (_a) {
+                    }
+                };
+                if (mediaQuery.addEventListener !== undefined) {
+                    mediaQuery.addEventListener("change", handleChange);
+                }
+                else if (mediaQuery.addListener !== undefined) {
+                    mediaQuery.addListener(handleChange);
+                }
+            }
+            else {
+                container.retina.reduceFactor = 1;
+            }
+        }
+        else {
+            container.retina.reduceFactor = 1;
+        }
+    }
+    _handleMotionChange(mediaQuery) {
+        const container = this._container, motion = container.actualOptions.motion;
+        if (!motion) {
+            return;
+        }
+        container.retina.reduceFactor = mediaQuery.matches
+            ? motion.disable
+                ? 0
+                : motion.reduce.value
+                    ? 1 / motion.reduce.factor
+                    : 1
+            : 1;
+    }
+}

package/esm/Options/Classes/Motion.js

@@ -0,0 +1,16 @@
+import { MotionReduce } from "./MotionReduce";
+export class Motion {
+    constructor() {
+        this.disable = false;
+        this.reduce = new MotionReduce();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.disable !== undefined) {
+            this.disable = data.disable;
+        }
+        this.reduce.load(data.reduce);
+    }
+}

package/esm/Options/Classes/MotionReduce.js

@@ -0,0 +1,17 @@
+export class MotionReduce {
+    constructor() {
+        this.factor = 4;
+        this.value = true;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.factor !== undefined) {
+            this.factor = data.factor;
+        }
+        if (data.value !== undefined) {
+            this.value = data.value;
+        }
+    }
+}

package/esm/Options/Interfaces/IMotion.js

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

package/esm/Options/Interfaces/IMotionReduce.js

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

package/esm/index.js

@@ -0,0 +1,28 @@
+import { Motion } from "./Options/Classes/Motion";
+import { MotionInstance } from "./MotionInstance";
+class MotionPlugin {
+    constructor(engine) {
+        this.id = "motion";
+        this._engine = engine;
+    }
+    getPlugin(container) {
+        return new MotionInstance(container, this._engine);
+    }
+    loadOptions(options, source) {
+        if (!this.needsPlugin()) {
+            return;
+        }
+        let motionOptions = options.motion;
+        if ((motionOptions === null || motionOptions === void 0 ? void 0 : motionOptions.load) === undefined) {
+            options.motion = motionOptions = new Motion();
+        }
+        motionOptions.load(source === null || source === void 0 ? void 0 : source.motion);
+    }
+    needsPlugin() {
+        return true;
+    }
+}
+export async function loadMotionPlugin(engine) {
+    const plugin = new MotionPlugin(engine);
+    await engine.addPlugin(plugin);
+}

package/esm/types.js

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

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@tsparticles/plugin-motion",
+  "version": "3.0.0-alpha.0",
+  "description": "tsParticles motion sickness plugin",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "plugins/motion"
+  },
+  "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"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/matteobruni/tsparticles/issues"
+  },
+  "main": "cjs/index.js",
+  "jsdelivr": "tsparticles.plugin.motion.min.js",
+  "unpkg": "tsparticles.plugin.motion.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-alpha.0"
+  }
+}