tsparticles
Version:
Easily create highly customizable particle, confetti and fireworks animations and use them as animated backgrounds for your website. Ready to use components available also for React, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Riot.js, Inferno.
79 lines (78 loc) • 2.7 kB
TypeScript
import type { RangeValue, RecursivePartial } from "../../Types";
import { Background } from "./Background/Background";
import { BackgroundMask } from "./BackgroundMask/BackgroundMask";
import type { Engine } from "../../engine";
import { FullScreen } from "./FullScreen/FullScreen";
import type { IOptionLoader } from "../Interfaces/IOptionLoader";
import type { IOptions } from "../Interfaces/IOptions";
import { Interactivity } from "./Interactivity/Interactivity";
import { ManualParticle } from "./ManualParticle";
import { Motion } from "./Motion/Motion";
import { ParticlesOptions } from "./Particles/ParticlesOptions";
import { Responsive } from "./Responsive";
import { Theme } from "./Theme/Theme";
/**
* [[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;
backgroundMask: BackgroundMask;
detectRetina: boolean;
duration: RangeValue;
fpsLimit: number;
fullScreen: FullScreen;
interactivity: Interactivity;
manualParticles: ManualParticle[];
motion: Motion;
particles: ParticlesOptions;
pauseOnBlur: boolean;
pauseOnOutsideViewport: boolean;
preset?: string | string[];
style: RecursivePartial<CSSStyleDeclaration>;
responsive: Responsive[];
themes: Theme[];
zLayers: number;
defaultDarkTheme?: string;
defaultLightTheme?: string;
[name: string]: unknown;
constructor(engine: Engine);
/**
* 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): number | undefined;
private importPreset;
}