@toolbox-web/grid 1.23.3 → 1.23.4

package/lib/plugins/grouping-rows/types.d.ts

@@ -103,22 +103,67 @@ export interface GroupingRowsState {
 }
 export type RowGroupingConfig = GroupingRowsConfig;
 export type RowGroupingState = GroupingRowsState;
-/** Group row model item */
+/**
+ * A group header row in the flattened render model.
+ *
+ * Part of the {@link RenderRow} discriminated union (discriminant: `kind === 'group'`).
+ * Group rows represent collapsed/expanded group headers in the virtualized row list.
+ * They are produced by the grouping engine when `groupOn` categorizes rows into hierarchical groups.
+ *
+ * @example
+ * ```typescript
+ * function isGroup(row: RenderRow): row is GroupRowModelItem {
+ *   return row.kind === 'group';
+ * }
+ * ```
+ */
 export interface GroupRowModelItem {
+    /** Discriminant — always `'group'` for group header rows. */
     kind: 'group';
+    /** Composite group key (nested groups separated by `"||"`, e.g. `"Engineering||Frontend"`). */
     key: string;
+    /** Display value for this group level (the last segment of the group path). */
     value: any;
+    /** Nesting depth (0 = top-level group). */
     depth: number;
+    /** All data rows belonging to this group (including rows in nested sub-groups). */
     rows: any[];
+    /** Whether this group is currently expanded (children visible). */
     expanded: boolean;
 }
-/** Data row model item */
+/**
+ * A data (leaf) row in the flattened render model.
+ *
+ * Part of the {@link RenderRow} discriminated union (discriminant: `kind === 'data'`).
+ * Data rows represent actual row objects from the grid's data source.
+ * Only visible when their parent group(s) are expanded.
+ */
 export interface DataRowModelItem {
+    /** Discriminant — always `'data'` for leaf data rows. */
     kind: 'data';
+    /** The original row object from the data source. */
     row: any;
+    /** Index of this row in the grid's current (post-sort/filter) row array. */
     rowIndex: number;
 }
-/** Union type for render rows */
+/**
+ * Discriminated union of row types in the flattened render model.
+ *
+ * The grouping plugin transforms the grid's row array into a flat list of
+ * `RenderRow` items that the virtualization engine iterates over. Each item
+ * is either a {@link GroupRowModelItem} (group header) or a {@link DataRowModelItem}
+ * (leaf data row). Use the `kind` property to discriminate:
+ *
+ * ```typescript
+ * for (const row of flattenedRows) {
+ *   if (row.kind === 'group') {
+ *     renderGroupHeader(row);   // row is GroupRowModelItem
+ *   } else {
+ *     renderDataRow(row);       // row is DataRowModelItem
+ *   }
+ * }
+ * ```
+ */
 export type RenderRow = GroupRowModelItem | DataRowModelItem;
 /** Event detail for group toggle */
 export interface GroupToggleDetail {

package/lib/plugins/grouping-rows/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/grouping-rows/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACnF,YAAY,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,iCAAiC,EAAE,aAAa,CAAC,CAAC;AAEpG;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAExE,wDAAwD;AACxD,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;IACnD;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;IACjF,sDAAsD;IACtD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,6CAA6C;IAC7C,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACjE,8EAA8E;IAC9E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,qDAAqD;AACrD,MAAM,WAAW,oBAAoB;IACnC,oBAAoB;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,6CAA6C;IAC7C,KAAK,EAAE,GAAG,CAAC;IACX,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,6BAA6B;IAC7B,YAAY,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED,wDAAwD;AACxD,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,6BAA6B;IAC7B,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,2CAA2C;IAC3C,QAAQ,EAAE,OAAO,CAAC;CACnB;AAGD,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAAC;AACnD,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD,2BAA2B;AAC3B,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,GAAG,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,0BAA0B;AAC1B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,GAAG,CAAC;IACT,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,iCAAiC;AACjC,MAAM,MAAM,SAAS,GAAG,iBAAiB,GAAG,gBAAgB,CAAC;AAE7D,oCAAoC;AACpC,MAAM,WAAW,iBAAiB;IAChC,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,QAAQ,EAAE,OAAO,CAAC;IAClB,sBAAsB;IACtB,KAAK,EAAE,GAAG,CAAC;IACX,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,YAAY,EAAE,OAAO,sBAAsB,EAAE,kBAAkB,CAAC;KACjE;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/grouping-rows/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACnF,YAAY,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,iCAAiC,EAAE,aAAa,CAAC,CAAC;AAEpG;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAExE,wDAAwD;AACxD,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;IACnD;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;IACjF,sDAAsD;IACtD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,6CAA6C;IAC7C,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACjE,8EAA8E;IAC9E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,qDAAqD;AACrD,MAAM,WAAW,oBAAoB;IACnC,oBAAoB;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,6CAA6C;IAC7C,KAAK,EAAE,GAAG,CAAC;IACX,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,6BAA6B;IAC7B,YAAY,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED,wDAAwD;AACxD,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,6BAA6B;IAC7B,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,2CAA2C;IAC3C,QAAQ,EAAE,OAAO,CAAC;CACnB;AAGD,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAAC;AACnD,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,iBAAiB;IAChC,6DAA6D;IAC7D,IAAI,EAAE,OAAO,CAAC;IACd,+FAA+F;IAC/F,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,KAAK,EAAE,GAAG,CAAC;IACX,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,mFAAmF;IACnF,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,mEAAmE;IACnE,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,GAAG,EAAE,GAAG,CAAC;IACT,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,SAAS,GAAG,iBAAiB,GAAG,gBAAgB,CAAC;AAE7D,oCAAoC;AACpC,MAAM,WAAW,iBAAiB;IAChC,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,QAAQ,EAAE,OAAO,CAAC;IAClB,sBAAsB;IACtB,KAAK,EAAE,GAAG,CAAC;IACX,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,YAAY,EAAE,OAAO,sBAAsB,EAAE,kBAAkB,CAAC;KACjE;CACF"}