party-js
Version:
A JavaScript library to brighten up your user's site experience with visual effects!
35 lines (34 loc) • 989 B
TypeScript
/**
* Represents global settings used throughout the library.
*/
export interface Settings {
/**
* Whether the debugging mode should be enabled.
*
* @defaultValue false
*/
debug: boolean;
/**
* The amount of gravity to apply to particles in the scene, in pixels.
* Note that this value is positive by default, since the y-axis increases
* downwards in a DOM.
*
* @defaultValue 800
*/
gravity: number;
/**
* The z-index to place the DOM containers at.
*
* @defaultValue 99999
*/
zIndex: number;
/**
* Whether or not to respect the "prefers-reduced-motion" media query, in
* case users do not want particle effects flying around their screen. Note
* that this has to be set **before** the library initializes the renderer.
*
* @defaultValue true
*/
respectReducedMotion: boolean;
}
export declare const settings: Settings;