From 60667c552cb83c221ef2be7bff687924db331898 Mon Sep 17 00:00:00 2001
From: Johan Nyman <johan@nytamin.se>
Date: Wed, 19 Nov 2025 18:30:42 +0100
Subject: [PATCH] fix: add documentation for skipAnimation. Re-add
 skipAnimation in customAction() params

---
 v1/specification/docs/Specification.md             | 12 +++++++++++-
 v1/typescript-definitions/src/definitions/types.ts |  3 +++
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/v1/specification/docs/Specification.md b/v1/specification/docs/Specification.md
index fbc5b60..97ab6de 100644
--- a/v1/specification/docs/Specification.md
+++ b/v1/specification/docs/Specification.md
@@ -333,6 +333,10 @@ The `updateAction()` function is called by the Renderer to update one or more fi
 Graphic. The `data` field contains a (potentially partial) update of the internal state of the Graphic and follows the
 model described in the Manifest using the `schema` field.
 
+The `skipAnimation` field indicates whether the Graphic should update with or without animation.
+When not provided, the `skipAnimation` field defaults to `false`. The Graphic MUST skip the animation when
+`skipAnimation` is set to `true`.
+
 The returned Promise MUST resolve after the execution of the update.
 
 
@@ -342,6 +346,7 @@ customAction: (
   params: {
     id: string;
     payload: unknown;
+    skipAnimation?: boolean;
   } & VendorExtend
 ) => Promise<ReturnPayload | undefined>;
 ```
@@ -350,7 +355,12 @@ correspond to an `id` of an Action that is defined in the Manifest file, inside
 `payload` field is the described in the corresponding Action inside the Manifest file. The returned Promise MUST
 resolve when the action is executed.
 
-<br>
+The `skipAnimation` field indicates whether the Graphic should disappear with or without animation.
+When not provided, the `skipAnimation` field defaults to `false`. The Graphic MUST skip the animation when
+`skipAnimation` is set to `true`.
+
+---
+
 Additionally, every non-real-time Graphic MUST implement the following functions.
 
 #### goToTime()
diff --git a/v1/typescript-definitions/src/definitions/types.ts b/v1/typescript-definitions/src/definitions/types.ts
index 0b9479f..8e05223 100644
--- a/v1/typescript-definitions/src/definitions/types.ts
+++ b/v1/typescript-definitions/src/definitions/types.ts
@@ -40,6 +40,9 @@ export type ActionInvokeParams = {
   id: string;
   /** Params to send into the method */
   payload: unknown;
+
+  /** If true, skips animation (defaults to false) */
+  skipAnimation?: boolean;
 } & VendorExtend;
 
 export type PlayActionReturnPayload = ReturnPayload & {