@ni/nimble-components 18.6.3 → 18.6.4

package/dist/all-components-bundle.js

@@ -28593,6 +28593,111 @@
         return 1;
     }
 
+    const isColumnProperty = (changedProperty, ...args) => {
+        for (const arg of args) {
+            if (changedProperty === arg) {
+                return true;
+            }
+        }
+        return false;
+    };
+    /**
+     * Helper class to track what updates are needed to the table based on configuration
+     * changes.
+     */
+    class UpdateTracker {
+        constructor(table) {
+            this.requiredUpdates = {
+                rowIds: false,
+                columnIds: false,
+                columnSort: false,
+                columnWidths: false,
+                columnDefinition: false,
+                actionMenuSlots: false
+            };
+            this.updateQueued = false;
+            this.table = table;
+        }
+        get updateRowIds() {
+            return this.requiredUpdates.rowIds;
+        }
+        get updateColumnIds() {
+            return this.requiredUpdates.columnIds;
+        }
+        get updateColumnSort() {
+            return this.requiredUpdates.columnSort;
+        }
+        get updateColumnWidths() {
+            return this.requiredUpdates.columnWidths;
+        }
+        get updateColumnDefinition() {
+            return this.requiredUpdates.columnDefinition;
+        }
+        get updateActionMenuSlots() {
+            return this.requiredUpdates.actionMenuSlots;
+        }
+        get requiresTanStackUpdate() {
+            return (this.requiredUpdates.rowIds
+                || this.requiredUpdates.columnSort
+                || this.requiredUpdates.columnDefinition);
+        }
+        get requiresTanStackDataReset() {
+            return (this.requiredUpdates.rowIds || this.requiredUpdates.columnDefinition);
+        }
+        trackAllStateChanged() {
+            this.setAllKeys(true);
+            this.queueUpdate();
+        }
+        trackColumnPropertyChanged(changedColumnProperty) {
+            if (isColumnProperty(changedColumnProperty, 'columnId')) {
+                this.requiredUpdates.columnIds = true;
+            }
+            else if (isColumnProperty(changedColumnProperty, 'operandDataRecordFieldName', 'sortOperation')) {
+                this.requiredUpdates.columnDefinition = true;
+            }
+            else if (isColumnProperty(changedColumnProperty, 'sortIndex', 'sortDirection')) {
+                this.requiredUpdates.columnSort = true;
+            }
+            else if (isColumnProperty(changedColumnProperty, 'currentFractionalWidth', 'currentPixelWidth', 'internalMinPixelWidth', 'columnHidden')) {
+                this.requiredUpdates.columnWidths = true;
+            }
+            else if (isColumnProperty(changedColumnProperty, 'actionMenuSlot')) {
+                this.requiredUpdates.actionMenuSlots = true;
+            }
+            this.queueUpdate();
+        }
+        trackColumnInstancesChanged() {
+            this.requiredUpdates.columnIds = true;
+            this.requiredUpdates.columnDefinition = true;
+            this.requiredUpdates.columnSort = true;
+            this.requiredUpdates.columnWidths = true;
+            this.requiredUpdates.actionMenuSlots = true;
+            this.queueUpdate();
+        }
+        trackIdFieldNameChanged() {
+            this.requiredUpdates.rowIds = true;
+            this.queueUpdate();
+        }
+        setAllKeys(value) {
+            Object.keys(this.requiredUpdates).forEach(key => {
+                this.requiredUpdates[key] = value;
+            });
+        }
+        queueUpdate() {
+            if (!this.table.$fastController.isConnected) {
+                return;
+            }
+            if (!this.updateQueued) {
+                this.updateQueued = true;
+                DOM.queueUpdate(() => {
+                    this.table.update();
+                    this.setAllKeys(false);
+                    this.updateQueued = false;
+                });
+            }
+        }
+    }
+
     /**
      * This class provides helper methods for managing the layout of cells within
      * a Table.
@@ -28648,6 +28753,7 @@
              */
             this.scrollX = 0;
             this.tableValidator = new TableValidator();
