@toolbox-web/grid 1.23.3 → 1.23.4

package/lib/plugins/column-virtualization/types.d.ts

@@ -3,7 +3,24 @@
  *
  * Type definitions for horizontal column virtualization feature.
  */
-/** Configuration options for the column virtualization plugin */
+/**
+ * Configuration for horizontal (column) virtualization.
+ *
+ * When enabled, only the columns visible in the viewport (plus an overscan buffer)
+ * are rendered to the DOM. This dramatically improves performance for grids with
+ * many columns (50+), as only a small subset of column cells exist at any time.
+ *
+ * By default, virtualization auto-enables when the column count exceeds `threshold`.
+ * Set `autoEnable: false` to control activation manually.
+ *
+ * @example
+ * ```typescript
+ * new ColumnVirtualizationPlugin({
+ *   threshold: 20,   // activate earlier than default
+ *   overscan: 5,     // render 5 extra columns on each side
+ * })
+ * ```
+ */
 export interface ColumnVirtualizationConfig {
     /** Auto-enable when column count exceeds threshold (default: true) */
     autoEnable?: boolean;
@@ -29,7 +46,12 @@ export interface ColumnVirtualizationState {
     /** Array of column left offsets (px) */
     columnOffsets: number[];
 }
-/** Viewport information for visible columns */
+/**
+ * Describes the currently visible column range.
+ *
+ * Returned by viewport queries; used internally to determine which column
+ * cells to render and which to skip during horizontal scroll updates.
+ */
 export interface ColumnVirtualizationViewport {
     /** Index of first visible column */
     startCol: number;

package/lib/plugins/column-virtualization/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/column-virtualization/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,iEAAiE;AACjE,MAAM,WAAW,0BAA0B;IACzC,sEAAsE;IACtE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,iEAAiE;AACjE,MAAM,WAAW,yBAAyB;IACxC,iDAAiD;IACjD,aAAa,EAAE,OAAO,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,wCAAwC;IACxC,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,+CAA+C;AAC/C,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,oBAAoB,EAAE,OAAO,8BAA8B,EAAE,0BAA0B,CAAC;KACzF;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/column-virtualization/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,0BAA0B;IACzC,sEAAsE;IACtE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,iEAAiE;AACjE,MAAM,WAAW,yBAAyB;IACxC,iDAAiD;IACjD,aAAa,EAAE,OAAO,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,wCAAwC;IACxC,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,oBAAoB,EAAE,OAAO,8BAA8B,EAAE,0BAA0B,CAAC;KACzF;CACF"}