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

package/browser/Options/Classes/Push.js

@@ -0,0 +1,32 @@
+export class Push {
+    constructor() {
+        this.default = true;
+        this.groups = [];
+        this.quantity = 4;
+    }
+    get particles_nb() {
+        return this.quantity;
+    }
+    set particles_nb(value) {
+        this.quantity = value;
+    }
+    load(data) {
+        var _a;
+        if (!data) {
+            return;
+        }
+        if (data.default !== undefined) {
+            this.default = data.default;
+        }
+        if (data.groups !== undefined) {
+            this.groups = data.groups.map((t) => t);
+        }
+        if (!this.groups.length) {
+            this.default = true;
+        }
+        const quantity = (_a = data.quantity) !== null && _a !== void 0 ? _a : data.particles_nb;
+        if (quantity !== undefined) {
+            this.quantity = quantity;
+        }
+    }
+}

package/browser/Options/Classes/PushOptions.js

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

package/browser/Options/Interfaces/IPush.js

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

package/browser/Pusher.js

@@ -0,0 +1,42 @@
+import { ExternalInteractorBase } from "@tsparticles/engine";
+import { Push } from "./Options/Classes/Push";
+import { itemFromArray } from "@tsparticles/engine";
+export class Pusher extends ExternalInteractorBase {
+    constructor(container) {
+        super(container);
+        this.handleClickMode = (mode) => {
+            if (mode !== "push") {
+                return;
+            }
+            const container = this.container, options = container.actualOptions, pushOptions = options.interactivity.modes.push;
+            if (!pushOptions) {
+                return;
+            }
+            const pushNb = pushOptions.quantity;
+            if (pushNb <= 0) {
+                return;
+            }
+            const group = itemFromArray([undefined, ...pushOptions.groups]), groupOptions = group !== undefined ? container.actualOptions.particles.groups[group] : undefined;
+            container.particles.push(pushNb, container.interactivity.mouse, groupOptions, group);
+        };
+    }
+    clear() {
+    }
+    init() {
+    }
+    async interact() {
+    }
+    isEnabled() {
+        return true;
+    }
+    loadModeOptions(options, ...sources) {
+        if (!options.push) {
+            options.push = new Push();
+        }
+        for (const source of sources) {
+            options.push.load(source === null || source === void 0 ? void 0 : source.push);
+        }
+    }
+    reset() {
+    }
+}

package/browser/Types.js

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

package/browser/index.js

@@ -0,0 +1,6 @@
+import { Pusher } from "./Pusher";
+export async function loadExternalPushInteraction(engine) {
+    await engine.addInteractor("externalPush", (container) => new Pusher(container));
+}
+export * from "./Options/Classes/Push";
+export * from "./Options/Interfaces/IPush";

package/cjs/Options/Classes/Push.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Push = void 0;
+class Push {
+    constructor() {
+        this.default = true;
+        this.groups = [];
+        this.quantity = 4;
+    }
+    get particles_nb() {
+        return this.quantity;
+    }
+    set particles_nb(value) {
+        this.quantity = value;
+    }
+    load(data) {
+        var _a;
+        if (!data) {
+            return;
+        }
+        if (data.default !== undefined) {
+            this.default = data.default;
+        }
+        if (data.groups !== undefined) {
+            this.groups = data.groups.map((t) => t);
+        }
+        if (!this.groups.length) {
+            this.default = true;
+        }
+        const quantity = (_a = data.quantity) !== null && _a !== void 0 ? _a : data.particles_nb;
+        if (quantity !== undefined) {
+            this.quantity = quantity;
+        }
+    }
+}
+exports.Push = Push;

package/cjs/Options/Classes/PushOptions.js

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

package/cjs/Options/Interfaces/IPush.js

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

package/cjs/Pusher.js

