tsparticles-slim
Advanced tools
Changelog
2.10.0 (2023-06-03)
Readme
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:
loadSlim(tsParticles); // not needed if using the bundle script, required for any other installation
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-tsparticles";
import type { Engine } from "tsparticles-engine";
import { loadSlim } from "tsparticles-slim";
export class ParticlesContainer extends PureComponent<unknown> {
// this customizes the component tsParticles installation
customInit(engine: Engine) {
// this adds the bundle to tsParticles
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-tsparticles";
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((engine: Engine) => {
// this adds the bundle to tsParticles
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" url="http://foo.bar/particles.json" />
function particlesInit(engine: Engine) {
loadSlim(engine);
}
<ng-particles
[id]="id"
[options]="particlesOptions"
(particlesLoaded)="particlesLoaded($event)"
(particlesInit)="particlesInit($event)"
></ng-particles>
function particlesInit(engine: Engine): void {
loadSlim(engine);
}
<Particles
id="tsparticles"
url="http://foo.bar/particles.json"
on:particlesInit="{onParticlesInit}"
/>
let onParticlesInit = (engine) => {
loadSlim(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.
We found that tsparticles-slim demonstrated a healthy version release cadence and project activity because the last version was released less than 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
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.