tsparticles 1.35.2 → 1.37.0

package/browser/Options/Classes/Options.d.ts

@@ -10,13 +10,39 @@ import { FullScreen } from "./FullScreen/FullScreen";
 import { Motion } from "./Motion/Motion";
 import { ManualParticle } from "./ManualParticle";
 import { Responsive } from "./Responsive";
+/**
+ * [[include:Options.md]]
+ * @category Options
+ */
 export declare class Options implements IOptions, IOptionLoader<IOptions> {
     #private;
+    /**
+     * @deprecated this property is obsolete, please use the new fpsLimit
+     */
     get fps_limit(): number;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new fpsLimit
+     * @param value
+     */
     set fps_limit(value: number);
+    /**
+     * @deprecated this property is obsolete, please use the new retinaDetect
+     */
     get retina_detect(): boolean;
+    /**
+     * @deprecated this property is obsolete, please use the new retinaDetect
+     * @param value
+     */
     set retina_detect(value: boolean);
+    /**
+     * @deprecated this property is obsolete, please use the new fullScreen
+     */
     get backgroundMode(): FullScreen;
+    /**
+     * @deprecated this property is obsolete, please use the new fullScreen
+     * @param value
+     */
     set backgroundMode(value: FullScreen);
     autoPlay: boolean;
     background: Background;
@@ -39,8 +65,12 @@ export declare class Options implements IOptions, IOptionLoader<IOptions> {
     defaultLightTheme?: string;
     [name: string]: unknown;
     constructor();
+    /**
+     * This methods loads the source object in the current instance
+     * @param data the source data to load into the instance
+     */
     load(data?: RecursivePartial<IOptions>): void;
     setTheme(name?: string): void;
-    setResponsive(width: number, pxRatio: number, defaultOptions: IOptions): void;
+    setResponsive(width: number, pxRatio: number, defaultOptions: IOptions): number | undefined;
     private importPreset;
 }

package/browser/Options/Classes/Options.js

@@ -10,11 +10,15 @@ import { BackgroundMask } from "./BackgroundMask/BackgroundMask";
 import { Background } from "./Background/Background";
 import { Plugins } from "../../Utils";
 import { Theme } from "./Theme/Theme";
-import { ThemeMode } from "../../Enums";
+import { ResponsiveMode, ThemeMode } from "../../Enums";
 import { FullScreen } from "./FullScreen/FullScreen";
 import { Motion } from "./Motion/Motion";
 import { ManualParticle } from "./ManualParticle";
 import { Responsive } from "./Responsive";
+/**
+ * [[include:Options.md]]
+ * @category Options
+ */
 export class Options {
     constructor() {
         _Options_instances.add(this);
@@ -35,24 +39,50 @@ export class Options {
         this.themes = [];
         this.zLayers = 100;
     }
+    /**
+     * @deprecated this property is obsolete, please use the new fpsLimit
+     */
     get fps_limit() {
         return this.fpsLimit;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new fpsLimit
+     * @param value
+     */
     set fps_limit(value) {
         this.fpsLimit = value;
     }
+    /**
+     * @deprecated this property is obsolete, please use the new retinaDetect
+     */
     get retina_detect() {
         return this.detectRetina;
     }
+    /**
+     * @deprecated this property is obsolete, please use the new retinaDetect
+     * @param value
+     */
     set retina_detect(value) {
         this.detectRetina = value;
     }
+    /**
+     * @deprecated this property is obsolete, please use the new fullScreen
+     */
     get backgroundMode() {
         return this.fullScreen;
     }
+    /**
+     * @deprecated this property is obsolete, please use the new fullScreen
+     * @param value
+     */
     set backgroundMode(value) {
         this.fullScreen.load(value);
     }
+    /**
+     * This methods loads the source object in the current instance
+     * @param data the source data to load into the instance
+     */
     load(data) {
         var _a, _b, _c, _d, _e;
         if (data === undefined) {
@@ -144,9 +174,12 @@ export class Options {
         }
     }
     setResponsive(width, pxRatio, defaultOptions) {
-        var _a;
         this.load(defaultOptions);
-        this.load((_a = this.responsive.find((t) => t.maxWidth * pxRatio > width)) === null || _a === void 0 ? void 0 : _a.options);
+        const responsiveOptions = this.responsive.find((t) => t.mode === ResponsiveMode.screen && screen
+            ? t.maxWidth * pxRatio > screen.availWidth
+            : t.maxWidth * pxRatio > width);
+        this.load(responsiveOptions === null || responsiveOptions === void 0 ? void 0 : responsiveOptions.options);
+        return responsiveOptions === null || responsiveOptions === void 0 ? void 0 : responsiveOptions.maxWidth;
     }
     importPreset(preset) {
         this.load(Plugins.getPreset(preset));

package/browser/Options/Classes/OptionsColor.d.ts

@@ -2,6 +2,10 @@ import type { IOptionsColor } from "../Interfaces/IOptionsColor";
 import type { IRgb, IHsl, IHsv, IValueColor } from "../../Core/Interfaces";
 import type { RecursivePartial, SingleOrMultiple } from "../../Types";
 import type { IOptionLoader } from "../Interfaces/IOptionLoader";
+/**
+ * [[include:Color.md]]
+ * @category Options
+ */
 export declare class OptionsColor implements IOptionsColor, IOptionLoader<IOptionsColor> {
     value: SingleOrMultiple<SingleOrMultiple<string> | IValueColor | IRgb | IHsl | IHsv>;
     constructor();

package/browser/Options/Classes/OptionsColor.js

@@ -1,3 +1,7 @@
+/**
+ * [[include:Color.md]]
+ * @category Options
+ */
 export class OptionsColor {
     constructor() {
         this.value = "#fff";

package/browser/Options/Classes/Particles/Collisions/Collisions.d.ts

@@ -4,6 +4,10 @@ import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import { Bounce } from "../Bounce/Bounce";
 import { CollisionsOverlap } from "./CollisionsOverlap";
+/**
+ * @category Options
+ * [[include:Collisions.md]]
+ */
 export declare class Collisions implements ICollisions, IOptionLoader<ICollisions> {
     bounce: Bounce;
     enable: boolean;

package/browser/Options/Classes/Particles/Collisions/Collisions.js

@@ -1,6 +1,10 @@
 import { CollisionMode } from "../../../../Enums";
 import { Bounce } from "../Bounce/Bounce";
 import { CollisionsOverlap } from "./CollisionsOverlap";
+/**
+ * @category Options
+ * [[include:Collisions.md]]
+ */
 export class Collisions {
     constructor() {
         this.bounce = new Bounce();

package/browser/Options/Classes/Particles/Links/Links.d.ts

@@ -4,6 +4,10 @@ import type { RecursivePartial } from "../../../../Types";
 import { LinksTriangle } from "./LinksTriangle";
 import { OptionsColor } from "../../OptionsColor";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * [[include:Options/Particles/Links.md]]
+ * @category Options
+ */
 export declare class Links implements ILinks, IOptionLoader<ILinks> {
     blink: boolean;
     color: OptionsColor;

package/browser/Options/Classes/Particles/Links/Links.js

@@ -1,6 +1,10 @@
 import { LinksShadow } from "./LinksShadow";
 import { LinksTriangle } from "./LinksTriangle";
 import { OptionsColor } from "../../OptionsColor";
+/**
+ * [[include:Options/Particles/Links.md]]
+ * @category Options
+ */
 export class Links {
     constructor() {
         this.blink = false;

package/browser/Options/Classes/Particles/Links/LinksShadow.d.ts

@@ -2,6 +2,9 @@ import type { ILinksShadow } from "../../../Interfaces/Particles/Links/ILinksSha
 import type { RecursivePartial } from "../../../../Types";
 import { OptionsColor } from "../../OptionsColor";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class LinksShadow implements ILinksShadow, IOptionLoader<ILinksShadow> {
     blur: number;
     color: OptionsColor;

package/browser/Options/Classes/Particles/Links/LinksShadow.js

@@ -1,4 +1,7 @@
 import { OptionsColor } from "../../OptionsColor";
+/**
+ * @category Options
+ */
 export class LinksShadow {
     constructor() {
         this.blur = 5;

package/browser/Options/Classes/Particles/Links/LinksTriangle.d.ts

@@ -2,6 +2,9 @@ import type { ILinksTriangle } from "../../../Interfaces/Particles/Links/ILinksT
 import { OptionsColor } from "../../OptionsColor";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class LinksTriangle implements ILinksTriangle, IOptionLoader<ILinksTriangle> {
     color?: OptionsColor;
     enable: boolean;

package/browser/Options/Classes/Particles/Links/LinksTriangle.js

@@ -1,4 +1,7 @@
 import { OptionsColor } from "../../OptionsColor";
+/**
+ * @category Options
+ */
 export class LinksTriangle {
     constructor() {
         this.enable = false;

package/browser/Options/Classes/Particles/Move/Attract.d.ts

@@ -2,10 +2,31 @@ import type { IAttract } from "../../../Interfaces/Particles/Move/IAttract";
 import type { ICoordinates } from "../../../../Core/Interfaces/ICoordinates";
 import type { RecursivePartial } from "../../../../Types/RecursivePartial";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Attract implements IAttract, IOptionLoader<IAttract> {
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new rotate.x
+     */
     get rotateX(): number;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new rotate.x
+     * @param value
+     */
     set rotateX(value: number);
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new rotate.y
+     */
     get rotateY(): number;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new rotate.y
+     * @param value
+     */
     set rotateY(value: number);
     distance: number;
     enable: boolean;

package/browser/Options/Classes/Particles/Move/Attract.js

@@ -1,3 +1,6 @@
+/**
+ * @category Options
+ */
 export class Attract {
     constructor() {
         this.distance = 200;
@@ -7,15 +10,33 @@ export class Attract {
             y: 3000,
         };
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new rotate.x
+     */
     get rotateX() {
         return this.rotate.x;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new rotate.x
+     * @param value
+     */
     set rotateX(value) {
         this.rotate.x = value;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new rotate.y
+     */
     get rotateY() {
         return this.rotate.y;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new rotate.y
+     * @param value
+     */
     set rotateY(value) {
         this.rotate.y = value;
     }

package/browser/Options/Classes/Particles/Move/Move.d.ts

@@ -10,16 +10,58 @@ import { MoveGravity } from "./MoveGravity";
 import { OutModes } from "./OutModes";
 import type { IDistance } from "../../../../Core/Interfaces";
 import { Spin } from "./Spin";
+/**
+ * [[include:Options/Particles/Move.md]]
+ * @category Options
+ */
 export declare class Move implements IMove, IOptionLoader<IMove> {
+    /**
+     * @deprecated this property is obsolete, please use the new collisions object on particles options
+     */
     get collisions(): boolean;
+    /**
+     * @deprecated this property is obsolete, please use the new collisions object on particles options
+     * @param value
+     */
     set collisions(value: boolean);
+    /**
+     * @deprecated this property is obsolete, please use the new collisions object on particles options
+     */
     get bounce(): boolean;
+    /**
+     * @deprecated this property is obsolete, please use the new collisions object on particles options
+     * @param value
+     */
     set bounce(value: boolean);
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new outMode
+     */
     get out_mode(): OutMode | keyof typeof OutMode | OutModeAlt;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new outMode
+     * @param value
+     */
     set out_mode(value: OutMode | keyof typeof OutMode | OutModeAlt);
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new outMode
+     */
     get outMode(): OutMode | keyof typeof OutMode | OutModeAlt;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new outMode
+     * @param value
+     */
     set outMode(value: OutMode | keyof typeof OutMode | OutModeAlt);
+    /**
+     * @deprecated use the new [[path]] property instead
+     */
     get noise(): Path;
+    /**
+     * @deprecated use the new [[path]] property instead
+     */
     set noise(value: Path);
     angle: MoveAngle;
     attract: Attract;

package/browser/Options/Classes/Particles/Move/Move.js

@@ -7,6 +7,10 @@ import { MoveGravity } from "./MoveGravity";
 import { OutModes } from "./OutModes";
 import { deepExtend, setRangeValue } from "../../../../Utils";
 import { Spin } from "./Spin";
+/**
+ * [[include:Options/Particles/Move.md]]
+ * @category Options
+ */
 export class Move {
     constructor() {
         this.angle = new MoveAngle();
@@ -28,32 +32,71 @@ export class Move {
         this.vibrate = false;
         this.warp = false;
     }
+    /**
+     * @deprecated this property is obsolete, please use the new collisions object on particles options
+     */
     get collisions() {
         return false;
     }
+    /**
+     * @deprecated this property is obsolete, please use the new collisions object on particles options
+     * @param value
+     */
     set collisions(value) {
+        // deprecated
     }
+    /**
+     * @deprecated this property is obsolete, please use the new collisions object on particles options
+     */
     get bounce() {
         return this.collisions;
     }
+    /**
+     * @deprecated this property is obsolete, please use the new collisions object on particles options
+     * @param value
+     */
     set bounce(value) {
         this.collisions = value;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new outMode
+     */
     get out_mode() {
         return this.outMode;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new outMode
+     * @param value
+     */
     set out_mode(value) {
         this.outMode = value;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new outMode
+     */
     get outMode() {
         return this.outModes.default;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new outMode
+     * @param value
+     */
     set outMode(value) {
         this.outModes.default = value;
     }
+    /**
+     * @deprecated use the new [[path]] property instead
+     */
     get noise() {
         return this.path;
     }
+    /**
+     * @deprecated use the new [[path]] property instead
+     */
     set noise(value) {
         this.path = value;
     }

package/browser/Options/Classes/Particles/Move/MoveAngle.d.ts

@@ -1,6 +1,9 @@
 import type { IMoveAngle } from "../../../Interfaces/Particles/Move/IMoveAngle";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import type { RecursivePartial } from "../../../../Types";
+/**
+ * @category Options
+ */
 export declare class MoveAngle implements IMoveAngle, IOptionLoader<IMoveAngle> {
     offset: number;
     value: number;

package/browser/Options/Classes/Particles/Move/MoveAngle.js

@@ -1,6 +1,9 @@
+/**
+ * @category Options
+ */
 export class MoveAngle {
     constructor() {
-        this.offset = 0;
+        this.offset = 0; //45;
         this.value = 90;
     }
     load(data) {

package/browser/Options/Classes/Particles/Move/Path/Path.d.ts

@@ -2,6 +2,9 @@ import type { IPath } from "../../../../Interfaces/Particles/Move/Path/iPath";
 import type { RecursivePartial, PathOptions } from "../../../../../Types";
 import { PathDelay } from "./PathDelay";
 import type { IOptionLoader } from "../../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Path implements IPath, IOptionLoader<IPath> {
     clamp: boolean;
     delay: PathDelay;

package/browser/Options/Classes/Particles/Move/Path/Path.js

@@ -1,5 +1,8 @@
 import { PathDelay } from "./PathDelay";
 import { deepExtend } from "../../../../../Utils";
+/**
+ * @category Options
+ */
 export class Path {
     constructor() {
         this.clamp = true;

package/browser/Options/Classes/Particles/Move/Trail.d.ts

@@ -2,6 +2,9 @@ import type { ITrail } from "../../../Interfaces/Particles/Move/ITrail";
 import type { RecursivePartial } from "../../../../Types";
 import { OptionsColor } from "../../OptionsColor";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Trail implements ITrail, IOptionLoader<ITrail> {
     enable: boolean;
     length: number;

package/browser/Options/Classes/Particles/Move/Trail.js

@@ -1,4 +1,7 @@
 import { OptionsColor } from "../../OptionsColor";
+/**
+ * @category Options
+ */
 export class Trail {
     constructor() {
         this.enable = false;

package/browser/Options/Classes/Particles/Number/Density.d.ts

@@ -1,8 +1,20 @@
 import type { IDensity } from "../../../Interfaces/Particles/Number/IDensity";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Density implements IDensity, IOptionLoader<IDensity> {
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new area
+     */
     get value_area(): number;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new area
+     * @param value
+     */
     set value_area(value: number);
     area: number;
     enable: boolean;

package/browser/Options/Classes/Particles/Number/Density.js

@@ -1,12 +1,24 @@
+/**
+ * @category Options
+ */
 export class Density {
     constructor() {
         this.enable = false;
         this.area = 800;
         this.factor = 1000;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new area
+     */
     get value_area() {
         return this.area;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new area
+     * @param value
+     */
     set value_area(value) {
         this.area = value;
     }

package/browser/Options/Classes/Particles/Number/ParticlesNumber.d.ts

@@ -2,8 +2,18 @@ import type { IParticlesNumber } from "../../../Interfaces/Particles/Number/IPar
 import { Density } from "./Density";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * [[include:Options/Particles/Number.md]]
+ * @category Options
+ */
 export declare class ParticlesNumber implements IParticlesNumber, IOptionLoader<IParticlesNumber> {
+    /**
+     * @deprecated the max property is deprecated, please use the new limit
+     */
     get max(): number;
+    /**
+     * @deprecated the max property is deprecated, please use the new limit
+     */
     set max(value: number);
     density: Density;
     limit: number;

package/browser/Options/Classes/Particles/Number/ParticlesNumber.js

@@ -1,13 +1,23 @@
 import { Density } from "./Density";
+/**
+ * [[include:Options/Particles/Number.md]]
+ * @category Options
+ */
 export class ParticlesNumber {
     constructor() {
         this.density = new Density();
         this.limit = 0;
         this.value = 100;
     }
+    /**
+     * @deprecated the max property is deprecated, please use the new limit
+     */
     get max() {
         return this.limit;
     }
+    /**
+     * @deprecated the max property is deprecated, please use the new limit
+     */
     set max(value) {
         this.limit = value;
     }

package/browser/Options/Classes/Particles/Opacity/Opacity.d.ts

@@ -3,8 +3,21 @@ import { OpacityAnimation } from "./OpacityAnimation";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * [[include:Options/Particles/Opacity.md]]
+ * @category Options
+ */
 export declare class Opacity extends ValueWithRandom implements IOpacity, IOptionLoader<IOpacity> {
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new animation
+     */
     get anim(): OpacityAnimation;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new animation
+     * @param value
+     */
     set anim(value: OpacityAnimation);
     animation: OpacityAnimation;
     constructor();

package/browser/Options/Classes/Particles/Opacity/Opacity.js

@@ -1,6 +1,10 @@
 import { OpacityAnimation } from "./OpacityAnimation";
 import { ValueWithRandom } from "../../ValueWithRandom";
 import { setRangeValue } from "../../../../Utils";
+/**
+ * [[include:Options/Particles/Opacity.md]]
+ * @category Options
+ */
 export class Opacity extends ValueWithRandom {
     constructor() {
         super();
@@ -8,9 +12,18 @@ export class Opacity extends ValueWithRandom {
         this.random.minimumValue = 0.1;
         this.value = 1;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new animation
+     */
     get anim() {
         return this.animation;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new animation
+     * @param value
+     */
     set anim(value) {
         this.animation = value;
     }