@toolbox-web/grid 1.23.3 → 1.23.4

package/lib/plugins/multi-sort/types.d.ts

@@ -3,18 +3,52 @@
  *
  * Type definitions for the multi-column sorting feature.
  */
-/** Represents a single column sort configuration */
+/**
+ * Represents a single column's sort configuration within a multi-sort model.
+ *
+ * The **order** of `SortModel` entries in the array determines sort precedence:
+ * the first entry is the primary sort, the second breaks ties in the primary, and so on.
+ *
+ * @example
+ * ```typescript
+ * // Primary: department ascending, secondary: salary descending
+ * const sortModel: SortModel[] = [
+ *   { field: 'department', direction: 'asc' },
+ *   { field: 'salary', direction: 'desc' },
+ * ];
+ * ```
+ */
 export interface SortModel {
-    /** The field key to sort by */
+    /** The column field key to sort by. Must match a `field` in the grid's column configuration. */
     field: string;
-    /** Sort direction */
+    /** Sort direction: `'asc'` for ascending (A→Z, 0→9), `'desc'` for descending (Z→A, 9→0). */
     direction: 'asc' | 'desc';
 }
-/** Configuration options for the multi-sort plugin */
+/**
+ * Configuration options for the multi-sort plugin.
+ *
+ * Multi-sort allows users to sort by multiple columns simultaneously.
+ * Users add sort columns by Shift+clicking column headers; the headers
+ * display numbered badges (1, 2, 3…) indicating sort precedence.
+ *
+ * @example
+ * ```typescript
+ * new MultiSortPlugin({ maxSortColumns: 5, showSortIndex: true })
+ * ```
+ */
 export interface MultiSortConfig {
-    /** Maximum number of columns to sort by (default: 3) */
+    /**
+     * Maximum number of columns that can be sorted simultaneously.
+     * Once the limit is reached, adding a new sort column replaces the oldest one.
+     * @default 3
+     */
     maxSortColumns?: number;
-    /** Whether to show sort order badges (1, 2, 3) on headers (default: true) */
+    /**
+     * Whether to show numbered badges (1, 2, 3…) on sorted column headers
+     * to indicate sort precedence. Disable for a cleaner look when precedence
+     * is not important to the user.
+     * @default true
+     */
     showSortIndex?: boolean;
 }
 /** Internal state managed by the multi-sort plugin */

package/lib/plugins/multi-sort/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/multi-sort/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,oDAAoD;AACpD,MAAM,WAAW,SAAS;IACxB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC;CAC3B;AAED,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,wDAAwD;IACxD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,wDAAwD;IACxD,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,SAAS,EAAE,OAAO,mBAAmB,EAAE,eAAe,CAAC;KACxD;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/multi-sort/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,SAAS;IACxB,gGAAgG;IAChG,KAAK,EAAE,MAAM,CAAC;IACd,4FAA4F;IAC5F,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,wDAAwD;IACxD,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,SAAS,EAAE,OAAO,mBAAmB,EAAE,eAAe,CAAC;KACxD;CACF"}