@tsparticles/shape-spiral 3.0.0-alpha.0 → 3.0.0-beta.0

package/README.md

@@ -2,9 +2,9 @@
 
 # tsParticles Spiral Shape
 
-[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-shape-spiral/badge)](https://www.jsdelivr.com/package/npm/tsparticles-shape-spiral)
-[![npmjs](https://badge.fury.io/js/tsparticles-shape-spiral.svg)](https://www.npmjs.com/package/tsparticles-shape-spiral)
-[![npmjs](https://img.shields.io/npm/dt/tsparticles-shape-spiral)](https://www.npmjs.com/package/tsparticles-shape-spiral) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/shape-spiral/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/shape-spiral)
+[![npmjs](https://badge.fury.io/js/@tsparticles/shape-spiral.svg)](https://www.npmjs.com/package/@tsparticles/shape-spiral)
+[![npmjs](https://img.shields.io/npm/dt/@tsparticles/shape-spiral)](https://www.npmjs.com/package/@tsparticles/shape-spiral) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
 
 [tsParticles](https://github.com/matteobruni/tsparticles) additional spiral shape.
 
@@ -26,7 +26,7 @@ Once the scripts are loaded you can set up `tsParticles` and the shape like this
 
 ```javascript
 (async () => {
-  await loadSpiralShape();
+  await loadSpiralShape(tsParticles);
 
   await tsParticles.load({
     id: "tsparticles",
@@ -43,29 +43,33 @@ Once the scripts are loaded you can set up `tsParticles` and the shape like this
 This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:
 
 ```shell
-$ npm install tsparticles-shape-spiral
+$ npm install @tsparticles/shape-spiral
 ```
 
 or
 
 ```shell
-$ yarn add tsparticles-shape-spiral
+$ yarn add @tsparticles/shape-spiral
 ```
 
 Then you need to import it in the app, like this:
 
 ```javascript
-const { tsParticles } = require("tsparticles-engine");
-const { loadSpiralShape } = require("tsparticles-shape-spiral");
+const { tsParticles } = require("@tsparticles/engine");
+const { loadSpiralShape } = require("@tsparticles/shape-spiral");
 
-loadSpiralShape(tsParticles);
+(async () => {
+  await loadSpiralShape(tsParticles);
+})();
 ```
 
 or
 
 ```javascript
-import { tsParticles } from "tsparticles-engine";
-import { loadSpiralShape } from "tsparticles-shape-spiral";
+import { tsParticles } from "@tsparticles/engine";
+import { loadSpiralShape } from "@tsparticles/shape-spiral";
 
-loadSpiralShape(tsParticles);
+(async () => {
+  await loadSpiralShape(tsParticles);
+})();
 ```

package/browser/SpiralDrawer.js

@@ -1,15 +1,24 @@
+import { getRangeValue } from "@tsparticles/engine";
 export class SpiralDrawer {
     draw(context, particle, radius) {
-        const spiral = particle, realWidth = (radius - spiral.spiralInnerRadius) / spiral.spiralLineSpacing;
-        for (let i = 0; i < realWidth * 10; i++) {
-            const angle = 0.1 * i, positionFactor = spiral.spiralInnerRadius + spiral.spiralLineSpacing * angle, x = positionFactor * Math.cos(angle), y = positionFactor * Math.sin(angle);
-            context.lineTo(x, y);
+        if (particle.spiralInnerRadius === undefined ||
+            particle.spiralLineSpacing === undefined ||
+            particle.spiralWidthFactor === undefined) {
+            return;
+        }
+        const realWidth = (radius - particle.spiralInnerRadius) / particle.spiralLineSpacing, widthFactor = 10;
+        for (let i = 0; i < realWidth * widthFactor; i++) {
+            const angle = i / widthFactor, factor = particle.spiralInnerRadius + particle.spiralLineSpacing * angle, pos = {
+                x: factor * Math.cos(angle),
+                y: factor * Math.sin(angle),
+            };
+            context.lineTo(pos.x, pos.y);
         }
     }
     particleInit(container, particle) {
-        var _a, _b;
-        const pixelRatio = container.retina.pixelRatio, shapeData = particle.shapeData, spiral = particle;
-        spiral.spiralInnerRadius = ((_a = shapeData.innerRadius) !== null && _a !== void 0 ? _a : 1) * pixelRatio;
-        spiral.spiralLineSpacing = ((_b = shapeData.lineSpacing) !== null && _b !== void 0 ? _b : 1) * pixelRatio;
+        const pixelRatio = container.retina.pixelRatio, shapeData = particle.shapeData;
+        particle.spiralInnerRadius = getRangeValue(shapeData.innerRadius ?? 1) * pixelRatio;
+        particle.spiralLineSpacing = getRangeValue(shapeData.lineSpacing ?? 1) * pixelRatio;
+        particle.spiralWidthFactor = getRangeValue(shapeData.widthFactor ?? 10);
     }
 }

package/browser/index.js

@@ -1,4 +1,4 @@
 import { SpiralDrawer } from "./SpiralDrawer";
-export function loadSpiralShape(engine) {
-    engine.addShape("spiral", new SpiralDrawer());
+export async function loadSpiralShape(engine, refresh = true) {
+    await engine.addShape("spiral", new SpiralDrawer(), refresh);
 }

package/cjs/SpiralDrawer.js

@@ -1,19 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SpiralDrawer = void 0;
+const engine_1 = require("@tsparticles/engine");
 class SpiralDrawer {
     draw(context, particle, radius) {
-        const spiral = particle, realWidth = (radius - spiral.spiralInnerRadius) / spiral.spiralLineSpacing;
-        for (let i = 0; i < realWidth * 10; i++) {
-            const angle = 0.1 * i, positionFactor = spiral.spiralInnerRadius + spiral.spiralLineSpacing * angle, x = positionFactor * Math.cos(angle), y = positionFactor * Math.sin(angle);
-            context.lineTo(x, y);
+        if (particle.spiralInnerRadius === undefined ||
+            particle.spiralLineSpacing === undefined ||
+            particle.spiralWidthFactor === undefined) {
+            return;
+        }
+        const realWidth = (radius - particle.spiralInnerRadius) / particle.spiralLineSpacing, widthFactor = 10;
+        for (let i = 0; i < realWidth * widthFactor; i++) {
+            const angle = i / widthFactor, factor = particle.spiralInnerRadius + particle.spiralLineSpacing * angle, pos = {
+                x: factor * Math.cos(angle),
+                y: factor * Math.sin(angle),
+            };
+            context.lineTo(pos.x, pos.y);
         }
     }
     particleInit(container, particle) {
-        var _a, _b;
-        const pixelRatio = container.retina.pixelRatio, shapeData = particle.shapeData, spiral = particle;
-        spiral.spiralInnerRadius = ((_a = shapeData.innerRadius) !== null && _a !== void 0 ? _a : 1) * pixelRatio;
-        spiral.spiralLineSpacing = ((_b = shapeData.lineSpacing) !== null && _b !== void 0 ? _b : 1) * pixelRatio;
+        const pixelRatio = container.retina.pixelRatio, shapeData = particle.shapeData;
+        particle.spiralInnerRadius = (0, engine_1.getRangeValue)(shapeData.innerRadius ?? 1) * pixelRatio;
+        particle.spiralLineSpacing = (0, engine_1.getRangeValue)(shapeData.lineSpacing ?? 1) * pixelRatio;
+        particle.spiralWidthFactor = (0, engine_1.getRangeValue)(shapeData.widthFactor ?? 10);
     }
 }
 exports.SpiralDrawer = SpiralDrawer;

package/cjs/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadSpiralShape = void 0;
 const SpiralDrawer_1 = require("./SpiralDrawer");
-function loadSpiralShape(engine) {
-    engine.addShape("spiral", new SpiralDrawer_1.SpiralDrawer());
+async function loadSpiralShape(engine, refresh = true) {
+    await engine.addShape("spiral", new SpiralDrawer_1.SpiralDrawer(), refresh);
 }
 exports.loadSpiralShape = loadSpiralShape;

package/esm/SpiralDrawer.js

@@ -1,15 +1,24 @@
+import { getRangeValue } from "@tsparticles/engine";
 export class SpiralDrawer {
     draw(context, particle, radius) {
-        const spiral = particle, realWidth = (radius - spiral.spiralInnerRadius) / spiral.spiralLineSpacing;
-        for (let i = 0; i < realWidth * 10; i++) {
-            const angle = 0.1 * i, positionFactor = spiral.spiralInnerRadius + spiral.spiralLineSpacing * angle, x = positionFactor * Math.cos(angle), y = positionFactor * Math.sin(angle);
-            context.lineTo(x, y);
+        if (particle.spiralInnerRadius === undefined ||
+            particle.spiralLineSpacing === undefined ||
+            particle.spiralWidthFactor === undefined) {
+            return;
+        }
+        const realWidth = (radius - particle.spiralInnerRadius) / particle.spiralLineSpacing, widthFactor = 10;
+        for (let i = 0; i < realWidth * widthFactor; i++) {
+            const angle = i / widthFactor, factor = particle.spiralInnerRadius + particle.spiralLineSpacing * angle, pos = {
+                x: factor * Math.cos(angle),
+                y: factor * Math.sin(angle),
+            };
+            context.lineTo(pos.x, pos.y);
         }
     }
     particleInit(container, particle) {
-        var _a, _b;
-        const pixelRatio = container.retina.pixelRatio, shapeData = particle.shapeData, spiral = particle;
-        spiral.spiralInnerRadius = ((_a = shapeData.innerRadius) !== null && _a !== void 0 ? _a : 1) * pixelRatio;
-        spiral.spiralLineSpacing = ((_b = shapeData.lineSpacing) !== null && _b !== void 0 ? _b : 1) * pixelRatio;
+        const pixelRatio = container.retina.pixelRatio, shapeData = particle.shapeData;
+        particle.spiralInnerRadius = getRangeValue(shapeData.innerRadius ?? 1) * pixelRatio;
+        particle.spiralLineSpacing = getRangeValue(shapeData.lineSpacing ?? 1) * pixelRatio;
+        particle.spiralWidthFactor = getRangeValue(shapeData.widthFactor ?? 10);
     }
 }

package/esm/index.js

@@ -1,4 +1,4 @@
 import { SpiralDrawer } from "./SpiralDrawer";
-export function loadSpiralShape(engine) {
-    engine.addShape("spiral", new SpiralDrawer());
+export async function loadSpiralShape(engine, refresh = true) {
+    await engine.addShape("spiral", new SpiralDrawer(), refresh);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/shape-spiral",
-  "version": "3.0.0-alpha.0",
+  "version": "3.0.0-beta.0",
   "description": "tsParticles spiral shape",
   "homepage": "https://particles.js.org",
   "repository": {
@@ -72,6 +72,10 @@
       "type": "github",
       "url": "https://github.com/sponsors/matteobruni"
     },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/tsparticles"
+    },
     {
       "type": "buymeacoffee",
       "url": "https://www.buymeacoffee.com/matteobruni"
@@ -82,10 +86,11 @@
   "unpkg": "tsparticles.shape.spiral.min.js",
   "module": "esm/index.js",
   "types": "types/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-beta.0"
+  },
   "publishConfig": {
     "access": "public"
-  },
-  "dependencies": {
-    "@tsparticles/engine": "^3.0.0-alpha.0"
   }
-}
+}