UNPKG

1.74 kBTypeScriptView Raw
1/**
2 * [[include:pjsMigration.md]]
3 * @packageDocumentation
4 */
5import type { IOptions } from "./Options/Interfaces/IOptions";
6import type { Container } from "./Core/Container";
7import type { Main } from "./main";
8import type { RecursivePartial } from "./Types";
9/**
10 * [[include:pjsMigration.md]]
11 * @category Particles.js
12 */
13export interface IParticlesJS {
14 /**
15 * Loads the provided options to create a [[Container]] object.
16 * @deprecated this method is obsolete, please use the new tsParticles.load
17 * @param tagId the particles container element id
18 * @param options the options object to initialize the [[Container]]
19 */
20 (tagId: string, options: RecursivePartial<IOptions>): Promise<Container | undefined>;
21 /**
22 * Loads the provided json with a GET request.
23 * The content will be used to create a [[Container]] object.
24 * @deprecated this method is obsolete, please use the new tsParticles.loadJSON
25 * @param tagId the particles container element id
26 * @param pathConfigJson the json path to use in the GET request
27 * @param callback called after the [[Container]] is loaded and it will be passed as a parameter
28 */
29 load(tagId: string, pathConfigJson: string, callback: (container?: Container) => void): void;
30 /**
31 * Adds an additional click handler to all the loaded [[Container]] objects.
32 * @deprecated this method is obsolete, please use the new tsParticles.setOnClickHandler
33 * @param callback the function called after the click event is fired
34 */
35 setOnClickHandler(callback: EventListenerOrEventListenerObject): void;
36}
37declare const initPjs: (main: Main) => {
38 particlesJS: IParticlesJS;
39 pJSDom: Container[];
40};
41export { initPjs };