@bryntum/gantt-react 7.2.1 → 7.2.2

package/src/BryntumTreeGrid.tsx

@@ -559,7 +559,7 @@ export type BryntumTreeGridProps = {
     rootElement? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -779,7 +779,7 @@ export type BryntumTreeGridProps = {
      */
     onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
     /**
-     * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
+     * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
      * buttons while [autoEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
      * @param {object} event Event object
      * @param {Grid.view.Grid} event.source Owner grid
@@ -1543,7 +1543,7 @@ export type BryntumTreeGridProps = {
      * @param {Response} event.response Optional response, if received
      * @param {Error} event.error Optional error, if exception occurred
      */
-    onPdfExport? : ((event: { response?: any, error?: Error }) => void)|string
+    onPdfExport? : ((event: { response?: Response, error?: Error }) => void)|string
     /**
      * Fired when a Widget's read only state is toggled
      * @param {object} event Event object
@@ -1754,6 +1754,14 @@ export type BryntumTreeGridProps = {
      * @param {Core.widget.Tool} event.tool The tool which is being clicked.
      */
     onToolClick? : ((event: { source: Tool, tool: Tool }) => void)|string
+    /**
+     * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
+     * @param {object} event Event object
+     * @param {Grid.view.Grid} event.source The grid instance
+     * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
+     * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
+     */
+    onTreeGroup? : ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
     /**
      * Fires when row locking is disabled.
      * @param {object} event Event object
@@ -1798,7 +1806,7 @@ export type BryntumTreeGridProps = {
     cellEditFeature? : object|boolean|string|GridCellEdit|GridCellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu)
      */
@@ -1898,8 +1906,8 @@ export type BryntumTreeGridProps = {
     filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Group)
@@ -2358,6 +2366,7 @@ export class BryntumTreeGrid extends React.Component<BryntumTreeGridProps> {
         'onToggleGroup',
         'onToggleNode',
         'onToolClick',
+        'onTreeGroup',
         'onUnlockRows',
         'onUnsplit',
         'preserveScroll',

package/src/BryntumVersionGrid.tsx

@@ -571,7 +571,7 @@ export type BryntumVersionGridProps = {
     rootElement? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/gantt/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/gantt/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/widget/VersionGrid#config-rowHeight)
@@ -803,7 +803,7 @@ export type BryntumVersionGridProps = {
      */
     onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
     /**
-     * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
+     * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
      * buttons while [autoEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
      * @param {object} event Event object
      * @param {Grid.view.Grid} event.source Owner grid
@@ -1573,7 +1573,7 @@ export type BryntumVersionGridProps = {
      * @param {Response} event.response Optional response, if received
      * @param {Error} event.error Optional error, if exception occurred
      */
-    onPdfExport? : ((event: { response?: any, error?: Error }) => void)|string
+    onPdfExport? : ((event: { response?: Response, error?: Error }) => void)|string
     /**
      * Fired when a Widget's read only state is toggled
      * @param {object} event Event object
@@ -1794,6 +1794,14 @@ export type BryntumVersionGridProps = {
      * @param {Core.widget.Tool} event.tool The tool which is being clicked.
      */
     onToolClick? : ((event: { source: Tool, tool: Tool }) => void)|string
+    /**
+     * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
+     * @param {object} event Event object
+     * @param {Grid.view.Grid} event.source The grid instance
+     * @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
+     * @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
+     */
+    onTreeGroup? : ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
     /**
      * Fires when row locking is disabled.
      * @param {object} event Event object
@@ -1838,7 +1846,7 @@ export type BryntumVersionGridProps = {
     cellEditFeature? : object|boolean|string|GridCellEdit|GridCellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellMenu)
      */
@@ -1938,8 +1946,8 @@ export type BryntumVersionGridProps = {
     filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/feature/Group)
@@ -2337,6 +2345,7 @@ export class BryntumVersionGrid extends React.Component<BryntumVersionGridProps>
         'onToggleGroup',
         'onToggleNode',
         'onToolClick',
+        'onTreeGroup',
         'onUnlockRows',
         'onUnsplit',
         'preserveScroll',