tsparticles 1.35.2 → 1.37.0

package/browser/Options/Interfaces/Interactivity/Modes/IRepulseDiv.d.ts

@@ -1,4 +1,7 @@
 import type { IRepulseBase } from "./IRepulseBase";
 import type { IModeDiv } from "./IModeDiv";
+/**
+ * @category Options
+ */
 export interface IRepulseDiv extends IRepulseBase, IModeDiv {
 }

package/browser/Options/Interfaces/Interactivity/Modes/ISlow.d.ts

@@ -1,4 +1,10 @@
+/**
+ * @category Options
+ */
 export interface ISlow {
+    /**
+     * @deprecated this property will be removed soon, please use the HoverMode.slow in the HoverEvent
+     */
     active: boolean;
     radius: number;
     factor: number;

package/browser/Options/Interfaces/Interactivity/Modes/ITrail.d.ts

@@ -1,5 +1,8 @@
 import type { IParticles } from "../../Particles/IParticles";
 import type { RecursivePartial } from "../../../../Types";
+/**
+ * @category Options
+ */
 export interface ITrail {
     delay: number;
     particles?: RecursivePartial<IParticles>;

package/browser/Options/Interfaces/Motion/IMotion.d.ts

@@ -1,5 +1,16 @@
 import { IMotionReduce } from "./IMotionReduce";
+/**
+ * [[include:Options/Motion.md]]
+ * @category Options
+ */
 export interface 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: IMotionReduce;
 }

package/browser/Options/Interfaces/Motion/IMotionReduce.d.ts

@@ -1,4 +1,13 @@
+/**
+ * @category Options
+ */
 export interface 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;
 }

package/browser/Options/Interfaces/Particles/Collisions/ICollisions.d.ts

@@ -1,6 +1,10 @@
 import type { CollisionMode } from "../../../../Enums";
 import type { IBounce } from "../Bounce/IBounce";
 import type { ICollisionsOverlap } from "./ICollisionsOverlap";
