Merge pull request #624 from VisActor/fix/default-stop-param

Fix/default stop param
VisActor · Feb 13, 2025 · 4dced23 · 4dced23
2 parents 9d53188 + 0302479
commit 4dced23
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/common/changes/@visactor/vgrammar-core/fix-default-stop-param_2025-01-26-09-43.json b/common/changes/@visactor/vgrammar-core/fix-default-stop-param_2025-01-26-09-43.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@visactor/vgrammar-core",
+      "comment": "fix: fix default param for animator stop",
+      "type": "none"
+    }
+  ],
+  "packageName": "@visactor/vgrammar-core"
+}
diff --git a/packages/vgrammar-core/src/graph/animation/animate.ts b/packages/vgrammar-core/src/graph/animation/animate.ts
@@ -119,7 +119,7 @@ export class Animate implements IAnimate {
   stopAnimationByState(animationState: string) {
     const animators = this.animators.get(animationState);
     if (animators) {
-      animators.forEach(animator => animator.stop());
+      animators.forEach(animator => animator.stop('end'));
     }
     return this;
   }
@@ -157,7 +157,7 @@ export class Animate implements IAnimate {
   stop() {
     // map will be cleared in animator callback
     this.animators.forEach(animators => {
-      animators.forEach(animator => animator.stop());
+      animators.forEach(animator => animator.stop('end'));
     });
     return this;
   }

diff --git a/packages/vgrammar-core/src/graph/animation/animator.ts b/packages/vgrammar-core/src/graph/animation/animator.ts
@@ -73,7 +73,7 @@ export class Animator implements IAnimator {
     return this;
   }
 
-  stop(stopState?: 'start' | 'end', invokeCallback: boolean = true): this {
+  stop(stopState: 'start' | 'end' | null = 'end', invokeCallback: boolean = true): this {
     // FIXME: wait for VRender to fix 'end' parameter
     this.runnings.forEach(running => running.stop(stopState));
     this.animationEnd(invokeCallback);

diff --git a/packages/vgrammar-core/src/types/animate.ts b/packages/vgrammar-core/src/types/animate.ts
@@ -275,7 +275,7 @@ export interface IAnimator {
   callback: (callbackFunction: (...args: any[]) => void) => this;
 
   // animation control
-  stop: (stopState?: 'start' | 'end', invokeCallback?: boolean) => this;
+  stop: (stopState: 'start' | 'end' | null, invokeCallback?: boolean) => this;
   pause: () => this;
   resume: () => this;