[update] api pages for grid history module

mafanya23 · mafanya23 · commit 44c0f133bd4e · 2025-07-12T13:01:45.000+03:00
diff --git a/docs/grid/api/history/afterundo_event.md b/docs/grid/api/history/afterundo_event.md
@@ -12,7 +12,20 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
 
 @short: triggered after successfully undoing an action
 
-@signature: {'afterUndo: (action: IAction) => void;'}
+
+### Usage
+
+~~~jsx
+type ActionType = "add" | "remove" | "removeAll" | "change";
+
+interface IAction {
+    type: ActionType; 
+    batch: IRow[];
+    inverse?: IAction; 
+}
+
+afterUndo: (action: IAction) => void;
+~~~
 
 @params:
 The callback of the event is called with the following parameters:
diff --git a/docs/grid/api/history/beforeadd_event.md b/docs/grid/api/history/beforeadd_event.md
@@ -12,14 +12,32 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
 
 @short: triggered before adding an action to the history
 
-@signature: {'beforeAdd: (action: IAction) => boolean | void;'}
+
+### Usage
+
+~~~jsx
+type ActionType = "add" | "remove" | "removeAll" | "change";
+
+interface IAction {
+    type: ActionType; 
+    batch: IRow[];
+    inverse?: IAction; 
+}
+
+beforeAdd: (action: IAction) => boolean | void;
+~~~
 
 @params:
 The callback of the event is called with the following parameters:
-- `action: IAction` - the action object to be added containing:
-    - `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
-    - `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
-    - `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
+
+<table>
+    <tbody>
+        <tr>
+            <td><b>action</b></td>
+            <td>(<i>object</i>) the action object to be added that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)</li></ul></td>
+        </tr>
+    </tbody>
+</table>
 
 @returns:
 Returning `false` cancels the operation.
diff --git a/docs/grid/api/history/beforeredo_event.md b/docs/grid/api/history/beforeredo_event.md
@@ -12,14 +12,31 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
 
 @short: triggered before redoing an action
 
-@signature: {'beforeRedo: (action: IAction) => boolean | void;'}
+### Usage
+
+~~~jsx
+type ActionType = "add" | "remove" | "removeAll" | "change";
+
+interface IAction {
+    type: ActionType; 
+    batch: IRow[];
+    inverse?: IAction; 
+}
+
+beforeRedo: (action: IAction) => boolean | void;
+~~~
 
 @params:
 The callback of the event is called with the following parameters:
-- `action: IAction` - the action object from the redo stack containing:
-    - `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
-    - `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
-    - `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
+
+<table>
+    <tbody>
+        <tr>
+            <td><b>action</b></td>
+            <td>(<i>object</i>) the action object from the redo stack that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)</li></ul></td>
+        </tr>
+    </tbody>
+</table>
 
 @returns:
 Returning `false` cancels the operation.
diff --git a/docs/grid/api/history/beforeundo_event.md b/docs/grid/api/history/beforeundo_event.md
@@ -12,14 +12,31 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
 
 @short: triggered before undoing an action
 
-@signature: {'beforeUndo: (action: IAction) => boolean | void;'}
+### Usage
+
+~~~jsx
+type ActionType = "add" | "remove" | "removeAll" | "change";
+
+interface IAction {
+    type: ActionType; 
+    batch: IRow[];
+    inverse?: IAction; 
+}
+
+beforeUndo: (action: IAction) => boolean | void;
+~~~
 
 @params:
 The callback of the event is called with the following parameters:
