Merge pull request #991 from matteobruni/docs

Docs Fix
tsparticles · Oct 30, 2020 · 4c04253 · 4c04253
2 parents 671ea54 + 034a9fb
commit 4c04253
Show file tree

Hide file tree

Showing 26 changed files with 57 additions and 52 deletions.
diff --git a/components/inferno/tsconfig.json b/components/inferno/tsconfig.json
@@ -2,7 +2,7 @@
 	"compilerOptions": {
 		"pretty": true,
 		"target": "es6",
-		"module": "commonjs",
+		"module": "umd",
 		"allowSyntheticDefaultImports": true,
 		"preserveConstEnums": true,
 		"sourceMap": true,

diff --git a/components/jquery/tsconfig.json b/components/jquery/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/components/preact/tsconfig.json b/components/preact/tsconfig.json
@@ -2,9 +2,10 @@
   "compilerOptions": {
     "sourceMap": true,
     "noImplicitAny": true,
-    "module": "commonjs",
+    "module": "umd",
     "target": "es6",
     "jsx": "react",
+    "moduleResolution": "node",
     "removeComments": true,
     "esModuleInterop": true,
     "importHelpers": false

diff --git a/components/react/tsconfig.json b/components/react/tsconfig.json
@@ -2,9 +2,10 @@
   "compilerOptions": {
     "sourceMap": true,
     "noImplicitAny": true,
-    "module": "commonjs",
+    "module": "umd",
     "target": "es6",
     "jsx": "react",
+    "moduleResolution": "node",
     "removeComments": true,
     "esModuleInterop": true,
     "importHelpers": false

diff --git a/components/vue/tsconfig.json b/components/vue/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "es2015",
-    "module": "es2015",
+    "module": "umd",
     "strict": true,
     "jsx": "preserve",
     "importHelpers": true,

diff --git a/components/vue3/tsconfig.json b/components/vue3/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "es2015",
-    "module": "es2015",
+    "module": "umd",
     "strict": true,
     "jsx": "preserve",
     "importHelpers": true,

diff --git a/core/editor/tsconfig.json b/core/editor/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es2015",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "commonjs",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/core/main/markdown/Options/Infection.md b/core/main/markdown/Options/Infection.md
@@ -1,19 +1,19 @@
 # Infection
 
-| key | option type | example | notes |
-| --- | --- | --- | --- |
-| `cure` | `boolean` | `true` / `false` | if the infection can be cured, bringing back the particle to its normal state |
-| `delay` | `number` | `1` | the "symptoms" delay, after how many seconds the infected particle change its state |
-| `enable` | `boolean` | `true` / `false` | |
-| `infections` | `number` | `1` | how many particles are infected at startup |
-| `stages` | `array` | | |
+| key          | option type | example          | notes                                                                               |
+| ------------ | ----------- | ---------------- | ----------------------------------------------------------------------------------- |
+| `cure`       | `boolean`   | `true` / `false` | if the infection can be cured, bringing back the particle to its normal state       |
+| `delay`      | `number`    | `1`              | the "symptoms" delay, after how many seconds the infected particle change its state |
+| `enable`     | `boolean`   | `true` / `false` |                                                                                     |
+| `infections` | `number`    | `1`              | how many particles are infected at startup                                          |
+| `stages`     | `array`     |                  |                                                                                     |
 
 ## Infection Stage
 
-| key | option type | example | notes |
-| --- | --- | --- | --- |
-| `color` | `color object` | | This `color` object is the same described {@link IColor | here} |
-| `radius` | `number` | `1` | an outer radius for spreading the infection without touch |
-| `rate` | `number` | `1` | chances of infecting other particles |
-| `duration` | `number` | `1` | how many seconds does the stage should last |
-| `infectedStage` | `number` | `0` | which stage should be set when a particle will be infected by another at this stage |
+| key             | option type    | example | notes                                                                               |
+| --------------- | -------------- | ------- | ----------------------------------------------------------------------------------- |
+| `color`         | `color object` |         | This `color` object is the same described {@link IColor | here}                     |
+| `radius`        | `number`       | `1`     | an outer radius for spreading the infection without touch                           |
+| `rate`          | `number`       | `1`     | chances of infecting other particles                                                |
+| `duration`      | `number`       | `1`     | how many seconds does the stage should last                                         |
+| `infectedStage` | `number`       | `0`     | which stage should be set when a particle will be infected by another at this stage |
diff --git a/core/main/markdown/Options/Particles.md b/core/main/markdown/Options/Particles.md
@@ -1,16 +1,19 @@
 # Particles
 
-| key          | option type | notes                                                              |
-| ------------ | ----------- | ------------------------------------------------------------------ |
-| `collisions` | `object`    | See Particles Collisions documentation {@link ICollisions | here}  |
-| `color`      | `object`    | See Particles Color documentation {@link IAnimatableColor | here}  |
-| `links`      | `object`    | See Particles Links documentation {@link ILinks | here}            |
-| `move`       | `object`    | See Particles Move documentation {@link IMove | here}              |
-| `number`     | `object`    | See Particles Number documentation {@link IParticlesNumber | here} |
-| `opacity`    | `object`    | See Particles Opacity documentation {@link IOpacity | here}        |
-| `rotate`     | `object`    | See Particles Rotate documentation {@link IRotate | here}          |
-| `shadow`     | `object`    | See Shape documentation {@link IShadow | here}                     |
-| `shape`      | `object`    | See Shape documentation {@link IShape | here}                      |
-| `size`       | `object`    | See Particles Size documentation {@link ISize | here}              |
-| `stroke`     | `object`    | See Particles Stroke documentation {@link IStroke | here}          |
-| `twinkle`    | `object`    | See Particles Twinkle documentation {@link ITwinkle | here}        |
+| key                | option type | example          | notes                                                                      |
+| ------------------ | ----------- | ---------------- | -------------------------------------------------------------------------- |
+| `bounce`           | `object`    |                  | See Particles Bounce documentation {@link IBounce | here}                  |
+| `collisions`       | `object`    |                  | See Particles Collisions documentation {@link ICollisions | here}          |
+| `color`            | `object`    |                  | See Particles Color documentation {@link IAnimatableColor | here}          |
+| `life`             | `object`    |                  | See Particles Life documentation {@link ILife | here}                      |
+| `links`            | `object`    |                  | See Particles Links documentation {@link ILinks | here}                    |
+| `move`             | `object`    |                  | See Particles Move documentation {@link IMove | here}                      |
+| `number`           | `object`    |                  | See Particles Number documentation {@link IParticlesNumber | here}         |
+| `opacity`          | `object`    |                  | See Particles Opacity documentation {@link IOpacity | here}                |
+| `reduceDuplicates` | `boolean`   | `true` / `false` | Reduces particles duplicates, picking particles configuration sequentially |
+| `rotate`           | `object`    |                  | See Particles Rotate documentation {@link IRotate | here}                  |
+| `shadow`           | `object`    |                  | See Shape documentation {@link IShadow | here}                             |
+| `shape`            | `object`    |                  | See Shape documentation {@link IShape | here}                              |
+| `size`             | `object`    |                  | See Particles Size documentation {@link ISize | here}                      |
+| `stroke`           | `object`    |                  | See Particles Stroke documentation {@link IStroke | here}                  |
+| `twinkle`          | `object`    |                  | See Particles Twinkle documentation {@link ITwinkle | here}                |
diff --git a/core/main/tsconfig.json b/core/main/tsconfig.json
@@ -5,7 +5,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es2015",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "commonjs",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     // "lib": [
     //  "ES2015",

diff --git a/demo/preact/package.json b/demo/preact/package.json
@@ -17,7 +17,7 @@
     ]
   },
   "scripts": {
-    "build": "npx copyfiles -a ../../node_modules/preact/* ./node_modules/preact/ && npx copyfiles -a ../../node_modules/preact/**/* ./node_modules/preact/ && npx copyfiles -a ../../node_modules/preact-render-to-string/* ./node_modules/preact-render-to-string/ && npx copyfiles -a ../../node_modules/preact-render-to-string/**/* ./node_modules/preact-render-to-string/ && npx preact build",
+    "build": "npx copyfiles -a ../../node_modules/preact/* ./node_modules/preact/ && npx copyfiles -a ../../node_modules/preact/**/* ./node_modules/preact/ && npx copyfiles -a ../../node_modules/preact-render-to-string/* ./node_modules/preact-render-to-string/ && npx copyfiles -a ../../node_modules/preact-render-to-string/**/* ./node_modules/preact-render-to-string/ && npx preact build --no-prerender",
     "start": "sirv build --cors --single",
     "dev": "preact watch",
     "lint": "eslint src"

diff --git a/demo/react/tsconfig.json b/demo/react/tsconfig.json
@@ -3,7 +3,7 @@
     /* Basic Options */
     "target": "es2015",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-    "module": "commonjs",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     // "lib": [],                             /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */

diff --git a/presets/60fps/tsconfig.json b/presets/60fps/tsconfig.json
@@ -3,7 +3,7 @@
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "module": "umd",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",
       "DOM"

diff --git a/presets/backgroundMask/tsconfig.json b/presets/backgroundMask/tsconfig.json
@@ -3,7 +3,7 @@
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "module": "umd",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",
       "DOM"

diff --git a/presets/basic/tsconfig.json b/presets/basic/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/presets/bigCircles/tsconfig.json b/presets/bigCircles/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/presets/bouncing/tsconfig.json b/presets/bouncing/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/presets/fire/tsconfig.json b/presets/fire/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/presets/fontAwesome/tsconfig.json b/presets/fontAwesome/tsconfig.json
@@ -3,7 +3,7 @@
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "module": "umd",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",
       "DOM"

diff --git a/presets/fountain/tsconfig.json b/presets/fountain/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/presets/snow/tsconfig.json b/presets/snow/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/presets/stars/tsconfig.json b/presets/stars/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/shapes/bubble/tsconfig.json b/shapes/bubble/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/shapes/heart/tsconfig.json b/shapes/heart/tsconfig.json
@@ -3,7 +3,7 @@
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "module": "umd",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",
       "DOM"

diff --git a/shapes/multiline-text/tsconfig.json b/shapes/multiline-text/tsconfig.json
@@ -4,7 +4,7 @@
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",
+    "module": "umd",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",

diff --git a/shapes/spiral/tsconfig.json b/shapes/spiral/tsconfig.json
@@ -3,7 +3,7 @@
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "es6",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "module": "umd",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": [
       "ES2015",
       "DOM"