@tsparticles/palette-aurora-borealis 4.0.0-beta.0 → 4.0.0-beta.15

package/README.md

@@ -1,10 +1,10 @@
 [![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)
 
-# tsParticles Aurora Borealis Palette
+# tsParticles AuroraBorealis Palette
 
-[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/palette-aurora-borealis/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/palette-aurora-borealis) [![npmjs](https://badge.fury.io/js/@tsparticles/palette-aurora-borealis.svg)](https://www.npmjs.com/package/@tsparticles/palette-aurora-borealis) [![npmjs](https://img.shields.io/npm/dt/@tsparticles/palette-aurora-borealis)](https://www.npmjs.com/package/@tsparticles/palette-aurora-borealis) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/palette-auroraBorealis/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/palette-auroraBorealis) [![npmjs](https://badge.fury.io/js/%40tsparticles%2Fpalette-auroraBorealis.svg)](https://www.npmjs.com/package/@tsparticles/palette-auroraBorealis) [![npmjs](https://img.shields.io/npm/dt/%40tsparticles%2Fpalette-coloredSmokeAmber)](https://www.npmjs.com/package/@tsparticles/palette-auroraBorealis) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
 
-[tsParticles](https://github.com/tsparticles/tsparticles) palette for aurora borealis.
+[tsParticles](https://github.com/tsparticles/tsparticles) palette for colored smoke amber.
 
 [![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,7 +12,7 @@
 
 ## Sample
 
-[![demo](https://raw.githubusercontent.com/tsparticles/palettes/main/palettes/auroraBorealis/images/sample.png)](https://particles.js.org/samples/palettes/aurora-borealis)
+[![demo](https://raw.githubusercontent.com/tsparticles/palettes/main/palettes/space/auroraBorealis/images/sample.png)](https://particles.js.org/samples/palettes/auroraBorealis)
 
 ## Colors
 
@@ -72,15 +72,18 @@
 ## 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
+2. Load a base package (for example `@tsparticles/basic`) and call `loadAuroraBorealisPalette` before `tsParticles.load(...)`
+3. Apply the palette plus a minimal particles configuration in your options
+
+A palette defines colors, not complete behavior, so pair it with a runtime package and particle options.
 
 ## How to use it
 
 ### CDN / Vanilla JS / jQuery
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/palette-aurora-borealis@3/tsparticles.palette.aurora-borealis.bundle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@tsparticles/basic@4/tsparticles.basic.bundle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@tsparticles/palette-auroraBorealis@4/tsparticles.palette-coloredSmokeAmber.min.js"></script>
 ```
 
 ### Usage
@@ -88,16 +91,28 @@
 Once the scripts are loaded you can set up `tsParticles` like this:
 
 ```javascript
-(async () => {
-  await loadAuroraBorealisPalette(tsParticles);
+(async engine => {
+  await loadBasic(engine);
+  await loadAuroraBorealisPalette(engine);
 
-  await tsParticles.load({
-    id: "tsparticles",
-    options: {
-      palette: "aurora-borealis",
+  const options = {
+    particles: {
+      number: { value: 200 },
+      shape: { type: "circle" },
+      size: { value: { min: 10, max: 15 } },
+      move: {
+        enable: true,
+        speed: 2,
+      },
     },
+    palette: "auroraBorealis",
+  };
+
+  await engine.load({
+    id: "tsparticles",
+    options,
   });
-})();
+})(tsParticles);
 ```
 
 #### Customization
@@ -105,47 +120,11 @@ Once the scripts are loaded you can set up `tsParticles` like this:
 **Important ⚠️**
 You can override all the options defining the properties like in any standard `tsParticles` installation.
 
-```javascript
-tsParticles.load({
-  id: "tsparticles",
-  options: {
-    particles: {
-      shape: {
-        type: "square", // starting from v2, this require the square shape script
-      },
-    },
-    palette: "aurora-borealis",
-  },
-});
-```
-
-Like in the sample above, the circles will be replaced by squares.
-
 ### Frameworks with a tsParticles component library
 
-Checkout the documentation in the component library repository and call the `loadAuroraBorealisPalette` function instead of `loadFull`, `loadSlim` or similar functions.
-
-The options shown above are valid for all the component libraries.
-
-## Common pitfalls
-
-- Calling `tsParticles.load(...)` before `loadAuroraBorealisPalette(...)`
-- Verify required peer packages before enabling advanced options
-- Change one option group at a time to isolate regressions quickly
+Checkout the documentation in the component library repository and call the `loadAuroraBorealisPalette` function.
 
 ## Related docs
 
 - Presets and palettes catalog: <https://github.com/tsparticles/palettes>
 - Main docs: <https://particles.js.org/docs/>
-
----
-
-```mermaid
-flowchart TD
-
-subgraph pr [Palettes]
-paauroraBorealis[Aurora Borealis]
-end
-
-e[tsParticles Engine] --> paauroraBorealis
-```

package/browser/browser.js

@@ -0,0 +1,5 @@
+import { loadAuroraBorealisPalette } from "./index.js";
+const globalObject = globalThis;
+globalObject.__tsParticlesInternals = globalObject.__tsParticlesInternals ?? {};
+globalObject.loadAuroraBorealisPalette = loadAuroraBorealisPalette;
+export * from "./index.js";

package/browser/index.js

@@ -1,7 +1,7 @@
+import { options } from "./options.js";
 const paletteName = "aurora-borealis";
 export async function loadAuroraBorealisPalette(engine) {
-    await engine.pluginManager.register(async (e) => {
-        const { options } = await import("./options.js");
+    await engine.pluginManager.register(e => {
         e.pluginManager.addPalette(paletteName, options);
     });
 }

package/browser/index.lazy.js

@@ -0,0 +1,7 @@
+const paletteName = "aurora-borealis";
+export async function loadAuroraBorealisPalette(engine) {
+    await engine.pluginManager.register(async (e) => {
+        const { options } = await import("./options.js");
+        e.pluginManager.addPalette(paletteName, options);
+    });
+}

package/cjs/browser.js

@@ -0,0 +1,5 @@
+import { loadAuroraBorealisPalette } from "./index.js";
+const globalObject = globalThis;
+globalObject.__tsParticlesInternals = globalObject.__tsParticlesInternals ?? {};
+globalObject.loadAuroraBorealisPalette = loadAuroraBorealisPalette;
+export * from "./index.js";

package/cjs/index.js

@@ -1,7 +1,7 @@
+import { options } from "./options.js";
 const paletteName = "aurora-borealis";
 export async function loadAuroraBorealisPalette(engine) {
-    await engine.pluginManager.register(async (e) => {
-        const { options } = await import("./options.js");
+    await engine.pluginManager.register(e => {
         e.pluginManager.addPalette(paletteName, options);
     });
 }

package/cjs/index.lazy.js

@@ -0,0 +1,7 @@
+const paletteName = "aurora-borealis";
+export async function loadAuroraBorealisPalette(engine) {
+    await engine.pluginManager.register(async (e) => {
+        const { options } = await import("./options.js");
+        e.pluginManager.addPalette(paletteName, options);
+    });
+}

package/esm/browser.js

@@ -0,0 +1,5 @@
+import { loadAuroraBorealisPalette } from "./index.js";
+const globalObject = globalThis;
+globalObject.__tsParticlesInternals = globalObject.__tsParticlesInternals ?? {};
+globalObject.loadAuroraBorealisPalette = loadAuroraBorealisPalette;
+export * from "./index.js";

package/esm/index.js

@@ -1,7 +1,7 @@
+import { options } from "./options.js";
 const paletteName = "aurora-borealis";
 export async function loadAuroraBorealisPalette(engine) {
-    await engine.pluginManager.register(async (e) => {
-        const { options } = await import("./options.js");
+    await engine.pluginManager.register(e => {
         e.pluginManager.addPalette(paletteName, options);
     });
 }

package/esm/index.lazy.js

@@ -0,0 +1,7 @@
+const paletteName = "aurora-borealis";
+export async function loadAuroraBorealisPalette(engine) {
+    await engine.pluginManager.register(async (e) => {
+        const { options } = await import("./options.js");
+        e.pluginManager.addPalette(paletteName, options);
+    });
+}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@tsparticles/palette-aurora-borealis",
-  "version": "4.0.0-beta.0",
+  "version": "4.0.0-beta.15",
   "description": "tsParticles aurora borealis palette",
   "homepage": "https://particles.js.org",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tsparticles/palettes.git",
+    "url": "git+https://github.com/tsparticles/tsparticles.git",
     "directory": "palettes/space/auroraBorealis"
   },
   "keywords": [
@@ -81,8 +81,7 @@
       "url": "https://www.buymeacoffee.com/matteobruni"
     }
   ],
-  "jsdelivr": "tsparticles.palette.aurora-borealis.min.js",
-  "unpkg": "tsparticles.palette.aurora-borealis.min.js",
+  "sideEffects": false,
   "browser": "browser/index.js",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -96,13 +95,23 @@
       "umd": "./umd/index.js",
       "default": "./cjs/index.js"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./lazy": {
+      "types": "./types/index.lazy.d.ts",
+      "browser": "./browser/index.lazy.js",
+      "import": "./esm/index.lazy.js",
+      "require": "./cjs/index.lazy.js",
+      "umd": "./umd/index.lazy.js",
+      "default": "./cjs/index.lazy.js"
+    }
   },
   "dependencies": {
-    "@tsparticles/engine": "^4.0.0-beta.11"
+    "@tsparticles/engine": "4.0.0-beta.15"
   },
+  "type": "module",
+  "jsdelivr": "tsparticles.palette-colored-smoke-amber.min.js",
+  "unpkg": "tsparticles.palette-colored-smoke-amber.min.js",
   "publishConfig": {
     "access": "public"
-  },
-  "type": "module"
+  }
 }