@tsparticles/preset-fireworks 3.0.0 → 3.0.2

package/README.md

@@ -4,7 +4,7 @@
 
 [![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.
+[tsParticles](https://github.com/tsparticles/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)
 
@@ -12,43 +12,14 @@
 
 ## Sample
 
-[![demo](https://raw.githubusercontent.com/matteobruni/tsparticles/main/presets/fireworks/images/sample.png)](https://particles.js.org/samples/presets/fireworks)
+[![demo](https://raw.githubusercontent.com/tsparticles/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/basic@2/tsparticles.basic.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-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-rotate@2/tsparticles.updater.angle.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>
+<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-fireworks@3/tsparticles.preset.fireworks.bundle.min.js"></script>
 ```
 
 ### Usage
@@ -56,13 +27,12 @@ A bundled script can also be used, this will include every needed plugin needed
 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", {
+tsParticles.load({
+  id: "tsparticles",
+  options: {
     preset: "fireworks",
-  });
-})();
+  },
+});
 ```
 
 #### Customization
@@ -71,100 +41,26 @@ Once the scripts are loaded you can set up `tsParticles` like this:
 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
+tsParticles.load({
+  id: "tsparticles",
+  options: {
+    particles: {
+      shape: {
+        type: "square", // starting from v2, this require the square shape script
+      },
     },
+    preset: "fireworks",
   },
-  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",
-};
+### Frameworks with a tsParticles component library
 
-async function particlesInit(engine: Engine): Promise<void> {
-  await loadFireworksPreset(engine);
-}
-```
-
-### Angular
-
-```html
-<ng-particles [id]="id" [options]="particlesOptions" [particlesInit]="particlesInit"></ng-particles>
-```
+Checkout the documentation in the component library repository and call the `loadFireworksPreset` function instead of `loadFull`, `loadSlim` or similar functions.
 
-```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);
-};
-```
+The options shown above are valid for all the component libraries.
 
 ---
 

package/browser/bundle.js

@@ -1,4 +1,4 @@
-import { loadFireworksPreset } from ".";
+import { loadFireworksPreset } from "./index.js";
 import { tsParticles } from "@tsparticles/engine";
-loadFireworksPreset(tsParticles);
+void loadFireworksPreset(tsParticles);
 export { loadFireworksPreset, tsParticles };

package/browser/index.js

@@ -7,7 +7,7 @@ import { loadLineShape } from "@tsparticles/shape-line";
 import { loadRotateUpdater } from "@tsparticles/updater-rotate";
 import { loadSoundsPlugin } from "@tsparticles/plugin-sounds";
 import { loadStrokeColorUpdater } from "@tsparticles/updater-stroke-color";
-import { options } from "./options";
+import { options } from "./options.js";
 export async function loadFireworksPreset(engine, refresh = true) {
     await loadBasic(engine, false);
     await loadEmittersPlugin(engine, false);

package/browser/options.js

@@ -4,14 +4,14 @@ const explodeSoundCheck = (args) => {
     return data.particle.shape === "line";
 };
 const fixRange = (value, min, max) => {
-    const diffSMax = value.max > max ? value.max - max : 0;
+    const minValue = 0, diffSMax = value.max > max ? value.max - max : minValue;
     let res = setRangeValue(value);
     if (diffSMax) {
         res = setRangeValue(value.min - diffSMax, max);
     }
-    const diffSMin = value.min < min ? value.min : 0;
+    const diffSMin = value.min < min ? value.min : minValue;
     if (diffSMin) {
-        res = setRangeValue(0, value.max + diffSMin);
+        res = setRangeValue(minValue, value.max + diffSMin);
     }
     return res;
 };
@@ -21,7 +21,13 @@ const fireworksOptions = ["#ff595e", "#ffca3a", "#8ac926", "#1982c4", "#6a4c93"]
     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);
+    const hsl = rgbToHsl(rgb), sOffset = 30, lOffset = 30, sBounds = {
+        min: 0,
+        max: 100,
+    }, lBounds = {
+        min: 0,
+        max: 100,
+    }, sRange = fixRange({ min: hsl.s - sOffset, max: hsl.s + sOffset }, sBounds.min, sBounds.max), lRange = fixRange({ min: hsl.l - lOffset, max: hsl.l + lOffset }, lBounds.min, lBounds.max);
     return {
         color: {
             value: {

package/cjs/bundle.js

@@ -1,8 +1,8 @@
 "use strict";
 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 index_js_1 = require("./index.js");
+Object.defineProperty(exports, "loadFireworksPreset", { enumerable: true, get: function () { return index_js_1.loadFireworksPreset; } });
 const engine_1 = require("@tsparticles/engine");
 Object.defineProperty(exports, "tsParticles", { enumerable: true, get: function () { return engine_1.tsParticles; } });
-(0, _1.loadFireworksPreset)(engine_1.tsParticles);
+void (0, index_js_1.loadFireworksPreset)(engine_1.tsParticles);

package/cjs/index.js

@@ -10,7 +10,7 @@ const shape_line_1 = require("@tsparticles/shape-line");
 const updater_rotate_1 = require("@tsparticles/updater-rotate");
 const plugin_sounds_1 = require("@tsparticles/plugin-sounds");
 const updater_stroke_color_1 = require("@tsparticles/updater-stroke-color");
-const options_1 = require("./options");
+const options_js_1 = require("./options.js");
 async function loadFireworksPreset(engine, refresh = true) {
     await (0, basic_1.loadBasic)(engine, false);
     await (0, plugin_emitters_1.loadEmittersPlugin)(engine, false);
@@ -21,6 +21,6 @@ async function loadFireworksPreset(engine, refresh = true) {
     await (0, updater_destroy_1.loadDestroyUpdater)(engine, false);
     await (0, updater_life_1.loadLifeUpdater)(engine, false);
     await (0, updater_stroke_color_1.loadStrokeColorUpdater)(engine, false);
-    await engine.addPreset("fireworks", options_1.options, refresh);
+    await engine.addPreset("fireworks", options_js_1.options, refresh);
 }
 exports.loadFireworksPreset = loadFireworksPreset;

package/cjs/options.js

@@ -7,14 +7,14 @@ const explodeSoundCheck = (args) => {
     return data.particle.shape === "line";
 };
 const fixRange = (value, min, max) => {
-    const diffSMax = value.max > max ? value.max - max : 0;
+    const minValue = 0, diffSMax = value.max > max ? value.max - max : minValue;
     let res = (0, engine_1.setRangeValue)(value);
     if (diffSMax) {
         res = (0, engine_1.setRangeValue)(value.min - diffSMax, max);
     }
-    const diffSMin = value.min < min ? value.min : 0;
+    const diffSMin = value.min < min ? value.min : minValue;
     if (diffSMin) {
-        res = (0, engine_1.setRangeValue)(0, value.max + diffSMin);
+        res = (0, engine_1.setRangeValue)(minValue, value.max + diffSMin);
     }
     return res;
 };
@@ -24,7 +24,13 @@ const fireworksOptions = ["#ff595e", "#ffca3a", "#8ac926", "#1982c4", "#6a4c93"]
     if (!rgb) {
         return undefined;
     }
-    const hsl = (0, engine_1.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);
+    const hsl = (0, engine_1.rgbToHsl)(rgb), sOffset = 30, lOffset = 30, sBounds = {
+        min: 0,
+        max: 100,
+    }, lBounds = {
+        min: 0,
+        max: 100,
+    }, sRange = fixRange({ min: hsl.s - sOffset, max: hsl.s + sOffset }, sBounds.min, sBounds.max), lRange = fixRange({ min: hsl.l - lOffset, max: hsl.l + lOffset }, lBounds.min, lBounds.max);
     return {
         color: {
             value: {

package/esm/bundle.js

@@ -1,4 +1,4 @@
-import { loadFireworksPreset } from ".";
+import { loadFireworksPreset } from "./index.js";
 import { tsParticles } from "@tsparticles/engine";
-loadFireworksPreset(tsParticles);
+void loadFireworksPreset(tsParticles);
 export { loadFireworksPreset, tsParticles };

package/esm/index.js

@@ -7,7 +7,7 @@ import { loadLineShape } from "@tsparticles/shape-line";
 import { loadRotateUpdater } from "@tsparticles/updater-rotate";
 import { loadSoundsPlugin } from "@tsparticles/plugin-sounds";
 import { loadStrokeColorUpdater } from "@tsparticles/updater-stroke-color";
-import { options } from "./options";
+import { options } from "./options.js";
 export async function loadFireworksPreset(engine, refresh = true) {
     await loadBasic(engine, false);
     await loadEmittersPlugin(engine, false);

package/esm/options.js

@@ -4,14 +4,14 @@ const explodeSoundCheck = (args) => {
     return data.particle.shape === "line";
 };
 const fixRange = (value, min, max) => {
-    const diffSMax = value.max > max ? value.max - max : 0;
+    const minValue = 0, diffSMax = value.max > max ? value.max - max : minValue;
     let res = setRangeValue(value);
     if (diffSMax) {
         res = setRangeValue(value.min - diffSMax, max);
     }
-    const diffSMin = value.min < min ? value.min : 0;
+    const diffSMin = value.min < min ? value.min : minValue;
     if (diffSMin) {
-        res = setRangeValue(0, value.max + diffSMin);
+        res = setRangeValue(minValue, value.max + diffSMin);
     }
     return res;
 };
@@ -21,7 +21,13 @@ const fireworksOptions = ["#ff595e", "#ffca3a", "#8ac926", "#1982c4", "#6a4c93"]
     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);
+    const hsl = rgbToHsl(rgb), sOffset = 30, lOffset = 30, sBounds = {
+        min: 0,
+        max: 100,
+    }, lBounds = {
+        min: 0,
+        max: 100,
+    }, sRange = fixRange({ min: hsl.s - sOffset, max: hsl.s + sOffset }, sBounds.min, sBounds.max), lRange = fixRange({ min: hsl.l - lOffset, max: hsl.l + lOffset }, lBounds.min, lBounds.max);
     return {
         color: {
             value: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/preset-fireworks",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "tsParticles fireworks preset",
   "homepage": "https://particles.js.org",
   "repository": {
@@ -87,16 +87,16 @@
   "module": "esm/index.js",
   "types": "types/index.d.ts",
   "dependencies": {
-    "@tsparticles/basic": "^3.0.0",
-    "@tsparticles/engine": "^3.0.0",
-    "@tsparticles/plugin-emitters": "^3.0.0",
-    "@tsparticles/plugin-emitters-shape-square": "^3.0.0",
-    "@tsparticles/plugin-sounds": "^3.0.0",
-    "@tsparticles/shape-line": "^3.0.0",
-    "@tsparticles/updater-destroy": "^3.0.0",
-    "@tsparticles/updater-life": "^3.0.0",
-    "@tsparticles/updater-rotate": "^3.0.0",
-    "@tsparticles/updater-stroke-color": "^3.0.0"
+    "@tsparticles/basic": "^3.0.3",
+    "@tsparticles/engine": "^3.0.3",
+    "@tsparticles/plugin-emitters": "^3.0.3",
+    "@tsparticles/plugin-emitters-shape-square": "^3.0.3",
+    "@tsparticles/plugin-sounds": "^3.0.3",
+    "@tsparticles/shape-line": "^3.0.3",
+    "@tsparticles/updater-destroy": "^3.0.3",
+    "@tsparticles/updater-life": "^3.0.3",
+    "@tsparticles/updater-rotate": "^3.0.3",
+    "@tsparticles/updater-stroke-color": "^3.0.3"
   },
   "publishConfig": {
     "access": "public"