Interface IPlugin

[[include:Plugins.md]]

interface IPlugin {
    id: string;
    loadParticlesOptions?: (
        container: Container,
        options: ParticlesOptions,
        source?: RecursivePartial<IParticlesOptions>,
    ) => void;
    getPlugin(container: Container): Promise<IContainerPlugin>;
    loadOptions(
        container: Container,
        options: Options,
        source?: RecursivePartial<IOptions>,
    ): void;
    needsPlugin(options?: RecursivePartial<IOptions>): boolean;
}

Index

Properties

id loadParticlesOptions?

Methods

getPlugin loadOptions needsPlugin

Properties

`Readonly`id

id: string

The unique identifier for this plugin

`Optional`loadParticlesOptions

loadParticlesOptions?: (
    container: Container,
    options: ParticlesOptions,
    source?: RecursivePartial<IParticlesOptions>,
) => void

Loads options for particles, called when building particle options

Methods

getPlugin

getPlugin(container: Container): Promise<IContainerPlugin>
Gets the container plugin instance for the given container
Parameters
- container: Container
Returns Promise<IContainerPlugin>
A promise
- Defined in Core/Interfaces/IPlugin.ts:27

loadOptions

loadOptions(
    container: Container,
    options: Options,
    source?: RecursivePartial<IOptions>,
): void
Loads the plugin options into the given options object
Parameters
- container: Container
- options: Options
- Optionalsource: RecursivePartial<IOptions>
Returns void
- Defined in Core/Interfaces/IPlugin.ts:30

needsPlugin

needsPlugin(options?: RecursivePartial<IOptions>): boolean
Checks if this plugin is needed for the given options
Parameters
- Optionaloptions: RecursivePartial<IOptions>
Returns boolean
The boolean value
- Defined in Core/Interfaces/IPlugin.ts:36