@dmlibs/dm-cmps 0.2.0 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dmlibs/dm-cmps",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "peerDependencies": {
     "@angular/common": "^22.0.0",
     "@angular/core": "^22.0.0"

package/types/dmlibs-dm-cmps.d.ts

@@ -56,6 +56,7 @@ declare class DmCmpsDataSource<T> implements DmCmpsDataSourceConfig<T> {
     firstPage(): number;
     lastPage(): number;
     getCurrentPageIndex(): number;
+    setCurrentPageIndex(index: number): number;
     getTotalPagesCount(): number;
     getFirstItemIndexInPage(): number;
     getLastItemIndexInPage(): number;
@@ -144,6 +145,12 @@ interface DmCmpsDataSourceConfig<T = any> {
      * @returns Current page index
      */
     getCurrentPageIndex: () => number;
+    /**
+     * Sets the current page index, clamped to the valid range [0, totalPagesCount - 1].
+     * @param index Requested page index
+     * @returns The applied (clamped) page index
+     */
+    setCurrentPageIndex: (index: number) => number;
     /**
      * Gets the total number of pages.
      * @returns Total pages count
@@ -822,6 +829,42 @@ interface DmTableColumnState {
     visible: boolean;
     order: number;
 }
+interface DmTableSaveStateOptions {
+    /**
+     * Persist column visibility/order.
+     * @default true
+     */
+    columns?: boolean;
+    /**
+     * Persist the paginator page size (page index is never persisted).
+     * @default false
+     */
+    paginator?: boolean;
+    /**
+     * Persist the sort state.
+     * @default false
+     */
+    sort?: boolean;
+    /**
+     * Persist the search text term.
+     * @default false
+     */
+    filter?: boolean;
+}
+/** Serializable sort entry — DmCmpsDataSourceSort without sortFn. */
+interface DmTablePersistedSort {
+    id?: string;
+    field: string;
+    direction: 'asc' | 'desc';
+}
+/** The blob stored in localStorage under `dm-table:state:<tableId>`. */
+interface DmTablePersistedState {
+    version: 1;
+    columns?: DmTableColumnState[];
+    pageSize?: number;
+    sort?: DmTablePersistedSort[];
+    filter?: string;
+}
 interface DmTablePrintData {
     headers: string[];
     rows: string[][];
@@ -1109,6 +1152,13 @@ interface DmTableInterface<T extends object> {
      * @default undefined
      */
     tableId: InputSignal<string | undefined>;
+    /**
+     * Save state - Controls which parts of the table state are persisted to the localStorage
+     * (requires tableId). Columns state is persisted by default; paginator (page size),
+     * sort and filter (search term) are opt-in.
+     * @default { columns: true, paginator: false, sort: false, filter: false }
+     */
+    saveState: InputSignal<DmTableSaveStateOptions | undefined>;
     /**
      * Table data source - An array of objects that will be displayed in the table.
      * @required
@@ -1359,6 +1409,8 @@ declare class DmTable<T extends object> implements DmTableInterface<T> {
     protected DEFAULT_PAGINATOR_SETTINGS: _dmlibs_dm_cmps.DmTablePaginatorSettings;
     protected DEFAULT_TABLE_STYLE: DmTableStyle;
     tableId: _angular_core.InputSignal<string | undefined>;
+    saveState: _angular_core.InputSignal<DmTableSaveStateOptions | undefined>;
+    private readonly saveStateResolved;
     dataSource: _angular_core.InputSignal<T[]>;
     columns: _angular_core.InputSignal<DmTableColumn<T>[]>;
     noDataMessage: _angular_core.InputSignal<string>;
@@ -1398,8 +1450,11 @@ declare class DmTable<T extends object> implements DmTableInterface<T> {
     protected datasource: _angular_core.WritableSignal<DmCmpsDataSource<T>>;
     protected readonly runtimeColumns: _angular_core.Signal<DmTableRuntimeColumn<T>[]>;
     protected hoveredColumnHeaderIndex: _angular_core.WritableSignal<number | null>;
-    private columnStateStorage;
+    private stateStorage;
     protected columnState: _angular_core.WritableSignal<DmTableColumnState[] | null>;
+    /** Restored-from-storage or user-chosen page size; wins over paginatorSettings().pageSize. */
+    private persistedPageSize;
+    private restoredForTableId;
     protected readonly visibleRuntimeColumns: _angular_core.Signal<DmTableRuntimeColumn<T>[]>;
     protected readonly visibleColumns: _angular_core.Signal<DmTableColumn<T>[]>;
     private prevColumns;
@@ -1410,6 +1465,7 @@ declare class DmTable<T extends object> implements DmTableInterface<T> {
     protected readonly totalRowStyles: _angular_core.Signal<Map<string, Record<string, any>>>;
     constructor(sanitizer: DomSanitizer);
     private runEffects;
+    private restoreNonColumnState;
     private initColumnState;
     private normalizeColumns;
     private isSameColumnDefinition;
@@ -1465,7 +1521,7 @@ declare class DmTable<T extends object> implements DmTableInterface<T> {
     protected rowDoubleClickHandler(row: T, event: Event): void;
     getDataForPrint: () => DmTablePrintData;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DmTable<any>, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DmTable<any>, "dm-table", never, { "tableId": { "alias": "tableId"; "required": false; "isSignal": true; }; "dataSource": { "alias": "dataSource"; "required": true; "isSignal": true; }; "columns": { "alias": "columns"; "required": true; "isSignal": true; }; "noDataMessage": { "alias": "noDataMessage"; "required": false; "isSignal": true; }; "enableSearch": { "alias": "enableSearch"; "required": false; "isSignal": true; }; "searchPlaceholder": { "alias": "searchPlaceholder"; "required": false; "isSignal": true; }; "clearSearchTooltip": { "alias": "clearSearchTooltip"; "required": false; "isSignal": true; }; "searchInputAppearance": { "alias": "searchInputAppearance"; "required": false; "isSignal": true; }; "filterPredicate": { "alias": "filterPredicate"; "required": false; "isSignal": true; }; "enableSperatedSearch": { "alias": "enableSperatedSearch"; "required": false; "isSignal": true; }; "actionButtons": { "alias": "actionButtons"; "required": false; "isSignal": true; }; "enablePrint": { "alias": "enablePrint"; "required": false; "isSignal": true; }; "printButton": { "alias": "printButton"; "required": false; "isSignal": true; }; "enablePagination": { "alias": "enablePagination"; "required": false; "isSignal": true; }; "autoPaginationAboveRowsCount": { "alias": "autoPaginationAboveRowsCount"; "required": false; "isSignal": true; }; "paginatorSettings": { "alias": "paginatorSettings"; "required": false; "isSignal": true; }; "enableLoadingProgressbar": { "alias": "enableLoadingProgressbar"; "required": false; "isSignal": true; }; "enableColumnsDragAndDrop": { "alias": "enableColumnsDragAndDrop"; "required": false; "isSignal": true; }; "enableColumnsDragHandle": { "alias": "enableColumnsDragHandle"; "required": false; "isSignal": true; }; "enableTotalRow": { "alias": "enableTotalRow"; "required": false; "isSignal": true; }; "tableStyle": { "alias": "tableStyle"; "required": false; "isSignal": true; }; "tableClasses": { "alias": "tableClasses"; "required": false; "isSignal": true; }; "rowStyleFn": { "alias": "rowStyleFn"; "required": false; "isSignal": true; }; "disableRowHoverStyling": { "alias": "disableRowHoverStyling"; "required": false; "isSignal": true; }; "editColumnsVisibility": { "alias": "editColumnsVisibility"; "required": false; "isSignal": true; }; "editColumnsVisibilityButton": { "alias": "editColumnsVisibilityButton"; "required": false; "isSignal": true; }; "editColumnsVisibilitySelectAllLabel": { "alias": "editColumnsVisibilitySelectAllLabel"; "required": false; "isSignal": true; }; "onRowDoubleClick": { "alias": "onRowDoubleClick"; "required": false; "isSignal": true; }; "enableLogs": { "alias": "enableLogs"; "required": false; "isSignal": true; }; "rowIdentifierField": { "alias": "rowIdentifierField"; "required": false; "isSignal": true; }; }, { "rowDoubleClick": "rowDoubleClick"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DmTable<any>, "dm-table", never, { "tableId": { "alias": "tableId"; "required": false; "isSignal": true; }; "saveState": { "alias": "saveState"; "required": false; "isSignal": true; }; "dataSource": { "alias": "dataSource"; "required": true; "isSignal": true; }; "columns": { "alias": "columns"; "required": true; "isSignal": true; }; "noDataMessage": { "alias": "noDataMessage"; "required": false; "isSignal": true; }; "enableSearch": { "alias": "enableSearch"; "required": false; "isSignal": true; }; "searchPlaceholder": { "alias": "searchPlaceholder"; "required": false; "isSignal": true; }; "clearSearchTooltip": { "alias": "clearSearchTooltip"; "required": false; "isSignal": true; }; "searchInputAppearance": { "alias": "searchInputAppearance"; "required": false; "isSignal": true; }; "filterPredicate": { "alias": "filterPredicate"; "required": false; "isSignal": true; }; "enableSperatedSearch": { "alias": "enableSperatedSearch"; "required": false; "isSignal": true; }; "actionButtons": { "alias": "actionButtons"; "required": false; "isSignal": true; }; "enablePrint": { "alias": "enablePrint"; "required": false; "isSignal": true; }; "printButton": { "alias": "printButton"; "required": false; "isSignal": true; }; "enablePagination": { "alias": "enablePagination"; "required": false; "isSignal": true; }; "autoPaginationAboveRowsCount": { "alias": "autoPaginationAboveRowsCount"; "required": false; "isSignal": true; }; "paginatorSettings": { "alias": "paginatorSettings"; "required": false; "isSignal": true; }; "enableLoadingProgressbar": { "alias": "enableLoadingProgressbar"; "required": false; "isSignal": true; }; "enableColumnsDragAndDrop": { "alias": "enableColumnsDragAndDrop"; "required": false; "isSignal": true; }; "enableColumnsDragHandle": { "alias": "enableColumnsDragHandle"; "required": false; "isSignal": true; }; "enableTotalRow": { "alias": "enableTotalRow"; "required": false; "isSignal": true; }; "tableStyle": { "alias": "tableStyle"; "required": false; "isSignal": true; }; "tableClasses": { "alias": "tableClasses"; "required": false; "isSignal": true; }; "rowStyleFn": { "alias": "rowStyleFn"; "required": false; "isSignal": true; }; "disableRowHoverStyling": { "alias": "disableRowHoverStyling"; "required": false; "isSignal": true; }; "editColumnsVisibility": { "alias": "editColumnsVisibility"; "required": false; "isSignal": true; }; "editColumnsVisibilityButton": { "alias": "editColumnsVisibilityButton"; "required": false; "isSignal": true; }; "editColumnsVisibilitySelectAllLabel": { "alias": "editColumnsVisibilitySelectAllLabel"; "required": false; "isSignal": true; }; "onRowDoubleClick": { "alias": "onRowDoubleClick"; "required": false; "isSignal": true; }; "enableLogs": { "alias": "enableLogs"; "required": false; "isSignal": true; }; "rowIdentifierField": { "alias": "rowIdentifierField"; "required": false; "isSignal": true; }; }, { "rowDoubleClick": "rowDoubleClick"; }, never, never, true, never>;
 }
 
 declare class DmIcon {
@@ -1734,4 +1790,4 @@ declare class DmRunOncePipe implements PipeTransform {
 }
 
 export { DmCmpsDataSource, DmColorPicker, DmDatePipe, DmDateService, DmFilterByPipe, DmIcon, DmMatSelect, DmRunOncePipe, DmRunOncePipeSevice, DmSpinner, DmSpinnerService, DmTable };
-export type { DmCmpsDataSourceSort, DmSelectOnSelectionChange, DmTableActionButton, DmTableClasses, DmTableColumn, DmTableColumnHeaderMenuItem, DmTablePaginatorSettings, DmTablePrintData, DmTableRowActionButton, DmTableRowDoubleClickEvent, DmTableStyle };
+export type { DmCmpsDataSourceSort, DmSelectOnSelectionChange, DmTableActionButton, DmTableClasses, DmTableColumn, DmTableColumnHeaderMenuItem, DmTableColumnState, DmTablePaginatorSettings, DmTablePersistedSort, DmTablePersistedState, DmTablePrintData, DmTableRowActionButton, DmTableRowDoubleClickEvent, DmTableSaveStateOptions, DmTableStyle };