Sets if the animations should start automatically or manually
Background options, these background options will be used to the canvas element, they are all CSS properties
Background Mask options, what's behind the canvas will become hidden and particles will uncover it
Sets the animated background mode for particles canvas bringing it to the back
use the new fullScreen instead
The initial delay before starting the animation
Enables the retina detection, if disabled the ratio used by canvas will be always 1 and not the device setting.
The Particles effect duration in seconds, then the container will be destroyed
The FPS (Frame Per Second) limit applied to all particles animations.
The Frame Per Second limit applied to all particles animations.
use the new fpsLimit instead
Sets the animated background mode for particles canvas bringing it to the back
The particles interaction options
Particles inserted at load time with a specific position
The particles options
Enables or disabled the animation on window blur
Enable or disabled the animation if the element is outside the viewport
Optional presetThis property will be used to add specified presets to the options
This sets custom options based on canvas size
Enables the retina detection, if disabled the ratio used by canvas will be always 1 and not the device setting.
use the new detectRetina instead
Enables a smooth effect, by default it's disabled When enabled the animation will speed up or slow down depending on fps The fpsLimit field will be used as a reference for the animation speed Some examples: - with a fpsLimit of 60 the animation will be twice faster on 120 fps devices - with a fpsLimit of 120 the animation will be twice slower on 60 fps devices The animation will be always smooth, but the behavior could be affected by the user screen refresh rate It's recommended to keep this disabled, be careful.
User-defined themes that can be retrieved by the particles Container
The maximum layers used in the z-axis
The Options interface, defines all the options that can be used by
tsParticlesOptions
| property | option type | example | notes | | ------------------------ | -------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | |
autoPlay|boolean|true/false| | |background|object| | See Background options {@link IBackground | here} | |backgroundMask|object| | See Background Mask options {@link IBackgroundMask | here} | |detectRetina|boolean|true/false| Replaces the oldretina_detectproperty | |duration|number/range|60/{ min: 30, max: 90 }| The particles effect duration in seconds | |fpsLimit|number|60| Defaults to60, replaces the oldfps_limitproperty | |fullScreen|object/boolean| {@link IFullScreen} ortrue/false| See Full Screen options {@link IFullScreen | here} | |interactivity|object| | See Interactivity options {@link IInteractivity | here} | |manualParticles|array| | An array of Manual Particles object. See Manual Particles documentation {@link IManualParticle | here} | |motion|object| | See Motion options {@link IMotion | here} | |particles|object| | See Particles options {@link IParticlesOptions | here} | |pauseOnBlur|boolean|true/false| Pauses the animations when the page isn't on foreground | |pauseOnOutsideViewport|boolean|true/false| Pauses the animations when the element is out of the viewport | |preset|string/array|"basic"[ "links", "confetti" ]| You can use this property to load one or more presets for focusing on important properties and not all config. You can find presets onnpmhere | |responsive|array| | See Responsive options {@link IResponsive | here} | |themes|array| | It's an array of Theme object, you can see the structure {@link ITheme | here } |Plugins
These options are not part of the slim bundle
| property | option type | example | notes | | ------------- | ------------------ | ------- | ----------------------------------------- | ----- | |
absorbers|object/array| | See Absorbers options {@link IAbsorber | here} | |emitters|object/array| | See Emitter options {@link IEmitter | here} | |polygonMask|object| | See Particles options {@link IPolygonMask | here} |