@ni/nimble-components 18.6.1 → 18.6.3

package/dist/all-components-bundle.js

@@ -27175,6 +27175,8 @@
          */
         localeAwareCaseSensitive: 'localeAwareCaseSensitive'
     };
+    const defaultMinPixelWidth = 88;
+    const defaultFractionalWidth = 1;
 
     /**
      * The base class for table columns
@@ -27184,6 +27186,23 @@
             super();
             this.columnHidden = false;
             this.sortDirection = TableColumnSortDirection.none;
+            /**
+             * @internal
+             * Used by the Table in order to size a column proportionally to the available
+             * width of a row.
+             */
+            this.currentFractionalWidth = defaultFractionalWidth;
+            /**
+             * @internal
+             * Used by column plugins to size a column proportionally to the available
+             * width of a row. Sets currentFractionalWidth when changed.
+             */
+            this.internalFractionalWidth = defaultFractionalWidth;
+            /**
+             * @internal
+             * The minimum size in pixels according to the design doc
+             */
+            this.internalMinPixelWidth = defaultMinPixelWidth;
             /**
              * @internal
              *
@@ -27206,6 +27225,12 @@
             super.connectedCallback();
             this.setAttribute('slot', this.internalUniqueId);
         }
+        internalFractionalWidthChanged() {
+            this.currentFractionalWidth = this.internalFractionalWidth;
+        }
+        internalPixelWidthChanged() {
+            this.currentPixelWidth = this.internalPixelWidth;
+        }
     }
     __decorate$1([
         attr({ attribute: 'column-id' })
@@ -27225,6 +27250,21 @@
     __decorate$1([
         attr({ attribute: 'sort-direction' })
     ], TableColumn.prototype, "sortDirection", void 0);
+    __decorate$1([
+        observable
+    ], TableColumn.prototype, "currentPixelWidth", void 0);
+    __decorate$1([
+        observable
+    ], TableColumn.prototype, "currentFractionalWidth", void 0);
+    __decorate$1([
+        observable
+    ], TableColumn.prototype, "internalPixelWidth", void 0);
+    __decorate$1([
+        observable
+    ], TableColumn.prototype, "internalFractionalWidth", void 0);
+    __decorate$1([
+        observable
+    ], TableColumn.prototype, "internalMinPixelWidth", void 0);
     __decorate$1([
         observable
     ], TableColumn.prototype, "dataRecordFieldNames", void 0);
@@ -27333,6 +27373,7 @@
     }
 
     .table-container {
+        overflow: hidden;
         display: flex;
         flex-direction: column;
         width: 100%;
@@ -27341,7 +27382,7 @@
     }
 
     .table-viewport {
-        overflow-y: auto;
+        overflow: auto;
         display: block;
         height: 100%;
         position: relative;
@@ -27352,11 +27393,13 @@
         position: absolute;
         top: 0px;
         width: 100%;
+        height: var(--ni-private-table-scroll-height);
     }
 
     .table-row-container {
         width: 100%;
         position: relative;
+        top: var(--ni-private-table-row-container-top);
     }
 
     .header-container {
@@ -27365,10 +27408,17 @@
     }
 
     .header-row {
-        display: flex;
-        flex-direction: row;
+        display: grid;
         background: ${applicationBackgroundColor};
         position: relative;
+        width: fit-content;
+        min-width: 100%;
+        grid-template-columns: var(--ni-private-table-row-grid-columns) auto;
+        left: var(--ni-private-table-scroll-x);
+    }
+
+    .header-scrollbar-spacer {
+        width: var(--ni-private-table-header-scrollbar-spacer-width);
     }
 
     .header {
@@ -27492,10 +27542,13 @@
     ${display('grid')}
 
     :host {
-        height: ${controlHeight};
+        height: calc(${controlHeight} + 2 * ${borderWidth});
         border-top: calc(2 * ${borderWidth}) solid ${tableRowBorderColor};
         grid-auto-flow: column;
         grid-auto-columns: 1fr;
+        grid-template-columns: var(--ni-private-table-row-grid-columns) auto;
+        width: fit-content;
+        min-width: 100%;
     }
 
     nimble-table-cell {
@@ -27735,7 +27788,13 @@
     // prettier-ignore
     const template$4 = html `
     <template role="table" ${children$1({ property: 'childItems', filter: elements() })}>
-        <div class="table-container">
+        <div class="table-container" style="
+            --ni-private-table-scroll-x: -${x => x.scrollX}px;
+            --ni-private-table-header-scrollbar-spacer-width: ${x => x.virtualizer.headerContainerMarginRight}px;
+            --ni-private-table-scroll-height: ${x => x.virtualizer.allRowsHeight}px;
+            --ni-private-table-row-container-top: ${x => x.virtualizer.rowContainerYOffset}px; 
+            --ni-private-table-row-grid-columns: ${x => x.rowGridColumns ?? ''}
+            ">
             <div role="rowgroup" class="header-container">
                 <div class="header-row" role="row">
                     ${repeat(x => x.columns, html `
@@ -27749,12 +27808,13 @@
                             </${DesignSystem.tagFor(TableHeader)}>
                         `)}
                     `)}
-                    <div class="header-scrollbar-spacer" style="width: ${x => x.virtualizer.headerContainerMarginRight}px;"></div>
+                    <div class="header-scrollbar-spacer"></div>
                 </div>
             </div>
             <div class="table-viewport" ${ref('viewport')}>
-                <div class="table-scroll" style="height: ${x => x.virtualizer.allRowsHeight}px;"></div>
-                <div class="table-row-container" role="rowgroup" style="top: ${x => `${x.virtualizer.rowContainerYOffset}px;`}">
+                <div class="table-scroll"></div>
+                <div class="table-row-container" 
+                     role="rowgroup">
                     ${when(x => x.columns.length > 0 && x.canRenderRows, html `
                         ${repeat(x => x.virtualizer.visibleItems, html `
                             <${DesignSystem.tagFor(TableRow)}
@@ -27764,7 +27824,6 @@
                                 :columns="${(_, c) => c.parent.columns}"
                                 @row-action-menu-beforetoggle="${(_, c) => c.parent.onRowActionMenuBeforeToggle(c.event)}"
                                 @row-action-menu-toggle="${(_, c) => c.parent.onRowActionMenuToggle(c.event)}"
-                                style="height: ${x => x.size}px;"
                             >
                             ${when((x, c) => c.parent.openActionMenuRecordId === c.parent.tableData[x.index]?.id, html `
                                 ${repeat((_, c) => c.parent.actionMenuSlots, html `
@@ -28426,7 +28485,7 @@
                     // If we have enough rows that a vertical scrollbar is shown, we need to offset the header widths
                     // by the same margin so the column headers align with the corresponding rendered cells
                     const viewportBoundingWidth = borderBoxSize.inlineSize;
-                    this.headerContainerMarginRight = viewportBoundingWidth - this.table.viewport.scrollWidth;
+                    this.headerContainerMarginRight = viewportBoundingWidth - this.table.viewport.clientWidth;
                 }
             });
         }
@@ -28534,6 +28593,30 @@
         return 1;
     }
 
+    /**
+     * This class provides helper methods for managing the layout of cells within
+     * a Table.
+     */
+    class TableLayoutHelper {
+        static getGridTemplateColumns(columns) {
+            return (columns
+                ?.filter(column => !column.columnHidden)
+                .reduce((accumulator, currentValue) => {
+                const gap = accumulator === '' ? '' : ' ';
+                const minPixelWidth = currentValue.internalMinPixelWidth;
+                if (currentValue.currentPixelWidth) {
+                    const pixelWidth = currentValue.currentPixelWidth;
+                    const gridPixelWidth = pixelWidth > minPixelWidth
+                        ? pixelWidth
+                        : minPixelWidth;
+                    return `${accumulator}${gap}${gridPixelWidth}px`;
+                }
+                const fractionalWidth = currentValue.currentFractionalWidth;
+                return `${accumulator}${gap}minmax(${minPixelWidth}px, ${fractionalWidth}fr)`;
+            }, '') ?? '');
+        }
+    }
+
     /**
      * A nimble-styled table.
      */
