tsparticles 1.35.4 → 1.37.2

package/browser/Options/Classes/Interactivity/Modes/BubbleBase.js

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

package/browser/Options/Classes/Interactivity/Modes/BubbleDiv.d.ts

@@ -2,8 +2,17 @@ import type { RecursivePartial, SingleOrMultiple } from "../../../../Types";
 import type { IBubbleDiv } from "../../../Interfaces/Interactivity/Modes/IBubbleDiv";
 import { BubbleBase } from "./BubbleBase";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class BubbleDiv extends BubbleBase implements IBubbleDiv, IOptionLoader<IBubbleDiv> {
+    /**
+     * @deprecated This property is deprecated, please use the new selectors property
+     */
     get ids(): SingleOrMultiple<string>;
+    /**
+     * @deprecated This property is deprecated, please use the new selectors property
+     */
     set ids(value: SingleOrMultiple<string>);
     selectors: SingleOrMultiple<string>;
     constructor();

package/browser/Options/Classes/Interactivity/Modes/BubbleDiv.js

@@ -1,14 +1,23 @@
 import { BubbleBase } from "./BubbleBase";
+/**
+ * @category Options
+ */
 export class BubbleDiv extends BubbleBase {
     constructor() {
         super();
         this.selectors = [];
     }
+    /**
+     * @deprecated This property is deprecated, please use the new selectors property
+     */
     get ids() {
         return this.selectors instanceof Array
             ? this.selectors.map((t) => t.replace("#", ""))
             : this.selectors.replace("#", "");
     }
+    /**
+     * @deprecated This property is deprecated, please use the new selectors property
+     */
     set ids(value) {
         this.selectors = value instanceof Array ? value.map((t) => `#${t}`) : `#${value}`;
     }

package/browser/Options/Classes/Interactivity/Modes/Connect.d.ts

@@ -2,10 +2,31 @@ import type { IConnect } from "../../../Interfaces/Interactivity/Modes/IConnect"
 import { ConnectLinks } from "./ConnectLinks";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Connect implements IConnect, IOptionLoader<IConnect> {
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get line_linked(): ConnectLinks;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set line_linked(value: ConnectLinks);
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get lineLinked(): ConnectLinks;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set lineLinked(value: ConnectLinks);
     distance: number;
     links: ConnectLinks;

package/browser/Options/Classes/Interactivity/Modes/Connect.js

@@ -1,19 +1,40 @@
 import { ConnectLinks } from "./ConnectLinks";
+/**
+ * @category Options
+ */
 export class Connect {
     constructor() {
         this.distance = 80;
         this.links = new ConnectLinks();
         this.radius = 60;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get line_linked() {
         return this.links;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set line_linked(value) {
         this.links = value;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get lineLinked() {
         return this.links;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set lineLinked(value) {
         this.links = value;
     }

package/browser/Options/Classes/Interactivity/Modes/ConnectLinks.d.ts

@@ -1,6 +1,9 @@
 import type { IConnectLinks } from "../../../Interfaces/Interactivity/Modes/IConnectLinks";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class ConnectLinks implements IConnectLinks, IOptionLoader<IConnectLinks> {
     opacity: number;
     constructor();

package/browser/Options/Classes/Interactivity/Modes/ConnectLinks.js

@@ -1,3 +1,6 @@
+/**
+ * @category Options
+ */
 export class ConnectLinks {
     constructor() {
         this.opacity = 0.5;

package/browser/Options/Classes/Interactivity/Modes/Grab.d.ts

@@ -2,10 +2,31 @@ import type { IGrab } from "../../../Interfaces/Interactivity/Modes/IGrab";
 import { GrabLinks } from "./GrabLinks";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Grab implements IGrab, IOptionLoader<IGrab> {
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get line_linked(): GrabLinks;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set line_linked(value: GrabLinks);
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get lineLinked(): GrabLinks;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set lineLinked(value: GrabLinks);
     distance: number;
     links: GrabLinks;

package/browser/Options/Classes/Interactivity/Modes/Grab.js

@@ -1,18 +1,39 @@
 import { GrabLinks } from "./GrabLinks";
+/**
+ * @category Options
+ */
 export class Grab {
     constructor() {
         this.distance = 100;
         this.links = new GrabLinks();
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get line_linked() {
         return this.links;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set line_linked(value) {
         this.links = value;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get lineLinked() {
         return this.links;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set lineLinked(value) {
         this.links = value;
     }

package/browser/Options/Classes/Interactivity/Modes/GrabLinks.d.ts

@@ -2,6 +2,9 @@ import type { IGrabLinks } from "../../../Interfaces/Interactivity/Modes/IGrabLi
 import type { RecursivePartial } from "../../../../Types";
 import { OptionsColor } from "../../OptionsColor";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class GrabLinks implements IGrabLinks, IOptionLoader<IGrabLinks> {
     blink: boolean;
     color?: OptionsColor;

package/browser/Options/Classes/Interactivity/Modes/GrabLinks.js

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

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

@@ -12,6 +12,10 @@ import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import { Attract } from "./Attract";
 import { Light } from "./Light";
 import { Bounce } from "./Bounce";
+/**
+ * [[include:Options/Interactivity/Modes.md]]
+ * @category Options
+ */
 export declare class Modes implements IModes, IOptionLoader<IModes> {
     attract: Attract;
     bounce: Bounce;

package/browser/Options/Classes/Interactivity/Modes/Modes.js

@@ -9,6 +9,10 @@ import { Trail } from "./Trail";
 import { Attract } from "./Attract";
 import { Light } from "./Light";
 import { Bounce } from "./Bounce";
+/**
+ * [[include:Options/Interactivity/Modes.md]]
+ * @category Options
+ */
 export class Modes {
     constructor() {
         this.attract = new Attract();

package/browser/Options/Classes/Interactivity/Modes/Push.d.ts

@@ -1,8 +1,20 @@
 import type { IPush } from "../../../Interfaces/Interactivity/Modes/IPush";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Push implements IPush, IOptionLoader<IPush> {
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new quantity
+     */
     get particles_nb(): number;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new quantity
+     * @param value
+     */
     set particles_nb(value: number);
     default: boolean;
     groups: string[];

package/browser/Options/Classes/Interactivity/Modes/Push.js

@@ -1,12 +1,24 @@
+/**
+ * @category Options
+ */
 export class Push {
     constructor() {
         this.default = true;
         this.groups = [];
         this.quantity = 4;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new quantity
+     */
     get particles_nb() {
         return this.quantity;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new quantity
+     * @param value
+     */
     set particles_nb(value) {
         this.quantity = value;
     }

package/browser/Options/Classes/Interactivity/Modes/Remove.d.ts

@@ -1,8 +1,20 @@
 import type { IRemove } from "../../../Interfaces/Interactivity/Modes/IRemove";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Remove implements IRemove, IOptionLoader<IRemove> {
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new quantity
+     */
     get particles_nb(): number;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new quantity
+     * @param value
+     */
     set particles_nb(value: number);
     quantity: number;
     constructor();

package/browser/Options/Classes/Interactivity/Modes/Remove.js

@@ -1,10 +1,22 @@
+/**
+ * @category Options
+ */
 export class Remove {
     constructor() {
         this.quantity = 2;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new quantity
+     */
     get particles_nb() {
         return this.quantity;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new quantity
+     * @param value
+     */
     set particles_nb(value) {
         this.quantity = value;
     }

package/browser/Options/Classes/Interactivity/Modes/Repulse.d.ts

@@ -3,6 +3,9 @@ import type { RecursivePartial, SingleOrMultiple } from "../../../../Types";
 import { RepulseDiv } from "./RepulseDiv";
 import { RepulseBase } from "./RepulseBase";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Repulse extends RepulseBase implements IRepulse, IOptionLoader<IRepulse> {
     divs?: SingleOrMultiple<RepulseDiv>;
     load(data?: RecursivePartial<IRepulse>): void;

package/browser/Options/Classes/Interactivity/Modes/Repulse.js

@@ -1,5 +1,8 @@
 import { RepulseDiv } from "./RepulseDiv";
 import { RepulseBase } from "./RepulseBase";
+/**
+ * @category Options
+ */
 export class Repulse extends RepulseBase {
     load(data) {
         super.load(data);

package/browser/Options/Classes/Interactivity/Modes/RepulseBase.d.ts

@@ -2,6 +2,9 @@ import type { IRepulseBase } from "../../../Interfaces/Interactivity/Modes/IRepu
 import type { RecursivePartial } from "../../../../Types";
 import { EasingType } from "../../../../Enums";
 import { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare abstract class RepulseBase implements IRepulseBase, IOptionLoader<IRepulseBase> {
     distance: number;
     duration: number;

package/browser/Options/Classes/Interactivity/Modes/RepulseBase.js

@@ -1,4 +1,7 @@
 import { EasingType } from "../../../../Enums";
+/**
+ * @category Options
+ */
 export class RepulseBase {
     constructor() {
         this.distance = 200;

package/browser/Options/Classes/Interactivity/Modes/RepulseDiv.d.ts

@@ -2,8 +2,17 @@ import type { RecursivePartial, SingleOrMultiple } from "../../../../Types";
 import type { IRepulseDiv } from "../../../Interfaces/Interactivity/Modes/IRepulseDiv";
 import { RepulseBase } from "./RepulseBase";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class RepulseDiv extends RepulseBase implements IRepulseDiv, IOptionLoader<IRepulseDiv> {
+    /**
+     * @deprecated This property is deprecated, please use the new selectors property
+     */
     get ids(): SingleOrMultiple<string>;
+    /**
+     * @deprecated This property is deprecated, please use the new selectors property
+     */
     set ids(value: SingleOrMultiple<string>);
     selectors: SingleOrMultiple<string>;
     constructor();

package/browser/Options/Classes/Interactivity/Modes/RepulseDiv.js

@@ -1,9 +1,15 @@
 import { RepulseBase } from "./RepulseBase";
+/**
+ * @category Options
+ */
 export class RepulseDiv extends RepulseBase {
     constructor() {
         super();
         this.selectors = [];
     }
+    /**
+     * @deprecated This property is deprecated, please use the new selectors property
+     */
     get ids() {
         if (this.selectors instanceof Array) {
             return this.selectors.map((t) => t.replace("#", ""));
@@ -11,7 +17,12 @@ export class RepulseDiv extends RepulseBase {
         else {
             return this.selectors.replace("#", "");
         }
+        // this is the best we can do, if a non-id selector is used the old property won't work
+        // but ids is deprecated so who cares.
     }
+    /**
+     * @deprecated This property is deprecated, please use the new selectors property
+     */
     set ids(value) {
         if (value instanceof Array) {
             this.selectors = value.map(() => `#${value}`);

package/browser/Options/Classes/Interactivity/Modes/Slow.d.ts

@@ -1,8 +1,17 @@
 import type { ISlow } from "../../../Interfaces/Interactivity/Modes/ISlow";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Slow implements ISlow, IOptionLoader<ISlow> {
+    /**
+     * @deprecated this property will be removed soon, please use the HoverMode.slow in the HoverEvent
+     */
     get active(): boolean;
+    /**
+     * @deprecated this property will be removed soon, please use the HoverMode.slow in the HoverEvent
+     */
     set active(_value: boolean);
     factor: number;
     radius: number;

package/browser/Options/Classes/Interactivity/Modes/Slow.js

@@ -1,12 +1,22 @@
+/**
+ * @category Options
+ */
 export class Slow {
     constructor() {
         this.factor = 3;
         this.radius = 200;
     }
+    /**
+     * @deprecated this property will be removed soon, please use the HoverMode.slow in the HoverEvent
+     */
     get active() {
         return false;
     }
+    /**
+     * @deprecated this property will be removed soon, please use the HoverMode.slow in the HoverEvent
+     */
     set active(_value) {
+        // deprecated
     }
     load(data) {
         if (data === undefined) {

package/browser/Options/Classes/Interactivity/Modes/Trail.d.ts

@@ -2,6 +2,9 @@ import type { ITrail } from "../../../Interfaces/Interactivity/Modes/ITrail";
 import type { IParticles } from "../../../Interfaces/Particles/IParticles";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class Trail implements ITrail, IOptionLoader<ITrail> {
     delay: number;
     particles?: RecursivePartial<IParticles>;

package/browser/Options/Classes/Interactivity/Modes/Trail.js

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

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

@@ -2,8 +2,19 @@ import type { IMotion } from "../../Interfaces/Motion/IMotion";
 import type { IOptionLoader } from "../../Interfaces/IOptionLoader";
 import type { RecursivePartial } from "../../../Types";
 import { MotionReduce } from "./MotionReduce";
+/**
+ * [[include:Options/Motion.md]]
+ * @category Options
+ */
 export declare class Motion implements IMotion, IOptionLoader<IMotion> {
+    /**
+     * Disables motions for users with `prefer-reduced-motion` enabled
+     */
     disable: boolean;
+    /**
+     * Reduce motion settings for users with `prefer-reduced-motion` enabled
+     * If [[disable]] is `true` these values will be ignored
+     */
     reduce: MotionReduce;
     constructor();
     load(data?: RecursivePartial<IMotion>): void;

package/browser/Options/Classes/Motion/Motion.js

@@ -1,4 +1,8 @@
 import { MotionReduce } from "./MotionReduce";
+/**
+ * [[include:Options/Motion.md]]
+ * @category Options
+ */
 export class Motion {
     constructor() {
         this.disable = false;

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

@@ -1,8 +1,17 @@
 import type { IMotionReduce } from "../../Interfaces/Motion/IMotionReduce";
 import type { IOptionLoader } from "../../Interfaces/IOptionLoader";
 import type { RecursivePartial } from "../../../Types";
+/**
+ * @category Options
+ */
 export declare class MotionReduce implements IMotionReduce, IOptionLoader<IMotionReduce> {
+    /**
+     * Factor used to reduce motion, the higher the value, the higher the motion reduction
+     */
     factor: number;
+    /**
+     * Reduces motion settings for users with `prefer-reduced-motion` enabled
+     */
     value: boolean;
     constructor();
     load(data?: RecursivePartial<IMotionReduce>): void;

package/browser/Options/Classes/Motion/MotionReduce.js

@@ -1,3 +1,6 @@
+/**
+ * @category Options
+ */
 export class MotionReduce {
     constructor() {
         this.factor = 4;

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;
 }