+/**
+ * @category Options
+ * [[include:Collisions.md]]
+ */
 export interface ICollisions {
     bounce: IBounce;
     enable: boolean;

package/browser/Options/Interfaces/Particles/Destroy/IDestroy.d.ts

@@ -1,5 +1,9 @@
 import type { DestroyMode } from "../../../../Enums";
 import type { ISplit } from "./ISplit";
+/**
+ * @category Options
+ * [[include:Destroy.md]]
+ */
 export interface IDestroy {
     mode: DestroyMode;
     split: ISplit;

package/browser/Options/Interfaces/Particles/IParticles.d.ts

@@ -22,8 +22,18 @@ import type { ParticlesGroups } from "../../../Types/ParticlesGroups";
 import type { IOrbit } from "./Orbit/IOrbit";
 import type { IRepulse } from "./Repulse/IRepulse";
 import type { IAnimatableGradient } from "../IAnimatableGradient";
+/**
+ * [[include:Options/Particles.md]]
+ * @category Options
+ */
 export interface IParticles {
+    /**
+     * @deprecated use the new links instead
+     */
     line_linked: ILinks;
+    /**
+     * @deprecated use the new links instead
+     */
     lineLinked: ILinks;
     bounce: IBounce;
     collisions: ICollisions;

package/browser/Options/Interfaces/Particles/IShadow.d.ts

@@ -1,5 +1,9 @@
 import type { ICoordinates } from "../../../Core/Interfaces/ICoordinates";
 import type { IColor } from "../../../Core/Interfaces/Colors";
+/**
+ * @category Options
+ * [[include:Shadow.md]]
+ */
 export interface IShadow {
     blur: number;
     color: string | IColor;

package/browser/Options/Interfaces/Particles/IStroke.d.ts

@@ -1,7 +1,21 @@
 import type { IAnimatableColor } from "../IAnimatableColor";
 import type { IColor } from "../../../Core/Interfaces";
+/**
+ * Particle stroke, outlines the particle with a customizable line
+ * [[include:Options/Particles/Stroke.md]]
+ * @category Options
+ */
 export interface IStroke {
+    /**
+     * The stroke color, can be animated too
+     */
     color?: string | IAnimatableColor | IColor;
+    /**
+     * The stroke opacity
+     */
     opacity?: number;
+    /**
+     * The stroke line width
+     */
     width: number;
 }

package/browser/Options/Interfaces/Particles/Links/ILinks.d.ts

@@ -1,17 +1,60 @@
 import type { ILinksShadow } from "./ILinksShadow";
 import type { ILinksTriangle } from "./ILinksTriangle";
 import type { IColor } from "../../../../Core/Interfaces/Colors";
+/**
+ * Particles Links options, this configures how the particles link together
+ * [[include:Options/Particles/Links.md]]
+ * @category Options
+ */
 export interface ILinks {
+    /**
+     * Enables random blinking, if set to true and [[color]] is set to "random"
+     * the link will have a random color each frame resulting in a blinking animation
+     */
     blink: boolean;
+    /**
+     * Link line color, can be a string or an [[IColor]] object.
+     * If the value is "random", if [[blink]] is `true` sets a random color each frame,
+     * if [[consent]] is `true` a random color is used for all links,
+     * if [[blink]] and [[consent]] are false the color will be a gradient with the two linked particles color
+     */
     color: string | IColor;
+    /**
+     * If enabled the links will have a single random color, if [[color]] value is "random"
+     */
     consent: boolean;
+    /**
+     * Sets the maximum particles link line length
+     */
     distance: number;
+    /**
+     * Enables the particles links
+     */
     enable: boolean;
     frequency: number;
+    /**
+     * Sets the link id, if two particles have a different link id they won't link together
+     */
     id?: string;
+    /**
+     * Sets the maximum link opacity
+     */
     opacity: number;
+    /**
+     * Enables the link line shadow
+     * **Shadows in canvas are really heavy and this can affect negatively on performances, use with caution**
+     */
     shadow: ILinksShadow;
+    /**
+     * Fills the triangles made by link lines
+     */
     triangles: ILinksTriangle;
+    /**
+     * Enable link lines warp, linking particles between edges like there's a warp portal at the edges
+     */
     warp: boolean;
+    /**
+     * Sets the link line width
+     */
     width: number;
 }

package/browser/Options/Interfaces/Particles/Links/ILinksShadow.d.ts

@@ -1,4 +1,7 @@
 import type { IColor } from "../../../../Core/Interfaces/Colors";
+/**
+ * @category Options
+ */
 export interface ILinksShadow {
     blur: number;
     color: string | IColor;

package/browser/Options/Interfaces/Particles/Links/ILinksTriangle.d.ts

@@ -1,4 +1,7 @@
 import type { IColor } from "../../../../Core/Interfaces/Colors";
+/**
+ * @category Options
+ */
 export interface ILinksTriangle {
     color?: string | IColor;
     enable: boolean;

package/browser/Options/Interfaces/Particles/Move/IAttract.d.ts

@@ -1,8 +1,17 @@
 import type { ICoordinates } from "../../../../Core/Interfaces/ICoordinates";
+/**
+ * @category Options
+ */
 export interface IAttract {
     distance: number;
     enable: boolean;
+    /**
+     * @deprecated use the new rotate.x instead
+     */
     rotateX: number;
+    /**
+     * @deprecated use the new rotate.y instead
+     */
     rotateY: number;
     rotate: ICoordinates;
 }

package/browser/Options/Interfaces/Particles/Move/IMove.d.ts

@@ -8,11 +8,30 @@ import type { IOutModes } from "./IOutModes";
 import type { RangeValue } from "../../../../Types";
 import { IDistance } from "../../../../Core/Interfaces";
 import { ISpin } from "./ISpin";
+/**
+ * [[include:Options/Particles/Move.md]]
+ * @category Options
+ */
 export interface IMove {
+    /**
+     * @deprecated use the new collisions property on particles instead
+     */
     bounce: boolean;
+    /**
+     * @deprecated use the new collisions property on particles instead
+     */
     collisions: boolean;
+    /**
+     * @deprecated use the new outModes instead
+     */
     out_mode: OutMode | keyof typeof OutMode | OutModeAlt;
+    /**
+     * @deprecated use the new outModes instead
+     */
     outMode: OutMode | keyof typeof OutMode | OutModeAlt;
+    /**
+     * @deprecated use the new [[path]] property instead
+     */
     noise: IPath;
     angle: number | IMoveAngle;
     attract: IAttract;

package/browser/Options/Interfaces/Particles/Move/IMoveAngle.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @category Options
+ */
 export interface IMoveAngle {
     offset: number;
     value: number;

package/browser/Options/Interfaces/Particles/Move/ITrail.d.ts

@@ -1,4 +1,7 @@
 import type { IColor } from "../../../../Core/Interfaces/Colors";
+/**
+ * @category Options
+ */
 export interface ITrail {
     fillColor: string | IColor;
     enable: boolean;

package/browser/Options/Interfaces/Particles/Move/Path/iPath.d.ts

@@ -1,5 +1,8 @@
 import type { IValueWithRandom } from "../../../IValueWithRandom";
 import type { PathOptions } from "../../../../../Types";
+/**
+ * @category Options
+ */
 export interface IPath {
     clamp: boolean;
     delay: IValueWithRandom;

package/browser/Options/Interfaces/Particles/Number/IDensity.d.ts

@@ -1,6 +1,12 @@
+/**
+ * @category Options
+ */
 export interface IDensity {
     area: number;
     enable: boolean;
     factor: number;
+    /**
+     * @deprecated use the new area instead
+     */
     value_area: number;
 }

package/browser/Options/Interfaces/Particles/Number/IParticlesNumber.d.ts

@@ -1,5 +1,12 @@
 import type { IDensity } from "./IDensity";
+/**
+ * [[include:Options/Particles/Number.md]]
+ * @category Options
+ */
 export interface IParticlesNumber {
+    /**
+     * @deprecated the property max is deprecated, use the new limit instead
+     */
     max: number;
     density: IDensity;
     limit: number;

package/browser/Options/Interfaces/Particles/Opacity/IOpacity.d.ts

@@ -1,6 +1,13 @@
 import type { IOpacityAnimation } from "./IOpacityAnimation";
 import type { IValueWithRandom } from "../../IValueWithRandom";
+/**
+ * [[include:Options/Particles/Opacity.md]]
+ * @category Options
+ */
 export interface IOpacity extends IValueWithRandom {
+    /**
+     * @deprecated use the new animation instead
+     */
     anim: IOpacityAnimation;
     animation: IOpacityAnimation;
 }

package/browser/Options/Interfaces/Particles/Opacity/IOpacityAnimation.d.ts

@@ -1,7 +1,16 @@
 import type { DestroyType, StartValueType } from "../../../../Enums";
 import type { IAnimation } from "../../IAnimation";
+/**
+ * @category Options
+ */
 export interface IOpacityAnimation extends IAnimation {
+    /**
+     * @deprecated use the new minimumValue instead
+     */
     opacity_min?: number;
+    /**
+     * @deprecated use the new min/max object in opacity value
+     */
     minimumValue?: number;
     destroy: DestroyType | keyof typeof DestroyType;
     startValue: StartValueType | keyof typeof StartValueType;

package/browser/Options/Interfaces/Particles/Orbit/IOrbit.d.ts

@@ -2,8 +2,15 @@ import type { IColor } from "../../../../Core/Interfaces";
 import type { IValueWithRandom } from "../../IValueWithRandom";
 import type { IAnimation } from "../../IAnimation";
 import type { IAnimatable } from "../../IAnimatable";
+/**
+ * @category Options
+ * [[include:Options/Particles/Orbit.md]]
+ */
 export interface IOrbit extends IAnimatable<IAnimation> {
     color?: string | IColor;
+    /**
+     * Enables/disables the animation
+     */
     enable: boolean;
     radius?: number;
     rotation: IValueWithRandom;

package/browser/Options/Interfaces/Particles/Repulse/IRepulse.d.ts

@@ -1,4 +1,8 @@
 import type { IValueWithRandom } from "../../IValueWithRandom";
+/**
+ * @category Options
+ * [[include:Options/Particles/Repulse.md]]
+ */
 export interface IRepulse extends IValueWithRandom {
     enabled: boolean;
     distance: number;

package/browser/Options/Interfaces/Particles/Rotate/IRotate.d.ts

@@ -1,6 +1,10 @@
 import type { IRotateAnimation } from "./IRotateAnimation";
 import type { RotateDirection, RotateDirectionAlt } from "../../../../Enums";
 import type { IValueWithRandom } from "../../IValueWithRandom";
+/**
+ * [[include:Options/Particles/Rotate.md]]
+ * @category Options
+ */
 export interface IRotate extends IValueWithRandom {
     animation: IRotateAnimation;
     direction: RotateDirection | keyof typeof RotateDirection | RotateDirectionAlt;

package/browser/Options/Interfaces/Particles/Rotate/IRotateAnimation.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @category Options
+ */
 export interface IRotateAnimation {
     enable: boolean;
     speed: number;

package/browser/Options/Interfaces/Particles/Shape/ICharacterShape.d.ts

@@ -1,5 +1,8 @@
 import type { IShapeValues } from "./IShapeValues";
 import type { SingleOrMultiple } from "../../../../Types";
+/**
+ * @category Options
+ */
 export interface ICharacterShape extends IShapeValues {
     value: SingleOrMultiple<string>;
     font: string;

package/browser/Options/Interfaces/Particles/Shape/IImageShape.d.ts

@@ -1,5 +1,11 @@
 import type { IShapeValues } from "./IShapeValues";
+/**
+ * @category Options
+ */
 export interface IImageShape extends IShapeValues {
+    /**
+     * @deprecated use the new replaceColor instead
+     */
     replace_color: boolean;
     replaceColor: boolean;
     src: string;

package/browser/Options/Interfaces/Particles/Shape/IPolygonShape.d.ts

@@ -1,5 +1,11 @@
 import type { IShapeValues } from "./IShapeValues";
+/**
+ * @category Options
+ */
 export interface IPolygonShape extends IShapeValues {
+    /**
+     * @deprecated use the new sides instead
+     */
     nb_sides: number;
     sides: number;
 }

package/browser/Options/Interfaces/Particles/Shape/IShape.d.ts

@@ -4,13 +4,35 @@ import type { ICharacterShape } from "./ICharacterShape";
 import type { IPolygonShape } from "./IPolygonShape";
 import type { IStroke } from "../IStroke";
 import type { ShapeData, SingleOrMultiple } from "../../../../Types";
+/**
+ * [[include:Options/Particles/Shape.md]]
+ * @category Options
+ */
 export interface IShape {
     type: SingleOrMultiple<ShapeType | keyof typeof ShapeType | string>;
+    /**
+     * @deprecated this property was moved to particles section
+     */
     stroke: SingleOrMultiple<IStroke>;
+    /**
+     * @deprecated this property is now integrated in custom shape management
+     */
     polygon: SingleOrMultiple<IPolygonShape>;
+    /**
+     * @deprecated this property is now integrated in custom shape management
+     */
     character: SingleOrMultiple<ICharacterShape>;
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     image: SingleOrMultiple<IImageShape>;
+    /**
+     * @deprecated this property was integrated in custom shape management
+     */
     images: SingleOrMultiple<IImageShape>;
+    /**
+     * @deprecated this property has been renamed to options
+     */
     custom: ShapeData;
     options: ShapeData;
 }

package/browser/Options/Interfaces/Particles/Shape/IStarShape.d.ts

@@ -1,5 +1,11 @@
 import { IShapeValues } from "./IShapeValues";
+/**
+ * @category Options
+ */
 export interface IStarShape extends IShapeValues {
+    /**
+     * @deprecated use the new sides instead
+     */
     nb_sides: number;
     sides: number;
     inset: number;

package/browser/Options/Interfaces/Particles/Size/ISize.d.ts

@@ -1,6 +1,13 @@
 import type { ISizeAnimation } from "./ISizeAnimation";
 import type { IValueWithRandom } from "../../IValueWithRandom";
+/**
+ * [[include:Options/Particles/Size.md]]
+ * @category Options
+ */
 export interface ISize extends IValueWithRandom {
+    /**
+     * @deprecated use the new animation instead
+     */
     anim: ISizeAnimation;
     animation: ISizeAnimation;
 }

package/browser/Options/Interfaces/Particles/Size/ISizeAnimation.d.ts

@@ -1,7 +1,16 @@
 import type { DestroyType, StartValueType } from "../../../../Enums";
 import type { IAnimation } from "../../IAnimation";
+/**
+ * @category Options
+ */
 export interface ISizeAnimation extends IAnimation {
+    /**
+     * @deprecated use the new minimumValue instead
+     */
     size_min?: number;
+    /**
+     * @deprecated use the new min/max object in the size value
+     */
     minimumValue?: number;
     destroy: DestroyType | keyof typeof DestroyType;
     startValue: StartValueType | keyof typeof StartValueType;

package/browser/Options/Interfaces/Particles/Tilt/ITilt.d.ts

@@ -1,6 +1,10 @@
 import type { ITiltAnimation } from "./ITiltAnimation";
 import type { TiltDirection, TiltDirectionAlt } from "../../../../Enums";
 import type { IValueWithRandom } from "../../IValueWithRandom";
+/**
+ * [[include:Options/Particles/Rotate.md]]
+ * @category Options
+ */
 export interface ITilt extends IValueWithRandom {
     animation: ITiltAnimation;
     direction: TiltDirection | keyof typeof TiltDirection | TiltDirectionAlt;

package/browser/Options/Interfaces/Particles/Tilt/ITiltAnimation.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @category Options
+ */
 export interface ITiltAnimation {
     enable: boolean;
     speed: number;

package/browser/Options/Interfaces/Particles/Twinkle/ITwinkle.d.ts

@@ -1,4 +1,8 @@
 import type { ITwinkleValues } from "./ITwinkleValues";
+/**
+ * [[include:Options/Particles/Twinkle.md]]
+ * @category Options
+ */
 export interface ITwinkle {
     lines: ITwinkleValues;
     particles: ITwinkleValues;

package/browser/Options/Interfaces/Particles/Twinkle/ITwinkleValues.d.ts

@@ -1,4 +1,7 @@
 import type { IColor } from "../../../../Core/Interfaces/Colors";
+/**
+ * @category Options
+ */
 export interface ITwinkleValues {
     color?: string | IColor;
     enable: boolean;

package/browser/Options/Interfaces/Particles/ZIndex/IZIndex.d.ts

@@ -1,4 +1,8 @@
 import type { IValueWithRandom } from "../../IValueWithRandom";
+/**
+ * @category Options
+ * [[include:Options/Particles/ZIndex.md]]
+ */
 export interface IZIndex extends IValueWithRandom {
     opacityRate: number;
     velocityRate: number;

package/browser/Options/Interfaces/Theme/ITheme.d.ts

@@ -1,8 +1,22 @@
 import type { RecursivePartial } from "../../../Types";
 import type { IThemeDefault } from "./IThemeDefault";
 import type { IOptions } from "../IOptions";
+/**
+ * The options to configure themes that can be easily switched
+ * [[include:Options/Themes.md]]
+ * @category Options
+ */
 export interface ITheme {
+    /**
+     * Theme name, use it when changing theme
+     */
     name: string;
+    /**
+     * Options to set the default theme
+     */
     default: IThemeDefault;
+    /**
+     * All options the theme will override
+     */
     options?: RecursivePartial<IOptions>;
 }

package/browser/Options/Interfaces/Theme/IThemeDefault.d.ts

@@ -1,6 +1,22 @@
 import type { ThemeMode } from "../../../Enums";
+/**
+ * Options to set the default theme
+ */
 export interface IThemeDefault {
+    /**
+     * If set to true, this theme will be switched when the mode matches the user OS theme
+     */
     auto: boolean;
+    /**
+     * Default theme mode
+     * `any`: Sets the default theme for every configuration
+     * `dark`: Sets the default theme when the user has dark mode set
+     * `light`: Sets the default theme when the user has light mode set
+     * If `dark` or `light` themes are set, the `any` default theme will be used only for unset modes
+     */
     mode: ThemeMode | keyof ThemeMode;
+    /**
+     * Sets or unsets the default flag to this theme and mode
+     */
     value: boolean;
 }

package/browser/Plugins/Absorbers/AbsorberInstance.d.ts

@@ -10,6 +10,9 @@ declare type OrbitingParticle = Particle & {
     absorberOrbitDirection?: RotateDirection;
     needsNewPosition?: boolean;
 };
+/**
+ * @category Absorbers Plugin
+ */
 export declare class AbsorberInstance {
     private readonly absorbers;
     private readonly container;

package/browser/Plugins/Absorbers/AbsorberInstance.js

@@ -1,6 +1,9 @@
 import { colorToRgb, getDistance, getDistances, getRangeValue, getStyleFromRgb, isPointInside } from "../../Utils";
 import { Vector } from "../../Core/Particle/Vector";
 import { RotateDirection } from "../../Enums";
+/**
+ * @category Absorbers Plugin
+ */
 export class AbsorberInstance {
     constructor(absorbers, container, options, position) {
         var _a, _b, _c;

package/browser/Plugins/Absorbers/Absorbers.d.ts

@@ -8,6 +8,9 @@ import type { SingleOrMultiple, RecursivePartial } from "../../Types";
 import type { IOptions } from "../../Options/Interfaces/IOptions";
 import type { IAbsorberOptions } from "./Options/Interfaces/IAbsorberOptions";
 import type { ICoordinates } from "../../Core/Interfaces/ICoordinates";
+/**
+ * @category Absorbers Plugin
+ */
 export declare class Absorbers implements IContainerPlugin {
     private readonly container;
     array: AbsorberInstance[];