@toolbox-web/grid 1.14.1 → 1.16.0

package/lib/plugins/pinned-columns/pinned-columns.d.ts

@@ -1,15 +1,24 @@
 import { TextDirection } from '../../core/internal/utils';
-import { ResolvedStickyPosition, StickyPosition } from './types';
+import { PinnedPosition, ResolvedPinnedPosition } from './types';
+type StickyPosition = PinnedPosition;
+type ResolvedStickyPosition = ResolvedPinnedPosition;
 /**
- * Resolve a sticky position to a physical position based on text direction.
+ * Get the effective pinned position from a column, checking `pinned` first then `sticky` (deprecated).
+ *
+ * @param col - Column configuration object
+ * @returns The pinned position, or undefined if not pinned
+ */
+export declare function getColumnPinned(col: any): PinnedPosition | undefined;
+/**
+ * Resolve a pinned position to a physical position based on text direction.
  *
  * - `'left'` / `'right'` → unchanged (physical values)
  * - `'start'` → `'left'` in LTR, `'right'` in RTL
  * - `'end'` → `'right'` in LTR, `'left'` in RTL
  *
- * @param position - The sticky position (logical or physical)
+ * @param position - The pinned position (logical or physical)
  * @param direction - Text direction ('ltr' or 'rtl')
- * @returns Physical sticky position ('left' or 'right')
+ * @returns Physical pinned position ('left' or 'right')
  */
 export declare function resolveStickyPosition(position: StickyPosition, direction: TextDirection): ResolvedStickyPosition;
 /**
@@ -70,10 +79,20 @@ export declare function calculateRightStickyOffsets(columns: any[], getColumnWid
  * @param columns - Array of column configurations
  */
 export declare function applyStickyOffsets(host: HTMLElement, columns: any[]): void;
+/**
+ * Reorder columns so that pinned-left columns come first and pinned-right columns come last.
+ * Maintains the relative order within each group (left-pinned, unpinned, right-pinned).
+ *
+ * @param columns - Array of column configurations (in their current order)
+ * @param direction - Text direction ('ltr' or 'rtl'), used to resolve logical positions
+ * @returns New array with pinned columns moved to the edges
+ */
+export declare function reorderColumnsForPinning(columns: readonly any[], direction?: TextDirection): any[];
 /**
  * Clear sticky positioning from all cells.
  *
  * @param host - The grid host element (render root for DOM queries)
  */
 export declare function clearStickyOffsets(host: HTMLElement): void;
+export {};
 //# sourceMappingURL=pinned-columns.d.ts.map

package/lib/plugins/pinned-columns/pinned-columns.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pinned-columns.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-columns/pinned-columns.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAuC,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACpG,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,aAAa,GAAG,sBAAsB,CAEhH;AAoBD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,SAAS,GAAE,aAAqB,GAAG,GAAG,EAAE,CAE5F;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,SAAS,GAAE,aAAqB,GAAG,GAAG,EAAE,CAE7F;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO,CAIxD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,GAAG,GAAG,cAAc,GAAG,IAAI,CAM1E;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,GAAG,EAAE,EACd,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EACzC,SAAS,GAAE,aAAqB,GAC/B,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAYrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,GAAG,EAAE,EACd,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EACzC,SAAS,GAAE,aAAqB,GAC/B,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAcrB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,CA2D1E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAS1D"}
+{"version":3,"file":"pinned-columns.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-columns/pinned-columns.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAuC,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACpG,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAGtE,KAAK,cAAc,GAAG,cAAc,CAAC;AACrC,KAAK,sBAAsB,GAAG,sBAAsB,CAAC;AAErD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc,GAAG,SAAS,CAEpE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,aAAa,GAAG,sBAAsB,CAEhH;AAoBD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,SAAS,GAAE,aAAqB,GAAG,GAAG,EAAE,CAE5F;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,SAAS,GAAE,aAAqB,GAAG,GAAG,EAAE,CAE7F;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO,CAExD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,GAAG,GAAG,cAAc,GAAG,IAAI,CAE1E;AAGD;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,GAAG,EAAE,EACd,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EACzC,SAAS,GAAE,aAAqB,GAC/B,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAYrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,GAAG,EAAE,EACd,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EACzC,SAAS,GAAE,aAAqB,GAC/B,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAcrB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,CAgD1E;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,SAAS,GAAG,EAAE,EAAE,SAAS,GAAE,aAAqB,GAAG,GAAG,EAAE,CAiBzG;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAS1D"}

