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

package/browser/Bubbler.js

@@ -0,0 +1,294 @@
+import { Circle, ExternalInteractorBase, Rectangle, clamp, colorMix, divMode, divModeExecute, getDistance, getRangeMax, isDivModeEnabled, isInArray, itemFromSingleOrMultiple, mouseLeaveEvent, mouseMoveEvent, rangeColorToHsl, rgbToHsl, } from "@tsparticles/engine";
+import { Bubble } from "./Options/Classes/Bubble";
+function calculateBubbleValue(particleValue, modeValue, optionsValue, ratio) {
+    if (modeValue >= optionsValue) {
+        const value = particleValue + (modeValue - optionsValue) * ratio;
+        return clamp(value, particleValue, modeValue);
+    }
+    else if (modeValue < optionsValue) {
+        const value = particleValue - (optionsValue - modeValue) * ratio;
+        return clamp(value, modeValue, particleValue);
+    }
+}
+export class Bubbler extends ExternalInteractorBase {
+    constructor(container) {
+        super(container);
+        if (!container.bubble) {
+            container.bubble = {};
+        }
+        this.handleClickMode = (mode) => {
+            if (mode !== "bubble") {
+                return;
+            }
+            if (!container.bubble) {
+                container.bubble = {};
+            }
+            container.bubble.clicking = true;
+        };
+    }
+    clear(particle, delta, force) {
+        if (particle.bubble.inRange && !force) {
+            return;
+        }
+        delete particle.bubble.div;
+        delete particle.bubble.opacity;
+        delete particle.bubble.radius;
+        delete particle.bubble.color;
+    }
+    init() {
+        const container = this.container, bubble = container.actualOptions.interactivity.modes.bubble;
+        if (!bubble) {
+            return;
+        }
+        container.retina.bubbleModeDistance = bubble.distance * container.retina.pixelRatio;
+        if (bubble.size !== undefined) {
+            container.retina.bubbleModeSize = bubble.size * container.retina.pixelRatio;
+        }
+    }
+    async interact(delta) {
+        const options = this.container.actualOptions, events = options.interactivity.events, onHover = events.onHover, onClick = events.onClick, hoverEnabled = onHover.enable, hoverMode = onHover.mode, clickEnabled = onClick.enable, clickMode = onClick.mode, divs = events.onDiv;
+        if (hoverEnabled && isInArray("bubble", hoverMode)) {
+            this.hoverBubble(delta);
+        }
+        else if (clickEnabled && isInArray("bubble", clickMode)) {
+            this.clickBubble(delta);
+        }
+        else {
+            divModeExecute("bubble", divs, (selector, div) => this.singleSelectorHover(delta, selector, div));
+        }
+    }
+    isEnabled(particle) {
+        var _a;
+        const container = this.container, options = container.actualOptions, mouse = container.interactivity.mouse, events = ((_a = particle === null || particle === void 0 ? void 0 : particle.interactivity) !== null && _a !== void 0 ? _a : options.interactivity).events, divs = events.onDiv, divBubble = isDivModeEnabled("bubble", divs);
+        if (!(divBubble || (events.onHover.enable && mouse.position) || (events.onClick.enable && mouse.clickPosition))) {
+            return false;
+        }
+        const hoverMode = events.onHover.mode;
+        const clickMode = events.onClick.mode;
+        return isInArray("bubble", hoverMode) || isInArray("bubble", clickMode) || divBubble;
+    }
+    loadModeOptions(options, ...sources) {
+        if (!options.bubble) {
+            options.bubble = new Bubble();
+        }
+        for (const source of sources) {
+            options.bubble.load(source === null || source === void 0 ? void 0 : source.bubble);
+        }
+    }
+    reset(particle) {
+        particle.bubble.inRange = false;
+    }
+    clickBubble(delta) {
+        var _a, _b;
+        const container = this.container, options = container.actualOptions, mouseClickPos = container.interactivity.mouse.clickPosition, bubble = options.interactivity.modes.bubble;
+        if (!bubble || !mouseClickPos) {
+            return;
+        }
+        if (!container.bubble) {
+            container.bubble = {};
+        }
+        const distance = container.retina.bubbleModeDistance;
+        if (!distance || distance < 0) {
+            return;
+        }
+        const query = container.particles.quadTree.queryCircle(mouseClickPos, distance, (p) => this.isEnabled(p));
+        for (const particle of query) {
+            if (!container.bubble.clicking) {
+                continue;
+            }
+            particle.bubble.inRange = !container.bubble.durationEnd;
+            const pos = particle.getPosition(), distMouse = getDistance(pos, mouseClickPos), timeSpent = (new Date().getTime() - (container.interactivity.mouse.clickTime || 0)) / 1000;
+            if (timeSpent > bubble.duration) {
+                container.bubble.durationEnd = true;
+            }
+            if (timeSpent > bubble.duration * 2) {
+                container.bubble.clicking = false;
+                container.bubble.durationEnd = false;
+            }
+            const sizeData = {
+                bubbleObj: {
+                    optValue: container.retina.bubbleModeSize,
+                    value: particle.bubble.radius,
+                },
+                particlesObj: {
+                    optValue: getRangeMax(particle.options.size.value) * container.retina.pixelRatio,
+                    value: particle.size.value,
+                },
+                type: "size",
+            };
+            this.process(particle, distMouse, timeSpent, sizeData);
+            const opacityData = {
+                bubbleObj: {
+                    optValue: bubble.opacity,
+                    value: particle.bubble.opacity,
+                },
+                particlesObj: {
+                    optValue: getRangeMax(particle.options.opacity.value),
+                    value: (_b = (_a = particle.opacity) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : 1,
+                },
+                type: "opacity",
+            };
+            this.process(particle, distMouse, timeSpent, opacityData);
+            if (!container.bubble.durationEnd) {
+                if (distMouse <= distance) {
+                    this.hoverBubbleColor(particle, distMouse);
+                }
+                else {
+                    delete particle.bubble.color;
+                }
+            }
+            else {
+                delete particle.bubble.color;
+            }
+        }
+    }
+    hoverBubble(delta) {
+        const container = this.container, mousePos = container.interactivity.mouse.position, distance = container.retina.bubbleModeDistance;
+        if (!distance || distance < 0 || mousePos === undefined) {
+            return;
+        }
+        const query = container.particles.quadTree.queryCircle(mousePos, distance, (p) => this.isEnabled(p));
+        for (const particle of query) {
+            particle.bubble.inRange = true;
+            const pos = particle.getPosition(), pointDistance = getDistance(pos, mousePos), ratio = 1 - pointDistance / distance;
+            if (pointDistance <= distance) {
+                if (ratio >= 0 && container.interactivity.status === mouseMoveEvent) {
+                    this.hoverBubbleSize(particle, ratio);
+                    this.hoverBubbleOpacity(particle, ratio);
+                    this.hoverBubbleColor(particle, ratio);
+                }
+            }
+            else {
+                this.reset(particle);
+            }
+            if (container.interactivity.status === mouseLeaveEvent) {
+                this.reset(particle);
+            }
+        }
+    }
+    hoverBubbleColor(particle, ratio, divBubble) {
+        const options = this.container.actualOptions;
+        const bubbleOptions = divBubble !== null && divBubble !== void 0 ? divBubble : options.interactivity.modes.bubble;
+        if (!bubbleOptions) {
+            return;
+        }
+        if (!particle.bubble.finalColor) {
+            const modeColor = bubbleOptions.color;
+            if (!modeColor) {
+                return;
+            }
+            const bubbleColor = itemFromSingleOrMultiple(modeColor);
+            particle.bubble.finalColor = rangeColorToHsl(bubbleColor);
+        }
+        if (!particle.bubble.finalColor) {
+            return;
+        }
+        if (bubbleOptions.mix) {
+            particle.bubble.color = undefined;
+            const pColor = particle.getFillColor();
+            particle.bubble.color = pColor
+                ? rgbToHsl(colorMix(pColor, particle.bubble.finalColor, 1 - ratio, ratio))
+                : particle.bubble.finalColor;
+        }
+        else {
+            particle.bubble.color = particle.bubble.finalColor;
+        }
+    }
+    hoverBubbleOpacity(particle, ratio, divBubble) {
+        var _a, _b, _c, _d;
+        const container = this.container, options = container.actualOptions, modeOpacity = (_a = divBubble === null || divBubble === void 0 ? void 0 : divBubble.opacity) !== null && _a !== void 0 ? _a : (_b = options.interactivity.modes.bubble) === null || _b === void 0 ? void 0 : _b.opacity;
+        if (!modeOpacity) {
+            return;
+        }
+        const optOpacity = particle.options.opacity.value;
+        const pOpacity = (_d = (_c = particle.opacity) === null || _c === void 0 ? void 0 : _c.value) !== null && _d !== void 0 ? _d : 1;
+        const opacity = calculateBubbleValue(pOpacity, modeOpacity, getRangeMax(optOpacity), ratio);
+        if (opacity !== undefined) {
+            particle.bubble.opacity = opacity;
+        }
+    }
+    hoverBubbleSize(particle, ratio, divBubble) {
+        const container = this.container, modeSize = (divBubble === null || divBubble === void 0 ? void 0 : divBubble.size) ? divBubble.size * container.retina.pixelRatio : container.retina.bubbleModeSize;
+        if (modeSize === undefined) {
+            return;
+        }
+        const optSize = getRangeMax(particle.options.size.value) * container.retina.pixelRatio;
+        const pSize = particle.size.value;
+        const size = calculateBubbleValue(pSize, modeSize, optSize, ratio);
+        if (size !== undefined) {
+            particle.bubble.radius = size;
+        }
+    }
+    process(particle, distMouse, timeSpent, data) {
+        const container = this.container, bubbleParam = data.bubbleObj.optValue, options = container.actualOptions, bubble = options.interactivity.modes.bubble;
+        if (!bubble || bubbleParam === undefined) {
+            return;
+        }
+        const bubbleDuration = bubble.duration, bubbleDistance = container.retina.bubbleModeDistance, particlesParam = data.particlesObj.optValue, pObjBubble = data.bubbleObj.value, pObj = data.particlesObj.value || 0, type = data.type;
+        if (!bubbleDistance || bubbleDistance < 0 || bubbleParam === particlesParam) {
+            return;
+        }
+        if (!container.bubble) {
+            container.bubble = {};
+        }
+        if (!container.bubble.durationEnd) {
+            if (distMouse <= bubbleDistance) {
+                const obj = pObjBubble !== null && pObjBubble !== void 0 ? pObjBubble : pObj;
+                if (obj !== bubbleParam) {
+                    const value = pObj - (timeSpent * (pObj - bubbleParam)) / bubbleDuration;
+                    if (type === "size") {
+                        particle.bubble.radius = value;
+                    }
+                    if (type === "opacity") {
+                        particle.bubble.opacity = value;
+                    }
+                }
+            }
+            else {
+                if (type === "size") {
+                    delete particle.bubble.radius;
+                }
+                if (type === "opacity") {
+                    delete particle.bubble.opacity;
+                }
+            }
+        }
+        else if (pObjBubble) {
+            if (type === "size") {
+                delete particle.bubble.radius;
+            }
+            if (type === "opacity") {
+                delete particle.bubble.opacity;
+            }
+        }
+    }
+    singleSelectorHover(delta, selector, div) {
+        const container = this.container, selectors = document.querySelectorAll(selector), bubble = container.actualOptions.interactivity.modes.bubble;
+        if (!bubble || !selectors.length) {
+            return;
+        }
+        selectors.forEach((item) => {
+            const elem = item, pxRatio = container.retina.pixelRatio, pos = {
+                x: (elem.offsetLeft + elem.offsetWidth / 2) * pxRatio,
+                y: (elem.offsetTop + elem.offsetHeight / 2) * pxRatio,
+            }, repulseRadius = (elem.offsetWidth / 2) * pxRatio, area = div.type === "circle"
+                ? new Circle(pos.x, pos.y, repulseRadius)
+                : new Rectangle(elem.offsetLeft * pxRatio, elem.offsetTop * pxRatio, elem.offsetWidth * pxRatio, elem.offsetHeight * pxRatio), query = container.particles.quadTree.query(area, (p) => this.isEnabled(p));
+            for (const particle of query) {
+                if (!area.contains(particle.getPosition())) {
+                    continue;
+                }
+                particle.bubble.inRange = true;
+                const divs = bubble.divs;
+                const divBubble = divMode(divs, elem);
+                if (!particle.bubble.div || particle.bubble.div !== elem) {
+                    this.clear(particle, delta, true);
+                    particle.bubble.div = elem;
+                }
+                this.hoverBubbleSize(particle, 1, divBubble);
+                this.hoverBubbleOpacity(particle, 1, divBubble);
+                this.hoverBubbleColor(particle, 1, divBubble);
+            }
+        });
+    }
+}

package/browser/IBubblerProcessParam.js

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

package/browser/Options/Classes/Bubble.js

@@ -0,0 +1,16 @@
+import { BubbleBase } from "./BubbleBase";
+import { BubbleDiv } from "./BubbleDiv";
+import { executeOnSingleOrMultiple } from "@tsparticles/engine";
+export class Bubble extends BubbleBase {
+    load(data) {
+        super.load(data);
+        if (!data) {
+            return;
+        }
+        this.divs = executeOnSingleOrMultiple(data.divs, (div) => {
+            const tmp = new BubbleDiv();
+            tmp.load(div);
+            return tmp;
+        });
+    }
+}

package/browser/Options/Classes/BubbleBase.js

@@ -0,0 +1,34 @@
+import { OptionsColor, executeOnSingleOrMultiple } from "@tsparticles/engine";
+export class BubbleBase {
+    constructor() {
+        this.distance = 200;
+        this.duration = 0.4;
+        this.mix = false;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.distance !== undefined) {
+            this.distance = data.distance;
+        }
+        if (data.duration !== undefined) {
+            this.duration = data.duration;
+        }
+        if (data.mix !== undefined) {
+            this.mix = data.mix;
+        }
+        if (data.opacity !== undefined) {
+            this.opacity = data.opacity;
+        }
+        if (data.color !== undefined) {
+            const sourceColor = this.color instanceof Array ? undefined : this.color;
+            this.color = executeOnSingleOrMultiple(data.color, (color) => {
+                return OptionsColor.create(sourceColor, color);
+            });
+        }
+        if (data.size !== undefined) {
+            this.size = data.size;
+        }
+    }
+}