@@ -0,0 +1,57 @@
+"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.Pusher = void 0;
+const engine_1 = require("@tsparticles/engine");
+const Push_1 = require("./Options/Classes/Push");
+const engine_2 = require("@tsparticles/engine");
+class Pusher extends engine_1.ExternalInteractorBase {
+    constructor(container) {
+        super(container);
+        this.handleClickMode = (mode) => {
+            if (mode !== "push") {
+                return;
+            }
+            const container = this.container, options = container.actualOptions, pushOptions = options.interactivity.modes.push;
+            if (!pushOptions) {
+                return;
+            }
+            const pushNb = pushOptions.quantity;
+            if (pushNb <= 0) {
+                return;
+            }
+            const group = (0, engine_2.itemFromArray)([undefined, ...pushOptions.groups]), groupOptions = group !== undefined ? container.actualOptions.particles.groups[group] : undefined;
+            container.particles.push(pushNb, container.interactivity.mouse, groupOptions, group);
+        };
+    }
+    clear() {
+    }
+    init() {
+    }
+    interact() {
+        return __awaiter(this, void 0, void 0, function* () {
+        });
+    }
+    isEnabled() {
+        return true;
+    }
+    loadModeOptions(options, ...sources) {
+        if (!options.push) {
+            options.push = new Push_1.Push();
+        }
+        for (const source of sources) {
+            options.push.load(source === null || source === void 0 ? void 0 : source.push);
+        }
+    }
+    reset() {
+    }
+}
+exports.Pusher = Pusher;

package/cjs/Types.js

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

package/cjs/index.js

@@ -0,0 +1,35 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+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.loadExternalPushInteraction = void 0;
+const Pusher_1 = require("./Pusher");
+function loadExternalPushInteraction(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addInteractor("externalPush", (container) => new Pusher_1.Pusher(container));
+    });
+}
+exports.loadExternalPushInteraction = loadExternalPushInteraction;
+__exportStar(require("./Options/Classes/Push"), exports);
+__exportStar(require("./Options/Interfaces/IPush"), exports);

package/esm/Options/Classes/Push.js

@@ -0,0 +1,32 @@
+export class Push {
+    constructor() {
+        this.default = true;
+        this.groups = [];
+        this.quantity = 4;
+    }
+    get particles_nb() {
+        return this.quantity;
+    }
+    set particles_nb(value) {
+        this.quantity = value;
+    }
+    load(data) {
+        var _a;
+        if (!data) {
+            return;
+        }
+        if (data.default !== undefined) {
+            this.default = data.default;
+        }
+        if (data.groups !== undefined) {
+            this.groups = data.groups.map((t) => t);
+        }
+        if (!this.groups.length) {
+            this.default = true;
+        }
+        const quantity = (_a = data.quantity) !== null && _a !== void 0 ? _a : data.particles_nb;
+        if (quantity !== undefined) {
+            this.quantity = quantity;
+        }
+    }
+}

package/esm/Options/Classes/PushOptions.js

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

package/esm/Options/Interfaces/IPush.js

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

package/esm/Pusher.js

@@ -0,0 +1,42 @@
+import { ExternalInteractorBase } from "@tsparticles/engine";
+import { Push } from "./Options/Classes/Push";
+import { itemFromArray } from "@tsparticles/engine";
+export class Pusher extends ExternalInteractorBase {
+    constructor(container) {
+        super(container);
+        this.handleClickMode = (mode) => {
+            if (mode !== "push") {
+                return;
+            }
+            const container = this.container, options = container.actualOptions, pushOptions = options.interactivity.modes.push;
+            if (!pushOptions) {
+                return;
+            }
+            const pushNb = pushOptions.quantity;
+            if (pushNb <= 0) {
+                return;
+            }
+            const group = itemFromArray([undefined, ...pushOptions.groups]), groupOptions = group !== undefined ? container.actualOptions.particles.groups[group] : undefined;
+            container.particles.push(pushNb, container.interactivity.mouse, groupOptions, group);
+        };
+    }
+    clear() {
+    }
+    init() {
+    }
+    async interact() {
+    }
+    isEnabled() {
+        return true;
+    }
+    loadModeOptions(options, ...sources) {
+        if (!options.push) {
+            options.push = new Push();
+        }
+        for (const source of sources) {
+            options.push.load(source === null || source === void 0 ? void 0 : source.push);
+        }
+    }
+    reset() {
+    }
+}

package/esm/Types.js

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

package/esm/index.js

@@ -0,0 +1,6 @@
+import { Pusher } from "./Pusher";
+export async function loadExternalPushInteraction(engine) {
+    await engine.addInteractor("externalPush", (container) => new Pusher(container));
+}
+export * from "./Options/Classes/Push";
+export * from "./Options/Interfaces/IPush";

package/package.json

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