shouldDestroyAfterDone -> destroyAfterDone (#12)

PuruVJ · Dec 18, 2023 · 95aaafe · 95aaafe
1 parent a933eb4
commit 95aaafe
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -165,7 +165,7 @@ Width of the stage in pixels. Confetti will only fall within this width.
 <ConfettiExplosion stageWidth={500} />
 ```
 
-### shouldDestroyAfterDone
+### destroyAfterDone
 
 Whether or not destroy all confetti nodes after the `duration` period has passed. By default it destroys all nodes, to free up memory.
 
@@ -176,7 +176,7 @@ Whether or not destroy all confetti nodes after the `duration` period has passed
 **Example:**
 
 ```svelte
-<ConfettiExplosion shouldDestroyAfterDone={false} />
+<ConfettiExplosion destroyAfterDone={false} />
 ```
 
 ## Style Props
@@ -199,7 +199,7 @@ You can specify two style props on the component: `--x` and `--y`. These will sh
 
 This library functions by creating 2 DOM nodes for every single confetti. By default, if the `particlesCount` is set to 150, it will create 300 nodes. This is a lot of nodes. For most devices, these many nodes are not a big issue, but I recommend checking your target devices' performance if you choose to go with a higher number, like 400 or 500.
 
-Also, after the specified `duration`, all the confetti DOM nodes will be destroyed. This is to free up memory. If you wish to keep them around, set `shouldDestroyAfterDone` to `false`.
+Also, after the specified `duration`, all the confetti DOM nodes will be destroyed. This is to free up memory. If you wish to keep them around, set `destroyAfterDone` to `false`.
 
 ## License
 

diff --git a/packages/core/demo/src/lib/Counter.svelte b/packages/core/demo/src/lib/Counter.svelte
@@ -22,6 +22,6 @@
 	<div use:confetti={{ destroyAfterDone: false, colors }} />
 {/if}
 
-<!-- <ConfettiExplosion shouldDestroyAfterDone={false} particleCount={4} /> -->
+<!-- <ConfettiExplosion destroyAfterDone={false} particleCount={4} /> -->
 <style>
 </style>
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -211,7 +211,7 @@ export function confetti(node: HTMLElement, options: ConfettiOptions = {}) {
 				nodes = createParticleNodes(node, particles);
 			}
 
-			// Dont destroy component if shouldDestroyAfterDone is false now
+			// Dont destroy component if destroyAfterDone is false now
 			if (destroyAfterDone && !newOptions.destroyAfterDone) clearTimeout(timer);
 
 			// Update stageHeight

diff --git a/packages/svelte/README.md b/packages/svelte/README.md
@@ -74,7 +74,7 @@ Size of the confetti particles in pixels
 **Example:**
 
 ```svelte
-<div use:confetti={{ particleSize:20 }} />
+<div use:confetti={{ particleSize: 20 }} />
 ```
 
 ### particleShape
@@ -165,7 +165,7 @@ Width of the stage in pixels. Confetti will only fall within this width.
 <div use:confetti={{ stageWidth: 500 }} />
 ```
 
-### shouldDestroyAfterDone
+### destroyAfterDone
 
 Whether or not destroy all confetti nodes after the `duration` period has passed. By default it destroys all nodes, to free up memory.