Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
tsparticles
Advanced tools
Easily create highly customizable particle 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.
tsParticles full bundle loads all the v1 features to
a @tsparticles/engine
instance.
Included Packages
The CDN/Vanilla version JS has two different files:
loadFull
function to load the tsParticles full preset, all dependencies must be
included manuallyIncluding the tsparticles.bundle.min.js
file will work exactly like v1
, you can start using the tsParticles
instance in the same way.
This is the easiest usage, since it's a single file with the same v1
features.
All new features will be added as external packages, this bundle is recommended for migrating from v1
easily.
This installation requires more work since all dependencies must be included in the page. Some lines above are all specified in the Included Packages section.
A note about @tsparticles/slim
can be made: it's not mandatory to include all of its dependencies, the slim bundle file
is enough, and if this is done the @tsparticles/engine
is not needed, since it's already bundled in the slim bundle.
Once the scripts are loaded you can set up tsParticles
like this:
(async () => {
await loadFull(tsParticles);
await tsParticles.load({
id: "tsparticles",
options: {
/* options */
},
});
})();
The syntax for React.js
, Preact
and Inferno
is the same.
This sample uses the class component syntax, but you can use hooks as well (if the library supports it).
Class Components
import React from "react";
import Particles from "react-particles";
import type { Engine } from "@tsparticles/engine";
import { loadFull } from "tsparticles";
export class ParticlesContainer extends PureComponent<unknown> {
// this customizes the component tsParticles installation
async customInit(engine: Engine): Promise<void> {
// this adds the bundle to tsParticles
await loadFull(engine);
}
render() {
const options = {
/* custom options */
};
return <Particles options={options} init={this.customInit} />;
}
}
Hooks / Functional Components
import React, { useCallback } from "react";
import Particles from "react-particles";
import type { Engine } from "@tsparticles/engine";
import { loadFull } from "tsparticles";
export function ParticlesContainer(props: unknown) {
// this customizes the component tsParticles installation
const customInit = useCallback(async (engine: Engine) => {
// this adds the bundle to tsParticles
await loadFull(engine);
});
const options = {
/* custom options */
};
return <Particles options={options} init={this.customInit} />;
}
The syntax for Vue.js 2.x
and 3.x
is the same
<Particles id="tsparticles" :particlesInit="particlesInit" :options="options" />
const options = {
/* custom options */
};
async function particlesInit(engine: Engine): Promise<void> {
await loadFull(engine);
}
<ng-particles [id]="id" [options]="options" [particlesInit]="particlesInit"></ng-particles>
const options = {
/* custom options */
};
async function particlesInit(engine: Engine): Promise<void> {
await loadFull(engine);
}
<Particles
id="tsparticles"
options={options}
particlesInit={particlesInit}
/>
let options = {
/* custom options */
};
let particlesInit = async (engine) => {
await loadFull(engine);
};
FAQs
Easily create highly customizable particle 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.
The npm package tsparticles receives a total of 40,219 weekly downloads. As such, tsparticles popularity was classified as popular.
We found that tsparticles demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.