@@ -28560,8 +28643,15 @@
              * @internal
              */
             this.canRenderRows = true;
+            /**
+             * @internal
+             */
+            this.scrollX = 0;
             this.tableValidator = new TableValidator();
             this.columnNotifiers = [];
+            this.onViewPortScroll = (event) => {
+                this.scrollX = event.target.scrollLeft;
+            };
             this.options = {
                 data: [],
                 onStateChange: (_) => { },
@@ -28586,11 +28676,15 @@
             super.connectedCallback();
             this.virtualizer.connectedCallback();
             this.validateAndObserveColumns();
+            this.viewport.addEventListener('scroll', this.onViewPortScroll, {
+                passive: true
+            });
         }
         disconnectedCallback() {
             super.disconnectedCallback();
             this.virtualizer.disconnectedCallback();
             this.removeColumnObservers();
+            this.viewport.removeEventListener('scroll', this.onViewPortScroll);
         }
         checkValidity() {
             return this.tableValidator.isValid();
@@ -28615,6 +28709,12 @@
                     this.validateColumnSortIndices();
                     this.setSortState();
                 }
+                else if (args === 'currentFractionalWidth'
+                    || args === 'currentPixelWidth'
+                    || args === 'internalMinPixelWidth'
+                    || args === 'columnHidden') {
+                    this.updateRowGridColumns();
+                }
             }
         }
         onRowActionMenuBeforeToggle(event) {
@@ -28646,6 +28746,7 @@
                 }
             }
             this.actionMenuSlots = Array.from(slots);
