@tsparticles/preset-hyperspace 3.0.0 → 3.0.2

package/README.md

@@ -4,7 +4,8 @@
 
 [![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/preset-hyperspace/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/preset-hyperspace) [![npmjs](https://badge.fury.io/js/@tsparticles/preset-hyperspace.svg)](https://www.npmjs.com/package/@tsparticles/preset-hyperspace) [![npmjs](https://img.shields.io/npm/dt/@tsparticles/preset-hyperspace)](https://www.npmjs.com/package/@tsparticles/preset-hyperspace) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
 
-[tsParticles](https://github.com/matteobruni/tsparticles) preset for creating a starry night effect with blinking hyperspace.
+[tsParticles](https://github.com/tsparticles/tsparticles) preset for creating a starry night effect with blinking
+hyperspace.
 
 [![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,38 +13,14 @@
 
 ## Sample
 
-[![demo](https://raw.githubusercontent.com/matteobruni/tsparticles/main/presets/hyperspace/images/sample.png)](https://particles.js.org/samples/presets/hyperspace)
+[![demo](https://raw.githubusercontent.com/tsparticles/tsparticles/main/presets/hyperspace/images/sample.png)](https://particles.js.org/samples/presets/hyperspace)
 
 ## 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-hyperspace):
-
-```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/shape-circle@2/tsparticles.shape.circle.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-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-size@2/tsparticles.updater.size.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-hyperspace@2/tsparticles.preset.hyperspace.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-hyperspace@2/tsparticles.preset.hyperspace.bundle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-hyperspace@3/tsparticles.preset.hyperspace.bundle.min.js"></script>
 ```
 
 ### Usage
@@ -51,13 +28,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 loadHyperspacePreset(tsParticles); // this is required only if you are not using the bundle script
-
-  await tsParticles.load("tsparticles", {
+tsParticles.load({
+  id: "tsparticles",
+  options: {
     preset: "hyperspace",
-  });
-})();
+  },
+});
 ```
 
 #### Customization
@@ -66,100 +42,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: "hyperspace",
   },
-  preset: "hyperspace",
 });
 ```
 
 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 { loadHyperspacePreset } from "@tsparticles/preset-hyperspace";
-
-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 loadHyperspacePreset(engine);
-  }
-
-  render() {
-    const options = {
-      preset: "hyperspace",
-    };
-
-    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: "hyperspace",
-};
+### Frameworks with a tsParticles component library
 
-async function particlesInit(engine: Engine): Promise<void> {
-  await loadHyperspacePreset(engine);
-}
-```
-
-### Angular
-
-```html
-<ng-particles [id]="id" [options]="particlesOptions" [particlesInit]="particlesInit"></ng-particles>
-```
+Checkout the documentation in the component library repository and call the `loadHyperspacePreset` function instead of `loadFull`, `loadSlim` or similar functions.
 
-```typescript
-const particlesOptions = {
-  preset: "hyperspace",
-};
-
-async function particlesInit(engine: Engine): Promise<void> {
-  await loadHyperspacePreset(engine);
-}
-```
-
-### Svelte
-
-```sveltehtml
-
-<Particles
-        id="tsparticles"
-        options={particlesOptions}
-        particlesInit={particlesInit}
-/>
-```
-
-```js
-let particlesOptions = {
-  preset: "bubbles",
-};
-
-let particlesInit = async (engine) => {
-  await loadHyperspacePreset(engine);
-};
-```
+The options shown above are valid for all the component libraries.
 
 ---
 

package/browser/bundle.js

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

package/browser/index.js

@@ -2,7 +2,7 @@ import { loadBasic } from "@tsparticles/basic";
 import { loadEmittersPlugin } from "@tsparticles/plugin-emitters";
 import { loadEmittersShapeSquare } from "@tsparticles/plugin-emitters-shape-square";
 import { loadLifeUpdater } from "@tsparticles/updater-life";
-import { options } from "./options";
+import { options } from "./options.js";
 export async function loadHyperspacePreset(engine, refresh = true) {
     await loadBasic(engine, false);
     await loadEmittersShapeSquare(engine, false);

package/cjs/bundle.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tsParticles = exports.loadHyperspacePreset = void 0;
-const _1 = require(".");
-Object.defineProperty(exports, "loadHyperspacePreset", { enumerable: true, get: function () { return _1.loadHyperspacePreset; } });
+const index_js_1 = require("./index.js");
+Object.defineProperty(exports, "loadHyperspacePreset", { enumerable: true, get: function () { return index_js_1.loadHyperspacePreset; } });
 const engine_1 = require("@tsparticles/engine");
 Object.defineProperty(exports, "tsParticles", { enumerable: true, get: function () { return engine_1.tsParticles; } });
-(0, _1.loadHyperspacePreset)(engine_1.tsParticles);
+void (0, index_js_1.loadHyperspacePreset)(engine_1.tsParticles);

package/cjs/index.js

@@ -5,12 +5,12 @@ const basic_1 = require("@tsparticles/basic");
 const plugin_emitters_1 = require("@tsparticles/plugin-emitters");
 const plugin_emitters_shape_square_1 = require("@tsparticles/plugin-emitters-shape-square");
 const updater_life_1 = require("@tsparticles/updater-life");
-const options_1 = require("./options");
+const options_js_1 = require("./options.js");
 async function loadHyperspacePreset(engine, refresh = true) {
     await (0, basic_1.loadBasic)(engine, false);
     await (0, plugin_emitters_shape_square_1.loadEmittersShapeSquare)(engine, false);
     await (0, plugin_emitters_1.loadEmittersPlugin)(engine, false);
     await (0, updater_life_1.loadLifeUpdater)(engine, false);
-    await engine.addPreset("hyperspace", options_1.options, refresh);
+    await engine.addPreset("hyperspace", options_js_1.options, refresh);
 }
 exports.loadHyperspacePreset = loadHyperspacePreset;

package/esm/bundle.js

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

package/esm/index.js

@@ -2,7 +2,7 @@ import { loadBasic } from "@tsparticles/basic";
 import { loadEmittersPlugin } from "@tsparticles/plugin-emitters";
 import { loadEmittersShapeSquare } from "@tsparticles/plugin-emitters-shape-square";
 import { loadLifeUpdater } from "@tsparticles/updater-life";
-import { options } from "./options";
+import { options } from "./options.js";
 export async function loadHyperspacePreset(engine, refresh = true) {
     await loadBasic(engine, false);
     await loadEmittersShapeSquare(engine, false);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/preset-hyperspace",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "tsParticles hyperspace preset",
   "homepage": "https://particles.js.org",
   "repository": {
@@ -87,11 +87,11 @@
   "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/updater-life": "^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/updater-life": "^3.0.3"
   },
   "publishConfig": {
     "access": "public"