tsparticles 1.35.4 → 1.37.2

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

@@ -5,6 +5,10 @@ import { OrbitRotation } from "./OrbitRotation";
 import { OptionsColor } from "../../OptionsColor";
 import { AnimationOptions } from "../../AnimationOptions";
 import type { IAnimatable } from "../../../Interfaces/IAnimatable";
+/**
+ * [[include:Options/Particles/Orbit.md]]
+ * @category Options
+ */
 export declare class Orbit implements IOrbit, IOptionLoader<IOrbit>, IAnimatable<AnimationOptions> {
     animation: AnimationOptions;
     enable: boolean;

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

@@ -1,6 +1,10 @@
 import { OrbitRotation } from "./OrbitRotation";
 import { OptionsColor } from "../../OptionsColor";
 import { AnimationOptions } from "../../AnimationOptions";
+/**
+ * [[include:Options/Particles/Orbit.md]]
+ * @category Options
+ */
 export class Orbit {
     constructor() {
         this.animation = new AnimationOptions();

package/browser/Options/Classes/Particles/Orbit/OrbitRotation.d.ts

@@ -1,6 +1,9 @@
 import type { RecursivePartial } from "../../../../Types";
 import type { IValueWithRandom } from "../../../Interfaces/IValueWithRandom";
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * @category Options
+ */
 export declare class OrbitRotation extends ValueWithRandom {
     constructor();
     load(data?: RecursivePartial<IValueWithRandom>): void;

package/browser/Options/Classes/Particles/Orbit/OrbitRotation.js

@@ -1,4 +1,7 @@
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * @category Options
+ */
 export class OrbitRotation extends ValueWithRandom {
     constructor() {
         super();

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

@@ -24,6 +24,10 @@ import type { ParticlesGroups } from "../../../Types/ParticlesGroups";
 import { Orbit } from "./Orbit/Orbit";
 import { Repulse } from "./Repulse/Repulse";
 import { AnimatableGradient } from "../AnimatableGradient";
+/**
+ * [[include:Options/Particles.md]]
+ * @category Options
+ */
 export declare class ParticlesOptions implements IParticles, IOptionLoader<IParticles> {
     bounce: Bounce;
     collisions: Collisions;
@@ -49,9 +53,27 @@ export declare class ParticlesOptions implements IParticles, IOptionLoader<IPart
     twinkle: Twinkle;
     wobble: Wobble;
     zIndex: ZIndex;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     */
     get line_linked(): Links;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new links
+     * @param value
+     */
     set line_linked(value: Links);
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new lineLinked
+     */
     get lineLinked(): Links;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new lineLinked
+     * @param value
+     */
     set lineLinked(value: Links);
     constructor();
     load(data?: RecursivePartial<IParticles>): void;

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

@@ -21,6 +21,10 @@ import { deepExtend } from "../../../Utils";
 import { Orbit } from "./Orbit/Orbit";
 import { Repulse } from "./Repulse/Repulse";
 import { AnimatableGradient } from "../AnimatableGradient";
+/**
+ * [[include:Options/Particles.md]]
+ * @category Options
+ */
 export class ParticlesOptions {
     constructor() {
         this.bounce = new Bounce();
@@ -48,15 +52,33 @@ export class ParticlesOptions {
         this.wobble = new Wobble();
         this.zIndex = new ZIndex();
     }
+    /**
+     *
+     * @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 lineLinked
+     */
     get lineLinked() {
         return this.links;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new lineLinked
+     * @param value
+     */
     set lineLinked(value) {
         this.links = value;
     }

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

@@ -2,6 +2,9 @@ import type { IRepulse } from "../../../Interfaces/Particles/Repulse/IRepulse";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * @category Options
+ */
 export declare class Repulse extends ValueWithRandom implements IRepulse, IOptionLoader<IRepulse> {
     enabled: boolean;
     distance: number;

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

@@ -1,4 +1,7 @@
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * @category Options
+ */
 export class Repulse extends ValueWithRandom {
     constructor() {
         super();

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

@@ -4,6 +4,10 @@ import { RotateDirection, RotateDirectionAlt } from "../../../../Enums";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * [[include:Options/Particles/Rotate.md]]
+ * @category Options
+ */
 export declare class Rotate extends ValueWithRandom implements IRotate, IOptionLoader<IRotate> {
     animation: RotateAnimation;
     direction: RotateDirection | keyof typeof RotateDirection | RotateDirectionAlt;

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

@@ -1,6 +1,10 @@
 import { RotateAnimation } from "./RotateAnimation";
 import { RotateDirection } from "../../../../Enums";
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * [[include:Options/Particles/Rotate.md]]
+ * @category Options
+ */
 export class Rotate extends ValueWithRandom {
     constructor() {
         super();

package/browser/Options/Classes/Particles/Rotate/RotateAnimation.d.ts

@@ -1,6 +1,9 @@
 import type { IRotateAnimation } from "../../../Interfaces/Particles/Rotate/IRotateAnimation";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ */
 export declare class RotateAnimation implements IRotateAnimation, IOptionLoader<IRotateAnimation> {
     enable: boolean;
     speed: number;

package/browser/Options/Classes/Particles/Rotate/RotateAnimation.js

@@ -1,3 +1,6 @@
+/**
+ * @category Options
+ */
 export class RotateAnimation {
     constructor() {
         this.enable = false;

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

@@ -3,6 +3,10 @@ import type { ICoordinates } from "../../../Core/Interfaces/ICoordinates";
 import type { RecursivePartial } from "../../../Types";
 import { OptionsColor } from "../OptionsColor";
 import type { IOptionLoader } from "../../Interfaces/IOptionLoader";
+/**
+ * @category Options
+ * [[include:Shadow.md]]
+ */
 export declare class Shadow implements IShadow, IOptionLoader<IShadow> {
     blur: number;
     color: OptionsColor;

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

@@ -1,4 +1,8 @@
 import { OptionsColor } from "../OptionsColor";
+/**
+ * @category Options
+ * [[include:Shadow.md]]
+ */
 export class Shadow {
     constructor() {
         this.blur = 0;

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

@@ -6,18 +6,60 @@ import type { IPolygonShape } from "../../../Interfaces/Particles/Shape/IPolygon
 import type { IImageShape } from "../../../Interfaces/Particles/Shape/IImageShape";
 import type { ICharacterShape } from "../../../Interfaces/Particles/Shape/ICharacterShape";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * [[include:Options/Particles/Shape.md]]
+ * @category Options
+ */
 export declare class Shape implements IShape, IOptionLoader<IShape> {
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     get image(): SingleOrMultiple<IImageShape>;
+    /**
+     * @deprecated this property was integrated in custom shape management
+     * @param value
+     */
     set image(value: SingleOrMultiple<IImageShape>);
+    /**
+     * @deprecated This options has been renamed options
+     */
     get custom(): ShapeData;
+    /**
+     * @deprecated This options has been renamed options
+     * @param value
+     */
     set custom(value: ShapeData);
+    /**
+     * @deprecated the property images is deprecated, please use the image property, it works with one and many
+     */
     get images(): SingleOrMultiple<IImageShape>;
+    /**
+     * @deprecated the property images is deprecated, please use the image property, it works with one and many
+     */
     set images(value: SingleOrMultiple<IImageShape>);
+    /**
+     * @deprecated this property was moved to particles section
+     */
     get stroke(): SingleOrMultiple<Stroke>;
+    /**
+     * @deprecated this property was moved to particles section
+     */
     set stroke(_value: SingleOrMultiple<Stroke>);
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     get character(): SingleOrMultiple<ICharacterShape>;
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     set character(value: SingleOrMultiple<ICharacterShape>);
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     get polygon(): SingleOrMultiple<IPolygonShape>;
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     set polygon(value: SingleOrMultiple<IPolygonShape>);
     type: SingleOrMultiple<ShapeType | keyof typeof ShapeType | string>;
     options: ShapeData;

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

@@ -1,47 +1,90 @@
 import { ShapeType } from "../../../../Enums";
 import { deepExtend } from "../../../../Utils";
+/**
+ * [[include:Options/Particles/Shape.md]]
+ * @category Options
+ */
 export class Shape {
     constructor() {
         this.options = {};
         this.type = ShapeType.circle;
     }
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     get image() {
         var _a;
         return ((_a = this.options[ShapeType.image]) !== null && _a !== void 0 ? _a : this.options[ShapeType.images]);
     }
+    /**
+     * @deprecated this property was integrated in custom shape management
+     * @param value
+     */
     set image(value) {
         this.options[ShapeType.image] = value;
         this.options[ShapeType.images] = value;
     }
+    /**
+     * @deprecated This options has been renamed options
+     */
     get custom() {
         return this.options;
     }
+    /**
+     * @deprecated This options has been renamed options
+     * @param value
+     */
     set custom(value) {
         this.options = value;
     }
+    /**
+     * @deprecated the property images is deprecated, please use the image property, it works with one and many
+     */
     get images() {
         return this.image;
     }
+    /**
+     * @deprecated the property images is deprecated, please use the image property, it works with one and many
+     */
     set images(value) {
         this.image = value;
     }
+    /**
+     * @deprecated this property was moved to particles section
+     */
     get stroke() {
         return [];
     }
+    /**
+     * @deprecated this property was moved to particles section
+     */
     set stroke(_value) {
+        // deprecated
     }
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     get character() {
         var _a;
         return ((_a = this.options[ShapeType.character]) !== null && _a !== void 0 ? _a : this.options[ShapeType.char]);
     }
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     set character(value) {
         this.options[ShapeType.character] = value;
         this.options[ShapeType.char] = value;
     }
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     get polygon() {
         var _a;
         return ((_a = this.options[ShapeType.polygon]) !== null && _a !== void 0 ? _a : this.options[ShapeType.star]);
     }
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     set polygon(value) {
         this.options[ShapeType.polygon] = value;
         this.options[ShapeType.star] = value;

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

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

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

@@ -1,6 +1,10 @@
 import { SizeAnimation } from "./SizeAnimation";
 import { ValueWithRandom } from "../../ValueWithRandom";
 import { setRangeValue } from "../../../../Utils";
+/**
+ * [[include:Options/Particles/Size.md]]
+ * @category Options
+ */
 export class Size extends ValueWithRandom {
     constructor() {
         super();
@@ -8,9 +12,18 @@ export class Size extends ValueWithRandom {
         this.random.minimumValue = 1;
         this.value = 3;
     }
+    /**
+     *
+     * @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;
     }

package/browser/Options/Classes/Particles/Size/SizeAnimation.d.ts

@@ -3,10 +3,25 @@ import type { RecursivePartial } from "../../../../Types";
 import { DestroyType, StartValueType } from "../../../../Enums";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import { AnimationOptions } from "../../AnimationOptions";
+/**
+ * @category Options
+ */
 export declare class SizeAnimation extends AnimationOptions implements ISizeAnimation, IOptionLoader<ISizeAnimation> {
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new minimumValue
+     */
     get size_min(): number | undefined;
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new minimumValue
+     * @param value
+     */
     set size_min(value: number | undefined);
     destroy: DestroyType | keyof typeof DestroyType;
+    /**
+     * @deprecated this property is obsolete, please use the new min/max object in the size value
+     */
     minimumValue?: number;
     startValue: StartValueType | keyof typeof StartValueType;
     constructor();

package/browser/Options/Classes/Particles/Size/SizeAnimation.js

@@ -1,5 +1,8 @@
 import { DestroyType, StartValueType } from "../../../../Enums";
 import { AnimationOptions } from "../../AnimationOptions";
+/**
+ * @category Options
+ */
 export class SizeAnimation extends AnimationOptions {
     constructor() {
         super();
@@ -9,9 +12,18 @@ export class SizeAnimation extends AnimationOptions {
         this.startValue = StartValueType.random;
         this.sync = false;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new minimumValue
+     */
     get size_min() {
         return this.minimumValue;
     }
+    /**
+     *
+     * @deprecated this property is obsolete, please use the new minimumValue
+     * @param value
+     */
     set size_min(value) {
         this.minimumValue = value;
     }

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

@@ -2,6 +2,10 @@ import type { IStroke } from "../../Interfaces/Particles/IStroke";
 import type { RecursivePartial } from "../../../Types";
 import { AnimatableColor } from "../AnimatableColor";
 import type { IOptionLoader } from "../../Interfaces/IOptionLoader";
+/**
+ * [[include:Options/Particles/Stroke.md]]
+ * @category Options
+ */
 export declare class Stroke implements IStroke, IOptionLoader<IStroke> {
     color?: AnimatableColor;
     width: number;

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

@@ -1,4 +1,8 @@
 import { AnimatableColor } from "../AnimatableColor";
+/**
+ * [[include:Options/Particles/Stroke.md]]
+ * @category Options
+ */
 export class Stroke {
     constructor() {
         this.width = 0;

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

@@ -4,6 +4,10 @@ import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import { ValueWithRandom } from "../../ValueWithRandom";
 import type { ITilt } from "../../../Interfaces/Particles/Tilt/ITilt";
+/**
+ * [[include:Options/Particles/Rotate.md]]
+ * @category Options
+ */
 export declare class Tilt extends ValueWithRandom implements ITilt, IOptionLoader<ITilt> {
     animation: TiltAnimation;
     direction: TiltDirection | keyof typeof TiltDirection | TiltDirectionAlt;

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

@@ -1,6 +1,10 @@
 import { TiltAnimation } from "./TiltAnimation";
 import { TiltDirection } from "../../../../Enums";
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * [[include:Options/Particles/Rotate.md]]
+ * @category Options
+ */
 export class Tilt extends ValueWithRandom {
     constructor() {
         super();

package/browser/Options/Classes/Particles/Tilt/TiltAnimation.d.ts

@@ -1,6 +1,9 @@
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import type { ITiltAnimation } from "../../../Interfaces/Particles/Tilt/ITiltAnimation";
+/**
+ * @category Options
+ */
 export declare class TiltAnimation implements ITiltAnimation, IOptionLoader<ITiltAnimation> {
     enable: boolean;
     speed: number;

package/browser/Options/Classes/Particles/Tilt/TiltAnimation.js

@@ -1,3 +1,6 @@
+/**
+ * @category Options
+ */
 export class TiltAnimation {
     constructor() {
         this.enable = false;

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

@@ -2,6 +2,10 @@ import type { ITwinkle } from "../../../Interfaces/Particles/Twinkle/ITwinkle";
 import type { RecursivePartial } from "../../../../Types";
 import { TwinkleValues } from "./TwinkleValues";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
+/**
+ * [[include:Options/Particles/Twinkle.md]]
+ * @category Options
+ */
 export declare class Twinkle implements ITwinkle, IOptionLoader<ITwinkle> {
     lines: TwinkleValues;
     particles: TwinkleValues;

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

@@ -1,4 +1,8 @@
 import { TwinkleValues } from "./TwinkleValues";
+/**
+ * [[include:Options/Particles/Twinkle.md]]
+ * @category Options
+ */
 export class Twinkle {
     constructor() {
         this.lines = new TwinkleValues();

package/browser/Options/Classes/Particles/Twinkle/TwinkleValues.d.ts

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

package/browser/Options/Classes/Particles/Twinkle/TwinkleValues.js

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

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

@@ -2,6 +2,9 @@ import type { IZIndex } from "../../../Interfaces/Particles/ZIndex/IZIndex";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader";
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * @category Options
+ */
 export declare class ZIndex extends ValueWithRandom implements IZIndex, IOptionLoader<IZIndex> {
     opacityRate: number;
     sizeRate: number;

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

@@ -1,4 +1,7 @@
 import { ValueWithRandom } from "../../ValueWithRandom";
+/**
+ * @category Options
+ */
 export class ZIndex extends ValueWithRandom {
     constructor() {
         super();

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

@@ -2,9 +2,11 @@ import type { IResponsive } from "../Interfaces/IResponsive";
 import type { IOptionLoader } from "../Interfaces/IOptionLoader";
 import type { RecursivePartial } from "../../Types";
 import type { IOptions } from "../Interfaces/IOptions";
+import { ResponsiveMode } from "../../Enums";
 export declare class Responsive implements IResponsive, IOptionLoader<IResponsive> {
     maxWidth: number;
     options: RecursivePartial<IOptions>;
+    mode: ResponsiveMode;
     constructor();
     load(data?: RecursivePartial<IResponsive>): void;
 }

package/browser/Options/Classes/Responsive.js

@@ -1,8 +1,10 @@
 import { deepExtend } from "../../Utils";
+import { ResponsiveMode } from "../../Enums";
 export class Responsive {
     constructor() {
         this.maxWidth = Infinity;
         this.options = {};
+        this.mode = ResponsiveMode.canvas;
     }
     load(data) {
         if (!data) {
@@ -11,6 +13,15 @@ export class Responsive {
         if (data.maxWidth !== undefined) {
             this.maxWidth = data.maxWidth;
         }
+        if (data.mode !== undefined) {
+            // not enforcing an error here as this should largely be an opt-in setting
+            if (data.mode === ResponsiveMode.screen) {
+                this.mode = ResponsiveMode.screen;
+            }
+            else {
+                this.mode = ResponsiveMode.canvas;
+            }
+        }
         if (data.options !== undefined) {
             this.options = deepExtend({}, data.options);
         }

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

@@ -3,6 +3,9 @@ import type { IOptionLoader } from "../Interfaces/IOptionLoader";
 import { Random } from "./Random";
 import type { RangeValue, RecursivePartial } from "../../Types";
 export declare abstract class ValueWithRandom implements IValueWithRandom, IOptionLoader<IValueWithRandom> {
+    /**
+     * @deprecated use the new [[RangeValue]] type instead
+     */
     random: Random;
     value: RangeValue;
     protected constructor();