@tsparticles/path-zig-zag 4.0.0-beta.0 → 4.0.0-beta.10

package/251.min.js

@@ -0,0 +1 @@
+"use strict";(this.webpackChunk_tsparticles_path_zig_zag=this.webpackChunk_tsparticles_path_zig_zag||[]).push([[251],{251(t,e,i){i.d(e,{ZigZagPathGenerator:()=>h});var a=i(303);let n=Math.PI*a.half,s={waveHeight:{min:0,max:3},waveLength:{min:0,max:5}};class h{options;_container;_res;constructor(t){this._container=t,this._res=a.Vector.origin,this.options=(0,a.deepExtend)({},s)}generate(t,e){let{options:i}=this;t.zigzag??={counter:(0,a.getRandom)(),waveHeight:(0,a.getRangeValue)(i.waveHeight),waveLength:(0,a.getRangeValue)(i.waveLength)};let s=.5/t.zigzag.waveLength*e.factor;t.zigzag.counter+=s;let h=t.zigzag.waveHeight*Math.sin(t.zigzag.counter);return t.position.x+=h*Math.cos(t.velocity.angle+n),t.position.y+=h*Math.sin(t.velocity.angle+n),this._res.x=0,this._res.y=0,this._res}init(){let t=this._container.actualOptions.particles.move.path.options;this.options.waveLength=t.waveLength??this.options.waveLength,this.options.waveHeight=t.waveHeight??this.options.waveHeight}reset(){}update(){}}}}]);

package/README.md

@@ -8,6 +8,12 @@
 
 [tsParticles](https://github.com/tsparticles/tsparticles) path plugin for on zigzag path movement.
 
+## Quick checklist
+
+1. Install `@tsparticles/engine` (or use the CDN bundle below)
+2. Call the package loader function(s) before `tsParticles.load(...)`
+3. Apply the package options in your `tsParticles.load(...)` config
+
 ## How to use it
 
 ### CDN / Vanilla JS / jQuery
@@ -72,3 +78,34 @@ import { loadZigZagPath } from "@tsparticles/path-zigzag";
   await loadZigZagPath(tsParticles);
 })();
 ```
+
+## Option mapping
+
+- Primary options key: `particles.move.path`
+- Path generator name: `"zigzag"`
+
+```json
+{
+  "particles": {
+    "move": {
+      "enable": true,
+      "path": {
+        "enable": true,
+        "generator": "zigzag",
+        "options": {}
+      }
+    }
+  }
+}
+```
+
+## Common pitfalls
+
+- Calling `tsParticles.load(...)` before `loadZigZagPath(...)`
+- Verify required peer packages before enabling advanced options
+- Change one option group at a time to isolate regressions quickly
+
+## Related docs
+
+- All packages catalog: <https://github.com/tsparticles/tsparticles>
+- Main docs: <https://particles.js.org/docs/>

package/browser/index.js

@@ -1,10 +1,10 @@
 export const zigZagPathName = "zigZagPathGenerator";
 export async function loadZigZagPath(engine) {
-    engine.checkVersion("4.0.0-beta.0");
-    await engine.register(async (e) => {
+    engine.checkVersion("4.0.0-beta.10");
+    await engine.pluginManager.register(async (e) => {
         const { ensureBaseMoverLoaded } = await import("@tsparticles/plugin-move");
         ensureBaseMoverLoaded(e);
-        e.addPathGenerator?.(zigZagPathName, async (container) => {
+        e.pluginManager.addPathGenerator?.(zigZagPathName, async (container) => {
             const { ZigZagPathGenerator } = await import("./ZigZagPathGenerator.js");
             return new ZigZagPathGenerator(container);
         });

package/cjs/index.js

@@ -1,10 +1,10 @@
 export const zigZagPathName = "zigZagPathGenerator";
 export async function loadZigZagPath(engine) {
-    engine.checkVersion("4.0.0-beta.0");
-    await engine.register(async (e) => {
+    engine.checkVersion("4.0.0-beta.10");
+    await engine.pluginManager.register(async (e) => {
         const { ensureBaseMoverLoaded } = await import("@tsparticles/plugin-move");
         ensureBaseMoverLoaded(e);
-        e.addPathGenerator?.(zigZagPathName, async (container) => {
+        e.pluginManager.addPathGenerator?.(zigZagPathName, async (container) => {
             const { ZigZagPathGenerator } = await import("./ZigZagPathGenerator.js");
             return new ZigZagPathGenerator(container);
         });

package/dist_browser_ZigZagPathGenerator_js.js

@@ -4,7 +4,7 @@
  * Demo / Generator : https://particles.js.org/
  * GitHub : https://www.github.com/matteobruni/tsparticles
  * How to use? : Check the GitHub README
- * v4.0.0-beta.0
+ * v4.0.0-beta.10
  */
 "use strict";
 /*

package/esm/index.js

@@ -1,10 +1,10 @@
 export const zigZagPathName = "zigZagPathGenerator";
 export async function loadZigZagPath(engine) {
-    engine.checkVersion("4.0.0-beta.0");
-    await engine.register(async (e) => {
+    engine.checkVersion("4.0.0-beta.10");
+    await engine.pluginManager.register(async (e) => {
         const { ensureBaseMoverLoaded } = await import("@tsparticles/plugin-move");
         ensureBaseMoverLoaded(e);
-        e.addPathGenerator?.(zigZagPathName, async (container) => {
+        e.pluginManager.addPathGenerator?.(zigZagPathName, async (container) => {
             const { ZigZagPathGenerator } = await import("./ZigZagPathGenerator.js");
             return new ZigZagPathGenerator(container);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/path-zig-zag",
-  "version": "4.0.0-beta.0",
+  "version": "4.0.0-beta.10",
   "description": "tsParticles zig zag path",
   "homepage": "https://particles.js.org",
   "repository": {
@@ -95,14 +95,13 @@
       "browser": "./browser/index.js",
       "import": "./esm/index.js",
       "require": "./cjs/index.js",
-      "umd": "./umd/index.js",
-      "default": "./cjs/index.js"
+      "default": "./esm/index.js"
     },
     "./package.json": "./package.json"
   },
-  "dependencies": {
-    "@tsparticles/engine": "4.0.0-beta.0",
-    "@tsparticles/plugin-move": "4.0.0-beta.0"
+  "peerDependencies": {
+    "@tsparticles/engine": "4.0.0-beta.10",
+    "@tsparticles/plugin-move": "4.0.0-beta.10"
   },
   "publishConfig": {
     "access": "public"