@bryntum/grid-vue-3 7.1.2 → 7.1.3

package/src/components/BryntumGridBase.vue

@@ -1113,6 +1113,16 @@ const emit = defineEmits<{
      * @param {any} params.event.value The value being set
      */
     (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    /**
+     * This event is triggered before a parent column is collapsed or expanded.
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.GridBase} params.event.source The grid instance
+     * @param {Grid.column.Column} params.event.column The column
+     * @param {boolean} params.event.collapsed `true` if the column is being collapsed, `false` if expanded
+     */
+    (e: 'beforeColumnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
     /**
      * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
      * @param {string} e Event name
@@ -1251,20 +1261,20 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance.
-     * @param {Grid.row.Row} params.event.row The row about to be rendered.
-     * @param {Core.data.Model} params.event.record The record for the row.
-     * @param {number} params.event.recordIndex The zero-based index of the record.
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance
+     * @param {Grid.row.Row} params.event.row The row about to be rendered
+     * @param {Core.data.Model} params.event.record The record for the row
+     * @param {number} params.event.recordIndex The zero-based index of the record
      */
-    (e: 'beforeRenderRow', params: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string): void
+    (e: 'beforeRenderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
     /**
      * Grid rows are about to be rendered
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source This grid.
+     * @param {Grid.view.GridBase} params.event.source This grid.
      */
-    (e: 'beforeRenderRows', params: ((event: { source: Grid }) => void)|string): void
+    (e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
     /**
      * This event fires before row collapse is started.
      * ...
@@ -1545,6 +1555,16 @@ const emit = defineEmits<{
      * @param {Core.data.Model} params.event.record The record which has been collapsed.
      */
     (e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
+    /**
+     * This event is triggered after a parent column has been collapsed or expanded.
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.GridBase} params.event.source The Grid instance
+     * @param {Grid.column.Column} params.event.column The column being toggled
+     * @param {boolean} params.event.collapsed `true` if the column is now collapsed, `false` if expanded
+     */
+    (e: 'columnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
     /**
      * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
      * to indicate whether the drop position is valid or not.
@@ -1644,14 +1664,14 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source Owning grid
+     * @param {Grid.view.GridBase} params.event.source Owning grid
      * @param {Core.data.Store} params.event.store The originating store
      * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} params.event.action Name of action which triggered the change. May be one of:  * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
      * @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
      * @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
      * @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
      */
-    (e: 'dataChange', params: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
+    (e: 'dataChange', params: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
     /**
      * Fires when an object is destroyed.
      * @param {string} e Event name
@@ -2029,20 +2049,20 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance.
-     * @param {Grid.row.Row} params.event.row The row that has been rendered.
-     * @param {Core.data.Model} params.event.record The record for the row.
-     * @param {number} params.event.recordIndex The zero-based index of the record.
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance
+     * @param {Grid.row.Row} params.event.row The row that has been rendered
+     * @param {Core.data.Model} params.event.record The record for the row
+     * @param {number} params.event.recordIndex The zero-based index of the record
      */
-    (e: 'renderRow', params: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string): void
+    (e: 'renderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
     /**
      * Grid rows have been rendered
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source This grid.
+     * @param {Grid.view.GridBase} params.event.source This grid.
      */
-    (e: 'renderRows', params: ((event: { source: Grid }) => void)|string): void
+    (e: 'renderRows', params: ((event: { source: GridBase }) => void)|string): void
     /**
      * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
      * @param {string} e Event name
@@ -2116,10 +2136,10 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance.
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance.
      * @param {number} params.event.scrollTop The vertical scroll position.
      */
-    (e: 'scroll', params: ((event: { source: Grid, scrollTop: number }) => void)|string): void
+    (e: 'scroll', params: ((event: { source: GridBase, scrollTop: number }) => void)|string): void
     /**
      * The selection has been changed.
      * @param {string} e Event name
@@ -2229,19 +2249,19 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance
      * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
      */
-    (e: 'subGridCollapse', params: ((event: { source: Grid, subGrid: SubGrid }) => void)|string): void
+    (e: 'subGridCollapse', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
     /**
      * Fires after a sub grid is expanded.
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance
      * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
      */
-    (e: 'subGridExpand', params: ((event: { source: Grid, subGrid: SubGrid }) => void)|string): void
+    (e: 'subGridExpand', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
     /**
      * Fired when one or more groups are expanded or collapsed
      * @param {string} e Event name
@@ -2449,6 +2469,7 @@ const widgetData = {
         'onBeforeCellEditStart',
         'onBeforeCellRangeDelete',
         'onBeforeCellRangeEdit',
+        'onBeforeColumnCollapseToggle',
         'onBeforeColumnDragStart',
         'onBeforeColumnDropFinalize',
         'onBeforeColumnResize',
@@ -2489,6 +2510,7 @@ const widgetData = {
         'onCellMouseOver',
         'onCollapse',
         'onCollapseNode',
+        'onColumnCollapseToggle',
         'onColumnDrag',
         'onColumnDragStart',
         'onColumnDrop',
@@ -2596,6 +2618,7 @@ const widgetData = {
         'beforeCellEditStart',
         'beforeCellRangeDelete',
         'beforeCellRangeEdit',
+        'beforeColumnCollapseToggle',
         'beforeColumnDragStart',
         'beforeColumnDropFinalize',
         'beforeColumnResize',
@@ -2636,6 +2659,7 @@ const widgetData = {
         'cellMouseOver',
         'collapse',
         'collapseNode',
+        'columnCollapseToggle',
         'columnDrag',
         'columnDragStart',
         'columnDrop',

package/src/components/BryntumTreeGrid.vue

@@ -1114,6 +1114,16 @@ const emit = defineEmits<{
      * @param {any} params.event.value The value being set
      */
     (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    /**
+     * This event is triggered before a parent column is collapsed or expanded.
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.GridBase} params.event.source The grid instance
+     * @param {Grid.column.Column} params.event.column The column
+     * @param {boolean} params.event.collapsed `true` if the column is being collapsed, `false` if expanded
+     */
+    (e: 'beforeColumnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
     /**
      * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
      * @param {string} e Event name
@@ -1252,20 +1262,20 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance.
-     * @param {Grid.row.Row} params.event.row The row about to be rendered.
-     * @param {Core.data.Model} params.event.record The record for the row.
-     * @param {number} params.event.recordIndex The zero-based index of the record.
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance
+     * @param {Grid.row.Row} params.event.row The row about to be rendered
+     * @param {Core.data.Model} params.event.record The record for the row
+     * @param {number} params.event.recordIndex The zero-based index of the record
      */
-    (e: 'beforeRenderRow', params: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string): void
+    (e: 'beforeRenderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
     /**
      * Grid rows are about to be rendered
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source This grid.
+     * @param {Grid.view.GridBase} params.event.source This grid.
      */
-    (e: 'beforeRenderRows', params: ((event: { source: Grid }) => void)|string): void
+    (e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
     /**
      * This event fires before row collapse is started.
      * ...
@@ -1546,6 +1556,16 @@ const emit = defineEmits<{
      * @param {Core.data.Model} params.event.record The record which has been collapsed.
      */
     (e: 'collapseNode', params: ((event: { source: Grid, record: Model }) => void)|string): void
+    /**
+     * This event is triggered after a parent column has been collapsed or expanded.
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.GridBase} params.event.source The Grid instance
+     * @param {Grid.column.Column} params.event.column The column being toggled
+     * @param {boolean} params.event.collapsed `true` if the column is now collapsed, `false` if expanded
+     */
+    (e: 'columnCollapseToggle', params: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string): void
     /**
      * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
      * to indicate whether the drop position is valid or not.
@@ -1645,14 +1665,14 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source Owning grid
+     * @param {Grid.view.GridBase} params.event.source Owning grid
      * @param {Core.data.Store} params.event.store The originating store
      * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} params.event.action Name of action which triggered the change. May be one of:  * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
      * @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
      * @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
      * @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
      */
-    (e: 'dataChange', params: ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
+    (e: 'dataChange', params: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
     /**
      * Fires when an object is destroyed.
      * @param {string} e Event name
@@ -2030,20 +2050,20 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance.
-     * @param {Grid.row.Row} params.event.row The row that has been rendered.
-     * @param {Core.data.Model} params.event.record The record for the row.
-     * @param {number} params.event.recordIndex The zero-based index of the record.
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance
+     * @param {Grid.row.Row} params.event.row The row that has been rendered
+     * @param {Core.data.Model} params.event.record The record for the row
+     * @param {number} params.event.recordIndex The zero-based index of the record
      */
-    (e: 'renderRow', params: ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string): void
+    (e: 'renderRow', params: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string): void
     /**
      * Grid rows have been rendered
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source This grid.
+     * @param {Grid.view.GridBase} params.event.source This grid.
      */
-    (e: 'renderRows', params: ((event: { source: Grid }) => void)|string): void
+    (e: 'renderRows', params: ((event: { source: GridBase }) => void)|string): void
     /**
      * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
      * @param {string} e Event name
@@ -2117,10 +2137,10 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance.
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance.
      * @param {number} params.event.scrollTop The vertical scroll position.
      */
-    (e: 'scroll', params: ((event: { source: Grid, scrollTop: number }) => void)|string): void
+    (e: 'scroll', params: ((event: { source: GridBase, scrollTop: number }) => void)|string): void
     /**
      * The selection has been changed.
      * @param {string} e Event name
@@ -2230,19 +2250,19 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance
      * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
      */
-    (e: 'subGridCollapse', params: ((event: { source: Grid, subGrid: SubGrid }) => void)|string): void
+    (e: 'subGridCollapse', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
     /**
      * Fires after a sub grid is expanded.
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {Grid.view.Grid} params.event.source The firing Grid instance
+     * @param {Grid.view.GridBase} params.event.source The firing Grid instance
      * @param {Grid.view.SubGrid} params.event.subGrid The sub grid instance
      */
-    (e: 'subGridExpand', params: ((event: { source: Grid, subGrid: SubGrid }) => void)|string): void
+    (e: 'subGridExpand', params: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string): void
     /**
      * Fired when one or more groups are expanded or collapsed
      * @param {string} e Event name
@@ -2451,6 +2471,7 @@ const widgetData = {
         'onBeforeCellEditStart',
         'onBeforeCellRangeDelete',
         'onBeforeCellRangeEdit',
+        'onBeforeColumnCollapseToggle',
         'onBeforeColumnDragStart',
         'onBeforeColumnDropFinalize',
         'onBeforeColumnResize',
@@ -2491,6 +2512,7 @@ const widgetData = {
         'onCellMouseOver',
         'onCollapse',
         'onCollapseNode',
+        'onColumnCollapseToggle',
         'onColumnDrag',
         'onColumnDragStart',
         'onColumnDrop',
@@ -2598,6 +2620,7 @@ const widgetData = {
         'beforeCellEditStart',
         'beforeCellRangeDelete',
         'beforeCellRangeEdit',
+        'beforeColumnCollapseToggle',
         'beforeColumnDragStart',
         'beforeColumnDropFinalize',
         'beforeColumnResize',
@@ -2638,6 +2661,7 @@ const widgetData = {
         'cellMouseOver',
         'collapse',
         'collapseNode',
+        'columnCollapseToggle',
         'columnDrag',
         'columnDragStart',
         'columnDrop',

package/src/helper/WrapperHelper.ts

@@ -469,9 +469,13 @@ export class WrapperHelper {
                 isRecurring = eventRecord.isRecurring || eventRecord.isOccurrence,
                 key         = `assignment-${assignmentRecord?.id}${isRecurring ? '-' + eventRecord.id : ''}`;
 
-            if (wrap.vueKey) {
+            // Only delete the teleport if it's rendering into this specific targetElement.
+            // Prevents issues when elements are reused during scrolling with LockRows feature.
+            if (wrap.vueKey && teleports.get(wrap.vueKey)?.to === targetElement) {
+                // Only delete if the existing teleport is rendering into this specific targetElement
                 teleports.delete(wrap.vueKey);
             }
+
             const
                 bind            = { ...rendererConfig },
                 { is, on = {} } = bind;