Skip to content

Commit

Permalink
fix: updated all mermaid charts in the readme files, closes #4763
Browse files Browse the repository at this point in the history
  • Loading branch information
matteobruni committed Nov 8, 2022
1 parent e0e077a commit eac8139
Show file tree
Hide file tree
Showing 8 changed files with 92 additions and 51 deletions.
31 changes: 25 additions & 6 deletions README.md
@@ -1,4 +1,4 @@
[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)
**[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)

# tsParticles - TypeScript Particles

Expand Down Expand Up @@ -639,7 +639,8 @@ cso[Solid.js]
csv[Svelte]
cv2[Vue.js 2.x]
cv3[Vue.js 3.x]
cw[Web Components]
cwc[Web Components]
cwp[WordPress]
end
e[tsParticles Engine] --> c
Expand All @@ -655,14 +656,15 @@ end
e[tsParticles Engine] --> b
iea & iebo & iebu & iec & ieg & iepa & iepu & ierem & ierep --> bs
iea & iebo & iebu & iec & ieg & iepa & iepu & ierem & ierep & ies --> bs
ipa & ipc & ipl --> bs
mb & mp --> bs
ple4 --> bs
sc & si & sl & sp & ssq & sst & st --> bs
ua & uc & ul & uop & uou & usi & ust --> bs
iet --> bf
pla & ple & plp --> bf
pla & plem --> bf
ur & uti & utw & uw --> bf
subgraph i [Interactions]
Expand All @@ -677,6 +679,7 @@ iepa[Pause]
iepu[Push]
ierem[Remove]
ierep[Repulse]
ies[Slow]
iet[Trail]
end
Expand Down Expand Up @@ -714,11 +717,26 @@ e --> pa
subgraph pl [Plugins]
pla[Absorbers]
ple[Emitters]
plem[Emitters]
plh[HSV Color]
pli[Infection]
plm[Motion]
plp[Polygon Mask]
subgraph plea [Easings]
pleb[Back]
pleci[Circ]
plecu[Cubic]
plee[Expo]
ple4[Quad]
ple5[Quint]
ples[Sine]
end
end
pl --> plea
e --> pl
subgraph s [Shapes]
Expand All @@ -741,6 +759,7 @@ e --> s
subgraph u [Updaters]
ua[Angle]
uc[Color]
ud[Destroy]
ug[Gradient]
ul[Life]
uop[Opacity]
Expand Down Expand Up @@ -805,4 +824,4 @@ code.
**Automate code reviews on your commits and pull requests**

Check your code quality and keep track of your technical debt for more than 40 programming languages. Seamlessly
integrated within your development workflow.
integrated within your development workflow.**
70 changes: 35 additions & 35 deletions bundles/full/README.md
Expand Up @@ -51,11 +51,11 @@ Once the scripts are loaded you can set up `tsParticles` like this:

```javascript
(async () => {
await loadFull(tsParticles); // not needed if using the bundle script, required for any other installation
await loadFull(tsParticles); // not needed if using the bundle script, required for any other installation

await tsParticles.load("tsparticles", {
/* options */
});
await tsParticles.load("tsparticles", {
/* options */
});
})();
```

Expand All @@ -74,19 +74,19 @@ 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} />;
}
// 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}/>;
}
}
```

Expand All @@ -99,17 +99,17 @@ 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);
});
// 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 */
};
const options = {
/* custom options */
};

return <Particles options={options} init={this.customInit} />;
return <Particles options={options} init={this.customInit}/>;
}
```

