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.
42 lines (41 loc) • 1.74 kB
TypeScript
/**
* [[include:pjsMigration.md]]
* @packageDocumentation
*/
import type { Container } from "./Core";
import type { Engine } from "./engine";
import type { IOptions } from "./Options/Interfaces/IOptions";
import type { RecursivePartial } from "./Types";
/**
* [[include:pjsMigration.md]]
* @category Particles.js
*/
export interface IParticlesJS {
/**
* Loads the provided options to create a [[Container]] object.
* @deprecated this method is obsolete, please use the new tsParticles.load
* @param tagId the particles container element id
* @param options the options object to initialize the [[Container]]
*/
(tagId: string, options: RecursivePartial<IOptions>): Promise<Container | undefined>;
/**
* Loads the provided json with a GET request.
* The content will be used to create a [[Container]] object.
* @deprecated this method is obsolete, please use the new tsParticles.loadJSON
* @param tagId the particles container element id
* @param pathConfigJson the json path to use in the GET request
* @param callback called after the [[Container]] is loaded and it will be passed as a parameter
*/
load(tagId: string, pathConfigJson: string, callback: (container?: Container) => void): void;
/**
* Adds an additional click handler to all the loaded [[Container]] objects.
* @deprecated this method is obsolete, please use the new tsParticles.setOnClickHandler
* @param callback the function called after the click event is fired
*/
setOnClickHandler(callback: EventListenerOrEventListenerObject): void;
}
declare const initPjs: (engine: Engine) => {
particlesJS: IParticlesJS;
pJSDom: Container[];
};
export { initPjs };