@tsparticles/preset-fireworks 3.0.0-alpha.1

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,212 @@
+[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)
+
+# tsParticles Fireworks Preset
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/preset-fireworks/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/preset-fireworks) [![npmjs](https://badge.fury.io/js/@tsparticles/preset-fireworks.svg)](https://www.npmjs.com/package/@tsparticles/preset-fireworks) [![npmjs](https://img.shields.io/npm/dt/@tsparticles/preset-fireworks)](https://www.npmjs.com/package/@tsparticles/preset-fireworks) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) preset for fireworks effect.
+
+[![Slack](https://particles.js.org/images/slack.png)](https://join.slack.com/t/tsparticles/shared_invite/enQtOTcxNTQxNjQ4NzkxLWE2MTZhZWExMWRmOWI5MTMxNjczOGE1Yjk0MjViYjdkYTUzODM3OTc5MGQ5MjFlODc4MzE0N2Q1OWQxZDc1YzI) [![Discord](https://particles.js.org/images/discord.png)](https://discord.gg/hACwv45Hme) [![Telegram](https://particles.js.org/images/telegram.png)](https://t.me/tsparticles)
+
+[![tsParticles Product Hunt](https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=186113&theme=light)](https://www.producthunt.com/posts/tsparticles?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-tsparticles") <a href="https://www.buymeacoffee.com/matteobruni"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a beer&emoji=🍺&slug=matteobruni&button_colour=5F7FFF&font_colour=ffffff&font_family=Arial&outline_colour=000000&coffee_colour=FFDD00"></a>
+
+## Sample
+
+[![demo](https://raw.githubusercontent.com/matteobruni/tsparticles/main/presets/fireworks/images/sample.png)](https://particles.js.org/samples/presets/fireworks)
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The first step is installing [tsParticles](https://github.com/matteobruni/tsparticles) following the instructions for
+vanilla javascript in the main project [here](https://github.com/matteobruni/tsparticles)
+
+Once installed you need one more script to be included in your page (or you can download that
+from [jsDelivr](https://www.jsdelivr.com/package/npm/@tsparticles/preset-fireworks):
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-engine@2/tsparticles.engine.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-move-base@2/tsparticles.move.base.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-plugin-emitters@2/tsparticles.plugin.emitters.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-shape-circle@2/tsparticles.shape.circle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-shape-line@2/tsparticles.shape.line.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-updater-angle@2/tsparticles.updater.angle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-updater-color@2/tsparticles.updater.color.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-updater-life@2/tsparticles.updater.life.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-updater-opacity@2/tsparticles.updater.opacity.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-updater-out-modes@2/tsparticles.updater.out-modes.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-updater-size@2/tsparticles.updater.size.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-updater-stroke-color@2/tsparticles.updater.stroke-color.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-fireworks@2/tsparticles.preset.fireworks.min.js"></script>
+```
+
+This script **MUST** be placed after the `tsParticles` one.
+
+#### Bundle
+
+A bundled script can also be used, this will include every needed plugin needed by the preset.
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-fireworks@2/tsparticles.preset.fireworks.bundle.min.js"></script>
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` like this:
+
+```javascript
+(async () => {
+  await loadFireworksPreset(tsParticles); // this is required only if you are not using the bundle script
+
+  await tsParticles.load("tsparticles", {
+    preset: "fireworks",
+  });
+})();
+```
+
+#### Customization
+
+**Important ⚠️**
+You can override all the options defining the properties like in any standard `tsParticles` installation.
+
+```javascript
+tsParticles.load("tsparticles", {
+  particles: {
+    shape: {
+      type: "square", // starting from v2, this require the square shape script
+    },
+  },
+  preset: "fireworks",
+});
+```
+
+Like in the sample above, the circles will be replaced by squares.
+
+### React.js / Preact / Inferno
+
+_The syntax for `React.js`, `Preact` and `Inferno` is the same_.
+
+This sample uses the class component syntax, but you can use hooks as well (if the library supports it).
+
+```typescript jsx
+import Particles from "react-particles";
+import type { Engine } from "tsparticles-engine";
+import { loadFireworksPreset } from "@tsparticles/preset-fireworks";
+
+export class ParticlesContainer extends React.PureComponent<IProps> {
+  // this customizes the component tsParticles installation
+  async customInit(engine: Engine): Promise<void> {
+    // this adds the preset to tsParticles, you can safely use the
+    await loadFireworksPreset(engine);
+  }
+
+  render() {
+    const options = {
+      preset: "fireworks",
+    };
+
+    return <Particles options={options} init={this.customInit} />;
+  }
+}
+```
+
+### Vue (2.x and 3.x)
+
+_The syntax for `Vue.js 2.x` and `3.x` is the same_
+
+```vue
+<Particles id="tsparticles" :particlesInit="particlesInit" :options="particlesOptions" />
+```
+
+```ts
+const particlesOptions = {
+  preset: "fireworks",
+};
+
+async function particlesInit(engine: Engine): Promise<void> {
+  await loadFireworksPreset(engine);
+}
+```
+
+### Angular
+
+```html
+<angular-particles [id]="id" [options]="particlesOptions" [particlesInit]="particlesInit"></angular-particles>
+```
+
+```ts
+const particlesOptions = {
+  preset: "fireworks",
+};
+
+async function particlesInit(engine: Engine): Promise<void> {
+  await loadFireworksPreset(engine);
+}
+```
+
+### Svelte
+
+```sveltehtml
+
+<Particles
+        id="tsparticles"
+        options={particlesOptions}
+        particlesInit={particlesInit}
+/>
+```
+
+```js
+let particlesOptions = {
+  preset: "fireworks",
+};
+
+let particlesInit = async (engine) => {
+  await loadFireworksPreset(engine);
+};
+```
+
+---
+
+```mermaid
+flowchart TD
+
+subgraph m [Movers]
+mb[Base]
+end
+
+e[tsParticles Engine] --> m
+
+subgraph pl [Plugins]
+ple[Emitters]
+end
+
+e --> pl
+
+subgraph s [Shapes]
+sc[Circle]
+sl[Line]
+end
+
+e --> s
+
+subgraph u [Updaters]
+ua[Angle]
+uc[Color]
+ud[Destroy]
+ul[Life]
+uop[Opacity]
+uou[Out Modes]
+usi[Size]
+ust[Stroke Color]
+end
+
+e --> u
+
+subgraph pr [Presets]
+prfw[Fireworks]
+end
+
+e --> pr
+
+mb & ple & sc & sl & ua & uc & ud & ul & uop & uou & usi & ust --> prfw
+```

package/browser/bundle.js

@@ -0,0 +1,6 @@
+import { loadFireworksPreset } from ".";
+import { tsParticles } from "@tsparticles/engine";
+(async () => {
+    await loadFireworksPreset(tsParticles);
+})();
+export { loadFireworksPreset, tsParticles };

package/browser/index.js

@@ -0,0 +1,30 @@
+import { loadAngleUpdater } from "@tsparticles/updater-angle";
+import { loadBaseMover } from "@tsparticles/move-base";
+import { loadCircleShape } from "@tsparticles/shape-circle";
+import { loadColorUpdater } from "@tsparticles/updater-color";
+import { loadDestroyUpdater } from "@tsparticles/updater-destroy";
+import { loadEmittersPlugin } from "@tsparticles/plugin-emitters";
+import { loadLifeUpdater } from "@tsparticles/updater-life";
+import { loadLineShape } from "@tsparticles/shape-line";
+import { loadOpacityUpdater } from "@tsparticles/updater-opacity";
+import { loadOutModesUpdater } from "@tsparticles/updater-out-modes";
+import { loadSizeUpdater } from "@tsparticles/updater-size";
+import { loadSoundsPlugin } from "@tsparticles/plugin-sounds";
+import { loadStrokeColorUpdater } from "@tsparticles/updater-stroke-color";
+import { options } from "./options";
+export async function loadFireworksPreset(engine) {
+    await loadBaseMover(engine);
+    await loadEmittersPlugin(engine);
+    await loadSoundsPlugin(engine);
+    await loadCircleShape(engine);
+    await loadLineShape(engine);
+    await loadAngleUpdater(engine);
+    await loadColorUpdater(engine);
+    await loadDestroyUpdater(engine);
+    await loadLifeUpdater(engine);
+    await loadOpacityUpdater(engine);
+    await loadOutModesUpdater(engine);
+    await loadSizeUpdater(engine);
+    await loadStrokeColorUpdater(engine);
+    await engine.addPreset("fireworks", options);
+}

package/browser/options.js

@@ -0,0 +1,203 @@
+import { rgbToHsl, setRangeValue, stringToRgb, } from "@tsparticles/engine";
+const explodeSoundCheck = (args) => {
+    const data = args.data;
+    return data.particle.shape === "line";
+};
+const fixRange = (value, min, max) => {
+    const diffSMax = value.max > max ? value.max - max : 0;
+    let res = setRangeValue(value);
+    if (diffSMax) {
+        res = setRangeValue(value.min - diffSMax, max);
+    }
+    const diffSMin = value.min < min ? value.min : 0;
+    if (diffSMin) {
+        res = setRangeValue(0, value.max + diffSMin);
+    }
+    return res;
+};
+const fireworksOptions = ["#ff595e", "#ffca3a", "#8ac926", "#1982c4", "#6a4c93"]
+    .map((color) => {
+    const rgb = stringToRgb(color);
+    if (!rgb) {
+        return undefined;
+    }
+    const hsl = rgbToHsl(rgb), sRange = fixRange({ min: hsl.s - 30, max: hsl.s + 30 }, 0, 100), lRange = fixRange({ min: hsl.l - 30, max: hsl.l + 30 }, 0, 100);
+    return {
+        color: {
+            value: {
+                h: hsl.h,
+                s: sRange,
+                l: lRange,
+            },
+        },
+        stroke: {
+            width: 0,
+        },
+        number: {
+            value: 0,
+        },
+        opacity: {
+            value: {
+                min: 0.1,
+                max: 1,
+            },
+            animation: {
+                enable: true,
+                speed: 0.7,
+                sync: false,
+                startValue: "max",
+                destroy: "min",
+            },
+        },
+        shape: {
+            type: "circle",
+        },
+        size: {
+            value: { min: 1, max: 2 },
+            animation: {
+                enable: true,
+                speed: 5,
+                count: 1,
+                sync: false,
+                startValue: "min",
+                destroy: "none",
+            },
+        },
+        life: {
+            count: 1,
+            duration: {
+                value: {
+                    min: 1,
+                    max: 2,
+                },
+            },
+        },
+        move: {
+            decay: { min: 0.075, max: 0.1 },
+            enable: true,
+            gravity: {
+                enable: true,
+                inverse: false,
+                acceleration: 5,
+            },
+            speed: { min: 5, max: 15 },
+            direction: "none",
+            outModes: "destroy",
+        },
+    };
+})
+    .filter((t) => t !== undefined);
+export const options = {
+    detectRetina: true,
+    background: {
+        color: "#000",
+    },
+    fpsLimit: 120,
+    emitters: {
+        direction: "top",
+        life: {
+            count: 0,
+            duration: 0.1,
+            delay: 0.1,
+        },
+        rate: {
+            delay: 0.05,
+            quantity: 1,
+        },
+        size: {
+            width: 100,
+            height: 0,
+        },
+        position: {
+            y: 100,
+            x: 50,
+        },
+    },
+    particles: {
+        number: {
+            value: 0,
+        },
+        destroy: {
+            mode: "split",
+            bounds: {
+                top: { min: 10, max: 30 },
+            },
+            split: {
+                sizeOffset: false,
+                count: 1,
+                factor: {
+                    value: 0.333333,
+                },
+                rate: {
+                    value: { min: 75, max: 150 },
+                },
+                particles: fireworksOptions,
+            },
+        },
+        life: {
+            count: 1,
+        },
+        shape: {
+            type: "line",
+        },
+        size: {
+            value: {
+                min: 0.1,
+                max: 50,
+            },
+            animation: {
+                enable: true,
+                sync: true,
+                speed: 90,
+                startValue: "max",
+                destroy: "min",
+            },
+        },
+        stroke: {
+            color: {
+                value: "#ffffff",
+            },
+            width: 1,
+        },
+        rotate: {
+            path: true,
+        },
+        move: {
+            enable: true,
+            gravity: {
+                acceleration: 15,
+                enable: true,
+                inverse: true,
+                maxSpeed: 100,
+            },
+            speed: {
+                min: 10,
+                max: 20,
+            },
+            outModes: {
+                default: "destroy",
+                top: "none",
+            },
+            trail: {
+                fillColor: "#000",
+                enable: true,
+                length: 10,
+            },
+        },
+    },
+    sounds: {
+        enable: true,
+        events: [
+            {
+                event: "particleRemoved",
+                filter: explodeSoundCheck,
+                audio: [
+                    "https://particles.js.org/audio/explosion0.mp3",
+                    "https://particles.js.org/audio/explosion1.mp3",
+                    "https://particles.js.org/audio/explosion2.mp3",
+                ],
+            },
+        ],
+        volume: 50,
+    },
+};

package/cjs/bundle.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.tsParticles = exports.loadFireworksPreset = void 0;
+const _1 = require(".");
+Object.defineProperty(exports, "loadFireworksPreset", { enumerable: true, get: function () { return _1.loadFireworksPreset; } });
+const engine_1 = require("@tsparticles/engine");
+Object.defineProperty(exports, "tsParticles", { enumerable: true, get: function () { return engine_1.tsParticles; } });
+(() => __awaiter(void 0, void 0, void 0, function* () {
+    yield (0, _1.loadFireworksPreset)(engine_1.tsParticles);
+}))();

package/cjs/index.js

@@ -0,0 +1,45 @@
+"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.loadFireworksPreset = void 0;
+const updater_angle_1 = require("@tsparticles/updater-angle");
+const move_base_1 = require("@tsparticles/move-base");
+const shape_circle_1 = require("@tsparticles/shape-circle");
+const updater_color_1 = require("@tsparticles/updater-color");
+const updater_destroy_1 = require("@tsparticles/updater-destroy");
+const plugin_emitters_1 = require("@tsparticles/plugin-emitters");
+const updater_life_1 = require("@tsparticles/updater-life");
+const shape_line_1 = require("@tsparticles/shape-line");
+const updater_opacity_1 = require("@tsparticles/updater-opacity");
+const updater_out_modes_1 = require("@tsparticles/updater-out-modes");
+const updater_size_1 = require("@tsparticles/updater-size");
+const plugin_sounds_1 = require("@tsparticles/plugin-sounds");
+const updater_stroke_color_1 = require("@tsparticles/updater-stroke-color");
+const options_1 = require("./options");
+function loadFireworksPreset(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield (0, move_base_1.loadBaseMover)(engine);
+        yield (0, plugin_emitters_1.loadEmittersPlugin)(engine);
+        yield (0, plugin_sounds_1.loadSoundsPlugin)(engine);
+        yield (0, shape_circle_1.loadCircleShape)(engine);
+        yield (0, shape_line_1.loadLineShape)(engine);
+        yield (0, updater_angle_1.loadAngleUpdater)(engine);
+        yield (0, updater_color_1.loadColorUpdater)(engine);
+        yield (0, updater_destroy_1.loadDestroyUpdater)(engine);
+        yield (0, updater_life_1.loadLifeUpdater)(engine);
+        yield (0, updater_opacity_1.loadOpacityUpdater)(engine);
+        yield (0, updater_out_modes_1.loadOutModesUpdater)(engine);
+        yield (0, updater_size_1.loadSizeUpdater)(engine);
+        yield (0, updater_stroke_color_1.loadStrokeColorUpdater)(engine);
+        yield engine.addPreset("fireworks", options_1.options);
+    });
+}
+exports.loadFireworksPreset = loadFireworksPreset;