Expand All @@ -118,41 +118,41 @@ export function ParticlesContainer(props: unknown) {
_The syntax for `Vue.js 2.x` and `3.x` is the same_

```vue
<Particles id="tsparticles" :particlesInit="particlesInit" :options="options" />
<Particles id="tsparticles" :particlesInit="particlesInit" :options="options"/>
```

```js
const options = {
/* custom options */
/* custom options */
};

async function particlesInit(engine: Engine): Promise<void> {
await loadFull(engine);
await loadFull(engine);
}
```

### Angular

```html

<ng-particles [id]="id" [options]="options" [particlesInit]="particlesInit"></ng-particles>
```

```ts
const options = {
/* custom options */
/* custom options */
};

async function particlesInit(engine: Engine): Promise<void> {
await loadFull(engine);
await loadFull(engine);
}
```

### Svelte

```sveltehtml
<script>
</script>
<Particles
id="tsparticles"
options={options}
Expand All @@ -162,10 +162,10 @@ async function particlesInit(engine: Engine): Promise<void> {

```js
let options = {
/* custom options */
/* custom options */
};

let particlesInit = async (engine) => {
await loadFull(engine);
await loadFull(engine);
};
```
27 changes: 23 additions & 4 deletions engine/README.md
Expand Up @@ -639,7 +639,8 @@ cso[Solid.js]
csv[Svelte]
cv2[Vue.js 2.x]
cv3[Vue.js 3.x]
cw[Web Components]
cwc[Web Components]
cwp[WordPress]
end
e[tsParticles Engine] --> c
Expand All @@ -655,14 +656,15 @@ end
e[tsParticles Engine] --> b
iea & iebo & iebu & iec & ieg & iepa & iepu & ierem & ierep --> bs
iea & iebo & iebu & iec & ieg & iepa & iepu & ierem & ierep & ies --> bs
ipa & ipc & ipl --> bs
mb & mp --> bs
ple4 --> bs
sc & si & sl & sp & ssq & sst & st --> bs
ua & uc & ul & uop & uou & usi & ust --> bs
iet --> bf
pla & ple & plp --> bf
pla & plem --> bf
ur & uti & utw & uw --> bf
subgraph i [Interactions]
Expand All @@ -677,6 +679,7 @@ iepa[Pause]
iepu[Push]
ierem[Remove]
ierep[Repulse]
ies[Slow]
iet[Trail]
end
Expand Down Expand Up @@ -714,11 +717,26 @@ e --> pa
subgraph pl [Plugins]
pla[Absorbers]
ple[Emitters]
plem[Emitters]
plh[HSV Color]
pli[Infection]
plm[Motion]
plp[Polygon Mask]
subgraph plea [Easings]
pleb[Back]
pleci[Circ]
plecu[Cubic]
plee[Expo]
ple4[Quad]
ple5[Quint]
ples[Sine]
end
end
pl --> plea
e --> pl
subgraph s [Shapes]
Expand All @@ -741,6 +759,7 @@ e --> s
subgraph u [Updaters]
ua[Angle]
uc[Color]
ud[Destroy]
ug[Gradient]
ul[Life]
uop[Opacity]
Expand Down
5 changes: 4 additions & 1 deletion presets/confetti/README.md
Expand Up @@ -419,6 +419,7 @@ e[tsParticles Engine] --> m
subgraph pl [Plugins]
ple[Emitters]
plm[Motion]
end
e --> pl
Expand All @@ -433,8 +434,10 @@ e --> s
subgraph u [Updaters]
ua[Angle]
uc[Color]
ul[Life]
uop[Opacity]
uou[Out Modes]
ur[Roll]
usi[Size]
uti[Tilt]
uw[Wobble]
Expand All @@ -446,5 +449,5 @@ subgraph pr [Presets]
prc[Confetti]
end
mb & ple & sc & ssq & ua & uc & uop & uou & usi & uti & uw --> prc
mb & ple & plm & sc & ssq & ua & uc & ul & uop & uou & ur & usi & uti & uw --> prc
```
3 changes: 2 additions & 1 deletion presets/fireworks/README.md
Expand Up @@ -192,6 +192,7 @@ e --> s
subgraph u [Updaters]
ua[Angle]
uc[Color]
ud[Destroy]
ul[Life]
uop[Opacity]
uou[Out Modes]
Expand All @@ -207,5 +208,5 @@ end
e --> pr
mb & ple & sc & sl & ua & uc & ul & uop & uou & usi & ust --> prfw
mb & ple & sc & sl & ua & uc & ud & ul & uop & uou & usi & ust --> prfw
```
3 changes: 2 additions & 1 deletion presets/fountain/README.md
Expand Up @@ -187,6 +187,7 @@ e --> s
subgraph u [Updaters]
uc[Color]
ud[Destroy]
uop[Opacity]
uou[Out Modes]
usi[Size]
Expand All @@ -200,5 +201,5 @@ end
e --> pr
mb & ple & sc & uc & uop & uou & usi --> prfo
mb & ple & sc & uc & ud & uop & uou & usi --> prfo
```
2 changes: 0 additions & 2 deletions presets/links/README.md
Expand Up @@ -183,8 +183,6 @@ end
e --> m
e --> pa
subgraph s [Shapes]
sc[Circle]
end
Expand Down
2 changes: 1 addition & 1 deletion presets/snow/README.md
Expand Up @@ -164,7 +164,7 @@ let particlesInit = async (engine) => {
---

```mermaid
flowchart LR
flowchart TD
e[tsParticles Engine]
Expand Down

0 comments on commit eac8139

Please sign in to comment.