+            this.updateRowGridColumns();
         }
         removeColumnObservers() {
             this.columnNotifiers.forEach(notifier => {
@@ -28675,6 +28776,9 @@
             return this.columns.filter(x => x.sortDirection !== TableColumnSortDirection.none
                 && typeof x.sortIndex === 'number');
         }
+        updateRowGridColumns() {
+            this.rowGridColumns = TableLayoutHelper.getGridTemplateColumns(this.columns);
+        }
         async updateColumnsFromChildItems() {
             const definedElements = this.childItems.map(async (item) => (item.matches(':not(:defined)')
                 ? customElements.whenDefined(item.localName)
@@ -28738,7 +28842,13 @@
             const generatedColumns = this.columns.map(column => {
                 const columnDef = {
                     id: column.internalUniqueId,
-                    accessorKey: column.operandDataRecordFieldName,
+                    accessorFn: (data) => {
+                        const fieldName = column.operandDataRecordFieldName;
+                        if (typeof fieldName !== 'string') {
+                            return undefined;
+                        }
+                        return data[fieldName];
+                    },
                     sortingFn: getTanStackSortingFunction(column.sortOperation)
                 };
                 return columnDef;
@@ -28772,6 +28882,12 @@
     __decorate$1([
         observable
     ], Table.prototype, "canRenderRows", void 0);
+    __decorate$1([
+        observable
+    ], Table.prototype, "scrollX", void 0);
+    __decorate$1([
+        observable
+    ], Table.prototype, "rowGridColumns", void 0);
     __decorate$1([
         observable
     ], Table.prototype, "firstSortedColumn", void 0);
@@ -28787,14 +28903,61 @@
     :host {
         display: contents;
     }
+
+    .header-content {
+        white-space: nowrap;
+        overflow: hidden;
+        text-overflow: ellipsis;
+    }
 `;
 
     const template$3 = html `
     <template>
-        <slot></slot>
+        <span class="header-content">
+            <slot></slot>
+        </span>
     </template>
 `;
 
+    // As the returned class is internal to the function, we can't write a signature that uses is directly, so rely on inference
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/explicit-function-return-type
+    function mixinFractionalWidthColumnAPI(base) {
+        /**
+         * The Mixin that provides a concrete column with the API to support being resized
+         * proportionally within a Table.
+         */
+        class FractionalWidthColumn extends base {
+            constructor() {
+                super(...arguments);
+                this.fractionalWidth = defaultFractionalWidth;
+                this.minPixelWidth = defaultMinPixelWidth;
+            }
+            fractionalWidthChanged() {
+                if (typeof this.fractionalWidth === 'number') {
+                    this.internalFractionalWidth = this.fractionalWidth;
+                }
+                else {
+                    this.internalFractionalWidth = defaultFractionalWidth;
+                }
+            }
+            minPixelWidthChanged() {
+                if (typeof this.minPixelWidth === 'number') {
+                    this.internalMinPixelWidth = this.minPixelWidth;
+                }
+                else {
+                    this.internalMinPixelWidth = defaultMinPixelWidth;
+                }
+            }
+        }
+        attr({ attribute: 'fractional-width', converter: nullableNumberConverter })(
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        FractionalWidthColumn.prototype, 'fractionalWidth');
+        attr({ attribute: 'min-pixel-width', converter: nullableNumberConverter })(
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        FractionalWidthColumn.prototype, 'minPixelWidth');
+        return FractionalWidthColumn;
+    }
+
     const cellStyles = css `
     span {
         font: ${bodyFont};
@@ -28833,9 +28996,9 @@
 `;
 
     /**
-     * The table column for displaying strings.
+     * The base class for a table column for displaying strings.
      */
-    class TableColumnText extends TableColumn {
+    class TableColumnTextBase extends TableColumn {
         constructor() {
             super();
             this.cellRecordFieldNames = ['value'];
@@ -28853,10 +29016,15 @@
     }
     __decorate$1([
         attr({ attribute: 'field-name' })
-    ], TableColumnText.prototype, "fieldName", void 0);
+    ], TableColumnTextBase.prototype, "fieldName", void 0);
     __decorate$1([
         attr
-    ], TableColumnText.prototype, "placeholder", void 0);
+    ], TableColumnTextBase.prototype, "placeholder", void 0);
+    /**
+     * The table column for displaying strings.
+     */
+    class TableColumnText extends mixinFractionalWidthColumnAPI(TableColumnTextBase) {
+    }
     const nimbleTableColumnText = TableColumnText.compose({
         baseName: 'table-column-text',
         template: template$3,