+            this.updateTracker = new UpdateTracker(this);
             this.columnNotifiers = [];
             this.onViewPortScroll = (event) => {
                 this.scrollX = event.target.scrollLeft;
@@ -28675,7 +28781,8 @@
         connectedCallback() {
             super.connectedCallback();
             this.virtualizer.connectedCallback();
-            this.validateAndObserveColumns();
+            this.updateTracker.trackAllStateChanged();
+            this.observeColumns();
             this.viewport.addEventListener('scroll', this.onViewPortScroll, {
                 passive: true
             });
@@ -28697,24 +28804,8 @@
          * is the string name of the property that changed on that column.
          */
         handleChange(source, args) {
-            if (source instanceof TableColumn) {
-                if (args === 'columnId') {
-                    this.validateColumnIds();
-                }
-                else if (args === 'operandDataRecordFieldName'
-                    || args === 'sortOperation') {
-                    this.generateTanStackColumns();
-                }
-                else if (args === 'sortIndex' || args === 'sortDirection') {
-                    this.validateColumnSortIndices();
-                    this.setSortState();
-                }
-                else if (args === 'currentFractionalWidth'
-                    || args === 'currentPixelWidth'
-                    || args === 'internalMinPixelWidth'
-                    || args === 'columnHidden') {
-                    this.updateRowGridColumns();
-                }
+            if (source instanceof TableColumn && typeof args === 'string') {
+                this.updateTracker.trackColumnPropertyChanged(args);
             }
         }
         onRowActionMenuBeforeToggle(event) {
@@ -28724,29 +28815,33 @@
         onRowActionMenuToggle(event) {
             this.$emit('action-menu-toggle', event.detail);
         }
-        childItemsChanged() {
-            void this.updateColumnsFromChildItems();
+        /**
+         * @internal
+         */
+        update() {
+            this.validate();
+            if (this.updateTracker.requiresTanStackUpdate) {
+                this.updateTanStack();
+            }
+            if (this.updateTracker.updateActionMenuSlots) {
+                this.updateActionMenuSlots();
+            }
+            if (this.updateTracker.updateColumnWidths) {
+                this.updateRowGridColumns();
+            }
         }
         idFieldNameChanged(_prev, _next) {
-            // Force TanStack to detect a data update because a row's ID is only
-            // generated when creating a new row model.
-            this.setTableData(this.table.options.data);
+            if (!this.$fastController.isConnected) {
+                return;
+            }
+            this.updateTracker.trackIdFieldNameChanged();
         }
         columnsChanged(_prev, _next) {
             if (!this.$fastController.isConnected) {
                 return;
             }
-            this.validateAndObserveColumns();
-            this.generateTanStackColumns();
-            this.setSortState();
-            const slots = new Set();
-            for (const column of this.columns) {
-                if (column.actionMenuSlot) {
-                    slots.add(column.actionMenuSlot);
-                }
-            }
-            this.actionMenuSlots = Array.from(slots);
-            this.updateRowGridColumns();
+            this.observeColumns();
+            this.updateTracker.trackColumnInstancesChanged();
         }
         removeColumnObservers() {
             this.columnNotifiers.forEach(notifier => {
@@ -28754,30 +28849,20 @@
             });
             this.columnNotifiers = [];
         }
-        validateAndObserveColumns() {
+        observeColumns() {
             this.removeColumnObservers();
             for (const column of this.columns) {
                 const notifier = Observable.getNotifier(column);
                 notifier.subscribe(this);
                 this.columnNotifiers.push(notifier);
             }
-            this.validateColumnIds();
-            this.validateColumnSortIndices();
-        }
-        validateColumnIds() {
-            this.tableValidator.validateColumnIds(this.columns.map(x => x.columnId));
-            this.canRenderRows = this.checkValidity();
-        }
-        validateColumnSortIndices() {
-            this.tableValidator.validateColumnSortIndices(this.getColumnsParticipatingInSorting().map(x => x.sortIndex));
-            this.canRenderRows = this.checkValidity();
         }
         getColumnsParticipatingInSorting() {
             return this.columns.filter(x => x.sortDirection !== TableColumnSortDirection.none
                 && typeof x.sortIndex === 'number');
         }
-        updateRowGridColumns() {
-            this.rowGridColumns = TableLayoutHelper.getGridTemplateColumns(this.columns);
+        childItemsChanged() {
+            void this.updateColumnsFromChildItems();
         }
         async updateColumnsFromChildItems() {
             const definedElements = this.childItems.map(async (item) => (item.matches(':not(:defined)')
@@ -28786,18 +28871,53 @@
             await Promise.all(definedElements);
             this.columns = this.childItems.filter((x) => x instanceof TableColumn);
         }
+        updateTanStack() {
+            const updatedOptions = {
+                state: {}
+            };
+            if (this.updateTracker.updateColumnSort) {
+                updatedOptions.state.sorting = this.calculateTanStackSortState();
+            }
+            if (this.updateTracker.updateColumnDefinition) {
+                updatedOptions.columns = this.calculateTanStackColumns();
+            }
+            if (this.updateTracker.updateRowIds) {
+                updatedOptions.getRowId = this.calculateTanStackRowIdFunction();
+            }
+            if (this.updateTracker.requiresTanStackDataReset) {
+                // Perform a shallow copy of the data to trigger tanstack to regenerate the row models and columns.
+                updatedOptions.data = [...this.table.options.data];
+            }
+            this.updateTableOptions(updatedOptions);
+        }
+        updateActionMenuSlots() {
+            const slots = new Set();
+            for (const column of this.columns) {
+                if (column.actionMenuSlot) {
+                    slots.add(column.actionMenuSlot);
+                }
+            }
+            this.actionMenuSlots = Array.from(slots);
+        }
+        updateRowGridColumns() {
+            this.rowGridColumns = TableLayoutHelper.getGridTemplateColumns(this.columns);
+        }
+        validate() {
+            this.tableValidator.validateColumnIds(this.columns.map(x => x.columnId));
+            this.tableValidator.validateColumnSortIndices(this.getColumnsParticipatingInSorting().map(x => x.sortIndex));
+            this.validateWithData(this.table.options.data);
+        }
+        validateWithData(data) {
+            this.tableValidator.validateRecordIds(data, this.idFieldName);
+            this.canRenderRows = this.checkValidity();
+        }
         setTableData(newData) {
             const data = newData.map(record => {
                 return { ...record };
             });
-            this.tableValidator.validateRecordIds(data, this.idFieldName);
-            this.canRenderRows = this.checkValidity();
-            const getRowIdFunction = this.idFieldName === null || this.idFieldName === undefined
-                ? undefined
-                : (record) => record[this.idFieldName];
+            this.validateWithData(data);
             this.updateTableOptions({
-                data,
-                getRowId: getRowIdFunction
+                data
             });
         }
         refreshRows() {
@@ -28820,27 +28940,26 @@
             this.table.setOptions(this.options);
             this.refreshRows();
         }
-        setSortState() {
+        calculateTanStackSortState() {
             const sortedColumns = this.getColumnsParticipatingInSorting().sort((x, y) => x.sortIndex - y.sortIndex);
             this.firstSortedColumn = sortedColumns.length
                 ? sortedColumns[0]
                 : undefined;
-            const tanStackSortingState = sortedColumns.map(column => {
+            return sortedColumns.map(column => {
                 return {
                     id: column.internalUniqueId,
-                    desc: column.sortDirection
-                        === TableColumnSortDirection.descending
+                    desc: column.sortDirection === TableColumnSortDirection.descending
                 };
             });
-            this.updateTableOptions({
-                state: {
-                    sorting: tanStackSortingState
-                }
-            });
         }
-        generateTanStackColumns() {
-            const generatedColumns = this.columns.map(column => {
-                const columnDef = {
+        calculateTanStackRowIdFunction() {
+            return this.idFieldName === null || this.idFieldName === undefined
+                ? undefined
+                : (record) => record[this.idFieldName];
+        }
+        calculateTanStackColumns() {
+            return this.columns.map(column => {
+                return {
                     id: column.internalUniqueId,
                     accessorFn: (data) => {
                         const fieldName = column.operandDataRecordFieldName;
@@ -28851,13 +28970,6 @@
                     },
                     sortingFn: getTanStackSortingFunction(column.sortOperation)
                 };
-                return columnDef;
-            });
-            this.updateTableOptions({
-                // Force TanStack to detect a data update because a columns's accessor is
-                // referenced when creating a new row model.
-                data: [...this.table.options.data],
-                columns: generatedColumns
             });
         }
     }