@tsparticles/shape-star 4.0.0-beta.0 → 4.0.0-beta.10

package/241.min.js

@@ -0,0 +1 @@
+"use strict";(this.webpackChunk_tsparticles_shape_star=this.webpackChunk_tsparticles_shape_star||[]).push([[241],{241(t,e,a){a.d(e,{StarDrawer:()=>r});var s=a(303);class r{draw(t){!function(t){let{context:e,particle:a,radius:s}=t,r=a.sides,n=a.starInset??2;e.moveTo(0,0-s);for(let t=0;t<r;t++)e.rotate(Math.PI/r),e.lineTo(0,0-s*n),e.rotate(Math.PI/r),e.lineTo(0,0-s)}(t)}getSidesCount(t){let e=t.shapeData;return Math.round((0,s.getRangeValue)(e?.sides??5))}particleInit(t,e){let a=e.shapeData;e.starInset=(0,s.getRangeValue)(a?.inset??2)}}}}]);

package/README.md

@@ -8,6 +8,12 @@
 
 [tsParticles](https://github.com/tsparticles/tsparticles) additional star shape.
 
+## 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
@@ -73,3 +79,32 @@ import { loadStarShape } from "@tsparticles/shape-star";
   await loadStarShape(tsParticles);
 })();
 ```
+
+## Option mapping
+
+- Primary options key: `particles.shape.type: "star"`
+- Shape-specific options key: `particles.shape.options.star`
+
+```json
+{
+  "particles": {
+    "shape": {
+      "type": "star",
+      "options": {
+        "star": {}
+      }
+    }
+  }
+}
+```
+
+## Common pitfalls
+
+- Calling `tsParticles.load(...)` before `loadStarShape(...)`
+- 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,7 +1,7 @@
 export async function loadStarShape(engine) {
-    engine.checkVersion("4.0.0-beta.0");
-    await engine.register(e => {
-        e.addShape(["star"], async () => {
+    engine.checkVersion("4.0.0-beta.10");
+    await engine.pluginManager.register(e => {
+        e.pluginManager.addShape(["star"], async () => {
             const { StarDrawer } = await import("./StarDrawer.js");
             return new StarDrawer();
         });

package/cjs/index.js

@@ -1,7 +1,7 @@
 export async function loadStarShape(engine) {
-    engine.checkVersion("4.0.0-beta.0");
-    await engine.register(e => {
-        e.addShape(["star"], async () => {
+    engine.checkVersion("4.0.0-beta.10");
+    await engine.pluginManager.register(e => {
+        e.pluginManager.addShape(["star"], async () => {
             const { StarDrawer } = await import("./StarDrawer.js");
             return new StarDrawer();
         });

package/dist_browser_StarDrawer_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,7 +1,7 @@
 export async function loadStarShape(engine) {
-    engine.checkVersion("4.0.0-beta.0");
-    await engine.register(e => {
-        e.addShape(["star"], async () => {
+    engine.checkVersion("4.0.0-beta.10");
+    await engine.pluginManager.register(e => {
+        e.pluginManager.addShape(["star"], async () => {
             const { StarDrawer } = await import("./StarDrawer.js");
             return new StarDrawer();
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/shape-star",
-  "version": "4.0.0-beta.0",
+  "version": "4.0.0-beta.10",
   "description": "tsParticles star shape",
   "homepage": "https://particles.js.org",
   "repository": {
@@ -53,13 +53,12 @@
       "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"
+  "peerDependencies": {
+    "@tsparticles/engine": "4.0.0-beta.10"
   },
   "publishConfig": {
     "access": "public"