package/browser/Options/Classes/BubbleDiv.js

@@ -0,0 +1,26 @@
+import { BubbleBase } from "./BubbleBase";
+import { executeOnSingleOrMultiple } from "@tsparticles/engine";
+export class BubbleDiv extends BubbleBase {
+    constructor() {
+        super();
+        this.selectors = [];
+    }
+    get ids() {
+        return executeOnSingleOrMultiple(this.selectors, (t) => t.replace("#", ""));
+    }
+    set ids(value) {
+        this.selectors = executeOnSingleOrMultiple(value, (t) => `#${t}`);
+    }
+    load(data) {
+        super.load(data);
+        if (!data) {
+            return;
+        }
+        if (data.ids !== undefined) {
+            this.ids = data.ids;
+        }
+        if (data.selectors !== undefined) {
+            this.selectors = data.selectors;
+        }
+    }
+}

package/browser/Options/Classes/BubbleOptions.js

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

package/browser/Options/Interfaces/IBubble.js

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

package/browser/Options/Interfaces/IBubbleBase.js

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

package/browser/Options/Interfaces/IBubbleDiv.js

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

package/browser/ProcessBubbleType.js

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

package/browser/Types.js

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

package/browser/index.js

@@ -0,0 +1,10 @@
+import { Bubbler } from "./Bubbler";
+export async function loadExternalBubbleInteraction(engine) {
+    await engine.addInteractor("externalBubble", (container) => new Bubbler(container));
+}
+export * from "./Options/Classes/BubbleBase";
+export * from "./Options/Classes/BubbleDiv";
+export * from "./Options/Classes/Bubble";
+export * from "./Options/Interfaces/IBubbleBase";
+export * from "./Options/Interfaces/IBubbleDiv";
+export * from "./Options/Interfaces/IBubble";