package/lib/plugins/pinned-columns/types.d.ts

@@ -1,10 +1,10 @@
 /**
- * Sticky Columns Plugin Types
+ * Pinned Columns Plugin Types
  *
  * Type definitions for column pinning (sticky left/right columns).
  */
 /**
- * Sticky column position.
+ * Column pin position.
  *
  * **Physical values** (always pin to specified side):
  * - `'left'` - Pin to left edge
@@ -20,20 +20,28 @@
  * @example
  * ```typescript
  * // Physical - always pins to left side regardless of direction
- * { field: 'id', sticky: 'left' }
+ * { field: 'id', pinned: 'left' }
  *
  * // Logical - pins to visual start (left in LTR, right in RTL)
- * { field: 'id', sticky: 'start' }
+ * { field: 'id', pinned: 'start' }
  * ```
  */
-export type StickyPosition = 'left' | 'right' | 'start' | 'end';
+export type PinnedPosition = 'left' | 'right' | 'start' | 'end';
 /**
- * Physical sticky position after resolving logical values.
+ * @deprecated Use {@link PinnedPosition} instead. Will be removed in a future major version.
+ */
+export type StickyPosition = PinnedPosition;
+/**
+ * Physical pin position after resolving logical values.
  * Used internally after applying RTL resolution.
  */
-export type ResolvedStickyPosition = 'left' | 'right';
+export type ResolvedPinnedPosition = 'left' | 'right';
+/**
+ * @deprecated Use {@link ResolvedPinnedPosition} instead. Will be removed in a future major version.
+ */
+export type ResolvedStickyPosition = ResolvedPinnedPosition;
 /**
- * When PinnedColumnsPlugin is imported, the `sticky` property becomes available on column config.
+ * When PinnedColumnsPlugin is imported, the `pinned` property becomes available on column config.
  * This augments the core BaseColumnConfig interface.
  */
 declare module '../../core/types' {
@@ -51,7 +59,11 @@ declare module '../../core/types' {
          *
          * Requires PinnedColumnsPlugin.
          */
-        sticky?: StickyPosition;
+        pinned?: PinnedPosition;
+        /**
+         * @deprecated Use `pinned` instead. Will be removed in a future major version.
+         */
+        sticky?: PinnedPosition;
     }
 }
 /** Configuration options for the pinned columns plugin */

package/lib/plugins/pinned-columns/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-columns/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,OAAO,CAAC;AAMtD;;;GAGG;AACH,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,gBAAgB,CAAC,IAAI,EAAE,MAAM;QACrC;;;;;;;;;;;;WAYG;QACH,MAAM,CAAC,EAAE,cAAc,CAAC;KACzB;CACF;AAED,0DAA0D;AAE1D,MAAM,WAAW,mBAAmB;CAEnC;AAED,0DAA0D;AAC1D,MAAM,WAAW,kBAAkB;IACjC,mDAAmD;IACnD,SAAS,EAAE,OAAO,CAAC;IACnB,mCAAmC;IACnC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,oCAAoC;IACpC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-columns/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,cAAc,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,OAAO,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAC;AAM5D;;;GAGG;AACH,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,gBAAgB,CAAC,IAAI,EAAE,MAAM;QACrC;;;;;;;;;;;;WAYG;QACH,MAAM,CAAC,EAAE,cAAc,CAAC;QAExB;;WAEG;QACH,MAAM,CAAC,EAAE,cAAc,CAAC;KACzB;CACF;AAED,0DAA0D;AAE1D,MAAM,WAAW,mBAAmB;CAEnC;AAED,0DAA0D;AAC1D,MAAM,WAAW,kBAAkB;IACjC,mDAAmD;IACnD,SAAS,EAAE,OAAO,CAAC;IACnB,mCAAmC;IACnC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,oCAAoC;IACpC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC"}