tsparticles-slim
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 slim bundle loads some of the most used features to
a tsparticles-engine instance.
Included Packages
The CDN/Vanilla version JS has two different files:
loadSlim function to load the tsParticles slim preset, all dependencies must be
included manuallyIncluding the tsparticles.slim.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 some of the 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.
Once the scripts are loaded you can set up tsParticles like this:
(async () => {
await loadSlim(tsParticles); // not needed if using the bundle script, required for any other installation
await tsParticles.load("tsparticles", {
/* 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 { loadSlim } from "tsparticles-slim";
export class ParticlesContainer extends PureComponent<unknown> {
// this customizes the component tsParticles installation
async customInit(engine: Engine) {
// this adds the bundle to tsParticles
await loadSlim(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 { loadSlim } from "tsparticles-slim";
export function ParticlesContainer(props: unknown) {
// this customizes the component tsParticles installation
const customInit = useCallback(async (engine: Engine) => {
// this adds the bundle to tsParticles
await loadSlim(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) {
await loadSlim(engine);
}
<ng-particles [id]="id" [options]="options" [particlesInit]="particlesInit"></ng-particles>
const options = {
/* custom options */
};
async function particlesInit(engine: Engine): void {
await loadSlim(engine);
}
<Particles
id="tsparticles"
options={options}
particlesInit="{particlesInit}"
/>
let options = {
/* custom options */
};
let particlesInit = async (engine) => {
await loadSlim(engine);
};
2.10.0 (2023-06-03)
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-slim receives a total of 17,039 weekly downloads. As such, tsparticles-slim popularity was classified as popular.
We found that tsparticles-slim demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 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
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.