https://github.com/tsparticles/solid
Solid.js tsParticles official component
https://github.com/tsparticles/solid
hacktoberfest javascript solid tsparticles typescript
Last synced: 2 months ago
JSON representation
Solid.js tsParticles official component
- Host: GitHub
- URL: https://github.com/tsparticles/solid
- Owner: tsparticles
- License: mit
- Created: 2022-11-11T00:34:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T06:54:16.000Z (3 months ago)
- Last Synced: 2025-04-01T07:38:06.553Z (3 months ago)
- Topics: hacktoberfest, javascript, solid, tsparticles, typescript
- Language: TypeScript
- Homepage:
- Size: 855 KB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-solid-js - Solid Particles - Particles, confetti, fireworks and more animations
README
[](https://particles.js.org)
# @tsparticles/solid
[](https://www.npmjs.com/package/@tsparticles/solid) [](https://www.npmjs.com/package/@tsparticles/solid) [](https://github.com/sponsors/matteobruni)
Official [tsParticles](https://github.com/matteobruni/tsparticles) solid component
[](https://join.slack.com/t/tsparticles/shared_invite/enQtOTcxNTQxNjQ4NzkxLWE2MTZhZWExMWRmOWI5MTMxNjczOGE1Yjk0MjViYjdkYTUzODM3OTc5MGQ5MjFlODc4MzE0N2Q1OWQxZDc1YzI) [](https://discord.gg/hACwv45Hme) [](https://t.me/tsparticles)
[](https://www.producthunt.com/posts/tsparticles?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-tsparticles") 
## Installation
```shell
npm install @tsparticles/solid
```
or
```shell
yarn add @tsparticles/solid
```
## How to use
### Code
Examples:
_Remote url_
```javascript
import Particles from "@tsparticles/solid";
function App() {
const [ init, setInit ] = createSignal(false);
createEffect(() => {
if (init()) {
return;
}
initParticlesEngine(async (engine) => {
// this loads the tsparticles package bundle, it's the easiest method for getting everything ready
// starting from v2 you can add only the features you need reducing the bundle size
await loadFull(engine);
}).then(() => {
setInit(true);
})
});
return (
{init() && }
);
}
```
_Options object_
```javascript
import Particles from "@tsparticles/solid";
function App() {
const [ init, setInit ] = createSignal(false);
createEffect(() => {
if (init()) {
return;
}
initParticlesEngine(async (engine) => {
// this loads the tsparticles package bundle, it's the easiest method for getting everything ready
// starting from v2 you can add only the features you need reducing the bundle size
await loadFull(engine);
}).then(() => {
setInit(true);
})
});
return (
{init() && }
);
}
```
### Props
| Prop | Type | Definition |
|-----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| id | string | The id of the element. |
| width | string | The width of the canvas. |
| height | string | The height of the canvas. |
| options | object | The options of the particles instance. |
| url | string | The remote options url, called using an AJAX request |
| style | object | The style of the canvas element. |
| className | string | The class name of the canvas wrapper. |
| canvasClassName | string | the class name of the canvas. |
| container | object | The instance of the [particles container](https://particles.js.org/docs/modules/Core_Container.html) |
| particlesloaded | function | This function is called when particles are correctly loaded in canvas, the current container is the parameter and you can customize it here |
Find your parameters configuration [here](https://particles.js.org).
## Demos
You can see the official sample created using CodeSandbox [here](https://codesandbox.io/s/condescending-dan-7e0r9)
The demo website is [here](https://particles.js.org)
There's also a CodePen collection actively maintained and updated [here](https://codepen.io/collection/DPOage)