@akcelik/strct 5.8.0 → 5.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akcelik/strct",
-  "version": "5.8.0",
+  "version": "5.9.0",
   "description": "UIStruct — a standalone Angular component library with a tokenised, multi-palette theme system, built for datacenter / infrastructure management UIs.",
   "author": "Serkan Akcelik <serkan.akcelik@gmail.com>",
   "license": "MIT",

package/types/akcelik-strct.d.ts

@@ -3919,6 +3919,21 @@ interface StrctDatagridColumn {
      */
     editor?: 'text' | 'number' | 'select';
     /** Options for `editor: 'select'` (the library's own option shape). */
+    /**
+     * What this column sorts by, when the cell does not show it: "1.5 TB" is
+     * sorted by its bytes, a formatted date by its timestamp. `null` and `''`
+     * are "unread" and sort last in both directions.
+     */
+    sortValue?: (row: StrctRow) => unknown;
+    /** Full control of the order, when a key is not enough. Wins over `sortValue`. */
+    comparator?: (a: StrctRow, b: StrctRow) => number;
+    /** What an export writes for this column; defaults to the stored value. */
+    exportValue?: (row: StrctRow) => unknown;
+    /**
+     * Hidden until the chooser is asked for it — the column exists, it is just
+     * not one of the defaults. A persisted or bound `columnState` wins.
+     */
+    hidden?: boolean;
     /**
      * The choices an `editor: 'select'` offers. A function is asked per row: a
      * rule that holds a value the host no longer reports lists it for that row
@@ -3962,6 +3977,9 @@ interface StrctDatagridColumnState {
     widths?: Record<string, number>;
     hidden?: string[];
     order?: string[];
+    /** The column the operator sorted by, and which way. */
+    sortKey?: string | null;
+    sortDir?: 'asc' | 'desc';
 }
 /** One rendered tbody item: a data row, or a group header. */
 interface DgItem {
@@ -4473,11 +4491,28 @@ declare class StrctDatagrid {
     constructor();
     private readPersistedState;
     private applyColumnState;
+    /** Whether a persisted or bound state has already decided what is hidden. */
+    private hiddenDecidedByState;
+    /** Whether the columns' own `hidden` flags have been read (once). */
+    private declaredHiddenApplied;
+    /**
+     * Columns the consumer declared hidden — the default for a column no state
+     * mentions. A list that shows five of twenty columns says so on the columns,
+     * rather than seeding `columnState` and reaching into the library's storage
+     * key to keep from overriding what the operator chose.
+     */
+    private applyDeclaredHidden;
     /**
      * The grid as CSV: header labels + every non-hidden column, all rows in the
      * current order (client mode: the full sorted set, not just the page).
      */
     toCSV(): string;
+    /**
+     * What an export writes for a cell: what the column says, else the stored
+     * value. A templated cell shows "2 h 15 m" and stored 8100; without this the
+     * export carries the seconds, an enum code or a bare `true`.
+     */
+    private exportValueOf;
     /**
      * The grid as a real .xlsx workbook (dependency-free SpreadsheetML):
      * header labels + every non-hidden column in the current order, all rows in
@@ -4536,6 +4571,17 @@ declare class StrctDatagrid {
     /** Emit every selected row: fresh objects from the latest data where
      *  available, the last known snapshot otherwise (off-page lazy rows). */
     private commitSelection;
+    /**
+     * One row's sort key for a column: what the column says to sort by, else the
+     * stored value. A cell that shows "1.5 TB" sorts as text without this, which
+     * puts it before "900 GB"; a date written by toLocaleString sorts across
+     * days and AM/PM by its characters.
+     */
+    private sortKeyOf;
+    /** The column a key belongs to — the comparator and the sort key need it. */
+    private columnOf;
+    /** Compare two rows by a column, honouring its comparator and nulls-last. */
+    private compareRows;
     private compare;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<StrctDatagrid, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<StrctDatagrid, "strct-datagrid", never, { "columns": { "alias": "columns"; "required": true; "isSignal": true; }; "rows": { "alias": "rows"; "required": true; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "selectable": { "alias": "selectable"; "required": false; "isSignal": true; }; "expandable": { "alias": "expandable"; "required": false; "isSignal": true; }; "detailPane": { "alias": "detailPane"; "required": false; "isSignal": true; }; "compact": { "alias": "compact"; "required": false; "isSignal": true; }; "singleLine": { "alias": "singleLine"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "resizable": { "alias": "resizable"; "required": false; "isSignal": true; }; "columnChooser": { "alias": "columnChooser"; "required": false; "isSignal": true; }; "sync": { "alias": "sync"; "required": false; "isSignal": true; }; "footerActionsDisabled": { "alias": "footerActionsDisabled"; "required": false; "isSignal": true; }; "rowId": { "alias": "rowId"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "selectedId": { "alias": "selectedId"; "required": false; "isSignal": true; }; "rowSelectable": { "alias": "rowSelectable"; "required": false; "isSignal": true; }; "flush": { "alias": "flush"; "required": false; "isSignal": true; }; "caption": { "alias": "caption"; "required": false; "isSignal": true; }; "paging": { "alias": "paging"; "required": false; "isSignal": true; }; "hasMore": { "alias": "hasMore"; "required": false; "isSignal": true; }; "loadingMore": { "alias": "loadingMore"; "required": false; "isSignal": true; }; "moreTotal": { "alias": "moreTotal"; "required": false; "isSignal": true; }; "groupSelect": { "alias": "groupSelect"; "required": false; "isSignal": true; }; "rowActions": { "alias": "rowActions"; "required": false; "isSignal": true; }; "initialSelection": { "alias": "initialSelection"; "required": false; "isSignal": true; }; "selectedIds": { "alias": "selectedIds"; "required": false; "isSignal": true; }; "labels": { "alias": "labels"; "required": false; "isSignal": true; }; "virtual": { "alias": "virtual"; "required": false; "isSignal": true; }; "viewportHeight": { "alias": "viewportHeight"; "required": false; "isSignal": true; }; "maxHeight": { "alias": "maxHeight"; "required": false; "isSignal": true; }; "editHint": { "alias": "editHint"; "required": false; "isSignal": true; }; "rowHeight": { "alias": "rowHeight"; "required": false; "isSignal": true; }; "lazy": { "alias": "lazy"; "required": false; "isSignal": true; }; "total": { "alias": "total"; "required": false; "isSignal": true; }; "stateKey": { "alias": "stateKey"; "required": false; "isSignal": true; }; "columnState": { "alias": "columnState"; "required": false; "isSignal": true; }; "reorderable": { "alias": "reorderable"; "required": false; "isSignal": true; }; "groupBy": { "alias": "groupBy"; "required": false; "isSignal": true; }; "filters": { "alias": "filters"; "required": false; "isSignal": true; }; "quickFilter": { "alias": "quickFilter"; "required": false; "isSignal": true; }; "quickFilterFields": { "alias": "quickFilterFields"; "required": false; "isSignal": true; }; "quickFilterable": { "alias": "quickFilterable"; "required": false; "isSignal": true; }; "quickFilterAlign": { "alias": "quickFilterAlign"; "required": false; "isSignal": true; }; "childrenKey": { "alias": "childrenKey"; "required": false; "isSignal": true; }; }, { "selectedId": "selectedIdChange"; "loadMore": "loadMore"; "selectedIds": "selectedIdsChange"; "columnState": "columnStateChange"; "filters": "filtersChange"; "quickFilter": "quickFilterChange"; "selectionChange": "selectionChange"; "syncChange": "syncChange"; "rowAction": "rowAction"; "lazyLoad": "lazyLoad"; "cellEdit": "cellEdit"; }, ["detailDef", "actionBarDef", "actionBarCaptionDef", "cellDefs"], ["[strctDatagridActionBarCaption]", "[strctDatagridActionBar]"], true, never>;