-- `action: IAction` - the action object containing:
-    - `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
-    - `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
-    - `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
+
+<table>
+    <tbody>
+        <tr>
+            <td><b>action</b></td>
+            <td>(<i>object</i>) the action object that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)</li></ul></td>
+        </tr>
+    </tbody>
+</table>
 
 @returns:
 Returning `false` cancels the operation.
diff --git a/docs/grid/api/history/error_event.md b/docs/grid/api/history/error_event.md
@@ -16,15 +16,35 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
 The event is triggered when an error occurs, such as the module is disabled, the history is empty, the action type is invalid, or the inverse action is missing for the `undo` operation.
 :::
 
-@signature: {'error: (error: string, action: IAction | null) => void;'}
+### Usage
+
+~~~jsx
+type ActionType = "add" | "remove" | "removeAll" | "change";
+
+interface IAction {
+    type: ActionType; 
+    batch: IRow[];
+    inverse?: IAction; 
+}
+
+error: (error: string, action: IAction | null) => void;
+~~~
 
 @params:
 The callback of the event is called with the following parameters:
-- `error` - the error message
-- `action: IAction` - the action object associated with the error, or `null`. The `action` object contains the following properties:
-    - `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
-    - `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
-    - `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
+
+<table>
+    <tbody>
+        <tr>
+            <td><b>error</b></td>
+            <td>(<i>string</i>) the error message</td>
+        </tr>
+        <tr>
+            <td><b>action</b></td>
+            <td>(<i>object</i>) the action object associated with the error, or `null`. It contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (for the "change" and "removeAll" types)</li></ul></td>
+        </tr>
+    </tbody>
+</table>
     
 @example:
 const grid = new dhx.Grid("grid_container", {
diff --git a/docs/grid/api/history/gethistory_method.md b/docs/grid/api/history/gethistory_method.md
@@ -12,13 +12,31 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
 
 @short: returns a copy of the array of all actions in the Grid history to prevent accidental modification of the internal structure
 
-@signature: {'getHistory(): IAction[];'}
+### Usage
+
+~~~jsx
+type ActionType = "add" | "remove" | "removeAll" | "change";
+
+interface IAction {
+    type: ActionType; 
+    batch: IRow[];
+    inverse?: IAction; 
+}
+
+getHistory(): IAction[];
+~~~
 
 @returns:
-Returns a copy of the array of all actions in the history. Each `action` object may contain:
-    - `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
-    - `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
-    - `inverse?: IAction` - the inverse action required for undoing 
+Returns a copy of the array of all actions in the Grid history, where each action presents an object described below:
+
+<table>
+    <tbody>
+        <tr>
+            <td><b>action</b></td>
+            <td>(<i>object</i>) the action object that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (for the "change" and "removeAll" types)</li></ul></td>
+        </tr>
+    </tbody>
+</table>
 
 @example:
 // The example shows retrieving the history
diff --git a/docs/grid/usage_history.md b/docs/grid/usage_history.md
@@ -140,10 +140,14 @@ For the "change" and "removeAll" actions, an `inverse` action is mandatory. Othe
 
 You can add a new action into the history of actions within the grid by using the [`add()`](grid/api/history/add_method.md) method of the `history` object. The method takes the following parameters: 
 
-- `action: IAction` - the action object containing:
-    - `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
-    - `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
-    - `inverse?: IAction` - the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)
+<table>
+    <tbody>
+        <tr>
+            <td><b>action</b></td>
+            <td>(<i>object</i>) the action object that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)</li></ul></td>
+        </tr>
+    </tbody>
+</table>
 
 :::note
 The `action` argument must conform to the `IAction` interface. If the module is disabled, the action type is invalid, or the `inverse` property is missing (for actions with the "change" and "removeAll" types), the [`error`](grid/api/history/error_event.md) event is triggered. 
@@ -397,10 +401,16 @@ To make the process of working with the undo/redo operations more flexible, you
 
 You can get a copy of the array of all actions in the Grid history using the [`getHistory()`](grid/api/history/gethistory_method.md) method of the `history` object to prevent accidental modification of the internal structure.
 
-Each `action` object in the returned array may contain the following properties:
-    - `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
-    - `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
-    - `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
+Each action in the returned array presents an object described below:
+
+<table>
+    <tbody>
+        <tr>
+            <td><b>action</b></td>
+            <td>(<i>object</i>) the action object that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (for the "change" and "removeAll" types)</li></ul></td>
+        </tr>
+    </tbody>
+</table>
 
 The example below shows retrieving the history:
 
