@quadrel-enterprise-ui/framework 21.4.0 → 21.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quadrel-enterprise-ui/framework",
3
- "version": "21.4.0",
3
+ "version": "21.4.2",
4
4
  "exports": {
5
5
  "./jest-preset": "./jest-preset.js",
6
6
  "./package.json": {
@@ -2141,6 +2141,17 @@ interface QdTableRefreshConfig {
2141
2141
 
2142
2142
  /**
2143
2143
  * @description Type definition for tree data row object, including optional nested rows.
2144
+ *
2145
+ * A key without a column in "QdTreeConfig" is metadata. The tree never renders it, but keeps it on the row,
2146
+ * so it reaches the secondary action handlers. Use it for values that only the application needs,
2147
+ * for example the identifier of a record.
2148
+ *
2149
+ * @example
2150
+ * ```ts
2151
+ * type Columns = 'article' | 'mass' | 'recordId';
2152
+ *
2153
+ * const data: QdTreeData<Columns> = [{ article: 'Coffee', mass: 10, recordId: '0815' }];
2154
+ * ```
2144
2155
  */
2145
2156
  type QdTreeDataRow<T extends string> = Partial<Record<T, QdTreeDataValue | QdTreeDataValue[]>> & {
2146
2157
  uid?: string | number;
@@ -15393,44 +15404,44 @@ declare class QdSectionModule {
15393
15404
  static ɵinj: i0.ɵɵInjectorDeclaration<QdSectionModule>;
15394
15405
  }
15395
15406
 
15396
- /**
15397
- * Token for resolving table data in Angular applications.
15398
- */
15399
- declare const QD_TABLE_DATA_RESOLVER_TOKEN: InjectionToken<string>;
15407
+ declare enum QdTableConnectorState {
15408
+ NONE = "NONE",
15409
+ AWAITING = "AWAITING",
15410
+ ESTABLISHED = "ESTABLISHED"
15411
+ }
15400
15412
 
15401
- /**
15402
- * The pagination slice of `QdTableDataResolverProps`, following Spring Boot's `Pageable`
15403
- * conventions.
15404
- */
15405
- interface QdPaginationParams {
15406
- /**
15407
- * The zero-indexed page number, passed through verbatim (no off-by-one adjustment).
15408
- */
15409
- page?: number;
15410
- /**
15411
- * The number of items per page.
15412
- */
15413
- size?: number;
15413
+ interface QdTableState<T extends string> {
15414
+ data: QdTableData<T>;
15415
+ selectedRows?: QdTableRowIdentifier[];
15416
+ selectedRowsData?: Record<QdTableRowIdentifier, QdTableSelectedRow<string>>;
15417
+ recentSecondaryAction?: QdTableRecentSecondaryAction<T>;
15418
+ hasResolver?: boolean;
15419
+ hasPagination?: boolean;
15420
+ pageIndex?: number;
15421
+ pageSize?: number;
15422
+ totalCount?: number;
15423
+ sort?: QdTableStateSort<T>[];
15424
+ requestState?: QdTableRequestState;
15425
+ connectors?: QdTableConnector[];
15426
+ connectorCriteria?: QdTableConnectorCriteria;
15427
+ lastVisitedRowIdentifier?: QdTableRowIdentifier;
15428
+ }
15429
+ interface QdTablePaginatorCurrentPage {
15430
+ start: number;
15431
+ end: number;
15432
+ totalCount: number;
15433
+ }
15434
+ interface QdTableStateSort<T extends string> {
15435
+ column: T;
15436
+ direction: QdSortDirection;
15437
+ }
15438
+ interface QdTableConnector {
15439
+ connectorName: string;
15440
+ connectorState: QdTableConnectorState;
15441
+ }
15442
+ interface QdTableConnectorCriteria {
15443
+ [criteria: string]: unknown;
15414
15444
  }
15415
- /**
15416
- * **qdPaginationParameterize** turns pagination state into the `page` and `size` parameters read by the backend
15417
- * `QdPaginationParser`.
15418
- *
15419
- * ### Usage
15420
- *
15421
- * ```ts
15422
- * qdPaginationParameterize({ page: 0, size: 25 }).toQueryString(); // 'page=0&size=25'
15423
- * ```
15424
- *
15425
- * @remarks
15426
- * `page` stays zero-indexed and is sent as-is (no `+1`/`-1`), so `page=0` is kept. Each key is
15427
- * only set for a real number; `size` is trusted, not checked. Missing input gives empty
15428
- * parameters.
15429
- *
15430
- * @param input - The page and size from the resolver props.
15431
- * @returns A {@link QdQueryParameter} with the `page` and/or `size` keys.
15432
- */
15433
- declare function qdPaginationParameterize(input: QdPaginationParams | undefined): QdQueryParameter;
15434
15445
 
15435
15446
  /**
15436
15447
  * Represents the resolved data for a query.
@@ -15510,44 +15521,46 @@ declare enum QdTableRequestState {
15510
15521
  ERROR = 2
15511
15522
  }
15512
15523
 
15513
- declare enum QdTableConnectorState {
15514
- NONE = "NONE",
15515
- AWAITING = "AWAITING",
15516
- ESTABLISHED = "ESTABLISHED"
15517
- }
15524
+ /**
15525
+ * Token for resolving table data in Angular applications.
15526
+ *
15527
+ * Bind it to a class implementing `QdTableDataResolver`.
15528
+ */
15529
+ declare const QD_TABLE_DATA_RESOLVER_TOKEN: InjectionToken<QdTableDataResolver<string>>;
15518
15530
 
15519
- interface QdTableState<T extends string> {
15520
- data: QdTableData<T>;
15521
- selectedRows?: QdTableRowIdentifier[];
15522
- selectedRowsData?: Record<QdTableRowIdentifier, QdTableSelectedRow<string>>;
15523
- recentSecondaryAction?: QdTableRecentSecondaryAction<T>;
15524
- hasResolver?: boolean;
15525
- hasPagination?: boolean;
15526
- pageIndex?: number;
15527
- pageSize?: number;
15528
- totalCount?: number;
15529
- sort?: QdTableStateSort<T>[];
15530
- requestState?: QdTableRequestState;
15531
- connectors?: QdTableConnector[];
15532
- connectorCriteria?: QdTableConnectorCriteria;
15533
- lastVisitedRowIdentifier?: QdTableRowIdentifier;
15534
- }
15535
- interface QdTablePaginatorCurrentPage {
15536
- start: number;
15537
- end: number;
15538
- totalCount: number;
15539
- }
15540
- interface QdTableStateSort<T extends string> {
15541
- column: T;
15542
- direction: QdSortDirection;
15543
- }
15544
- interface QdTableConnector {
15545
- connectorName: string;
15546
- connectorState: QdTableConnectorState;
15547
- }
15548
- interface QdTableConnectorCriteria {
15549
- [criteria: string]: unknown;
15531
+ /**
15532
+ * The pagination slice of `QdTableDataResolverProps`, following Spring Boot's `Pageable`
15533
+ * conventions.
15534
+ */
15535
+ interface QdPaginationParams {
15536
+ /**
15537
+ * The zero-indexed page number, passed through verbatim (no off-by-one adjustment).
15538
+ */
15539
+ page?: number;
15540
+ /**
15541
+ * The number of items per page.
15542
+ */
15543
+ size?: number;
15550
15544
  }
15545
+ /**
15546
+ * **qdPaginationParameterize** turns pagination state into the `page` and `size` parameters read by the backend
15547
+ * `QdPaginationParser`.
15548
+ *
15549
+ * ### Usage
15550
+ *
15551
+ * ```ts
15552
+ * qdPaginationParameterize({ page: 0, size: 25 }).toQueryString(); // 'page=0&size=25'
15553
+ * ```
15554
+ *
15555
+ * @remarks
15556
+ * `page` stays zero-indexed and is sent as-is (no `+1`/`-1`), so `page=0` is kept. Each key is
15557
+ * only set for a real number; `size` is trusted, not checked. Missing input gives empty
15558
+ * parameters.
15559
+ *
15560
+ * @param input - The page and size from the resolver props.
15561
+ * @returns A {@link QdQueryParameter} with the `page` and/or `size` keys.
15562
+ */
15563
+ declare function qdPaginationParameterize(input: QdPaginationParams | undefined): QdQueryParameter;
15551
15564
 
15552
15565
  /**
15553
15566
  * **qdSortParameterize** turns table sort state into the Spring `sort=column,direction` format read by the backend
@@ -15720,6 +15733,8 @@ declare class QdTableComponent<T extends string> implements OnInit, OnChanges, O
15720
15733
  private readonly emptyStateService;
15721
15734
  private readonly responsiveRowService;
15722
15735
  private readonly fillingWidthService;
15736
+ private readonly scrollAnchorService;
15737
+ private readonly scrollAnchorHook;
15723
15738
  private readonly breakpointService;
15724
15739
  private readonly resolverService;
15725
15740
  private readonly confirmationDialogService;
@@ -15821,6 +15836,7 @@ declare class QdTableComponent<T extends string> implements OnInit, OnChanges, O
15821
15836
  private initializeResponsiveRowService;
15822
15837
  private updateResponsiveRowServiceTableConfig;
15823
15838
  private initializeFillingWidthService;
15839
+ private initializeScrollAnchorService;
15824
15840
  private updateFillingWidthServiceTableConfig;
15825
15841
  private initializeEmptyStateService;
15826
15842
  private initializeRowSelectionService;
@@ -15896,6 +15912,9 @@ type QdTreeActionResult = void | Observable<boolean>;
15896
15912
  interface QdTreeConfig<T extends string> {
15897
15913
  /**
15898
15914
  * @description Defines the columns of the tree.
15915
+ *
15916
+ * Only configured columns are rendered. A key of the tree data without a column here is metadata:
15917
+ * it stays on the row and reaches the handlers, but the tree shows no column for it.
15899
15918
  */
15900
15919
  columns: QdTreeConfigColumn<T>[];
15901
15920
  /**
@@ -16220,26 +16239,17 @@ declare class QdTreeComponent<T extends string> implements OnInit, OnChanges, On
16220
16239
  }
16221
16240
 
16222
16241
  /**
16223
- * The `QdScrollToPaginationDirective` directive makes it possible to scroll to the pagination section of a table when changing pages. It synchronizes with the page change events of the table and triggers scrolling when it is necessary to keep the pagination section accessible to the user.
16242
+ * Marks the element the view should end up at after a page change.
16224
16243
  *
16225
- * Apply this directive to the HTML element representing the pagination section of the QuickDesk table.
16244
+ * Apply it to the pagination section of the table.
16226
16245
  */
16227
- declare class QdScrollToPaginationDirective<T extends string> implements OnInit, OnDestroy {
16246
+ declare class QdScrollToPaginationDirective implements OnInit, OnDestroy {
16228
16247
  private readonly elementRef;
16229
- private readonly tableStoreService;
16230
- private readonly scrollingService;
16231
- private _destroyed$;
16232
- private _bottom;
16248
+ private readonly scrollAnchorService;
16233
16249
  ngOnInit(): void;
16234
16250
  ngOnDestroy(): void;
16235
- private getScrollBottom;
16236
- private handleScrollAnalysis;
16237
- private hasRequestBeenTriggered;
16238
- private hasRequestSucceeded;
16239
- private shouldScroll;
16240
- private performScrollIntoView;
16241
- static ɵfac: i0.ɵɵFactoryDeclaration<QdScrollToPaginationDirective<any>, never>;
16242
- static ɵdir: i0.ɵɵDirectiveDeclaration<QdScrollToPaginationDirective<any>, "[qdScrollToPagination]", never, {}, {}, never, never, false, never>;
16251
+ static ɵfac: i0.ɵɵFactoryDeclaration<QdScrollToPaginationDirective, never>;
16252
+ static ɵdir: i0.ɵɵDirectiveDeclaration<QdScrollToPaginationDirective, "[qdScrollToPagination]", never, {}, {}, never, never, false, never>;
16243
16253
  }
16244
16254
 
16245
16255
  declare class QdTableBodyComponent<T extends string> implements OnInit, OnDestroy {
@@ -16306,10 +16316,16 @@ declare enum QdPaginatorDirection {
16306
16316
  LastPage = 3
16307
16317
  }
16308
16318
 
16319
+ /**
16320
+ * Shows how many entries the current page holds and lets the user step through the pages.
16321
+ *
16322
+ * The table renders it on its own when the config carries a `pagination` section.
16323
+ */
16309
16324
  declare class QdTablePaginatorComponent<T extends string> implements OnInit, OnDestroy {
16310
16325
  private readonly tableDataResolver;
16311
16326
  private readonly tableStoreService;
16312
16327
  private readonly routerConnector;
16328
+ private readonly scrollAnchorService;
16313
16329
  /**
16314
16330
  * @description Configuration Model for Qd-Table.
16315
16331
  */
@@ -16348,7 +16364,17 @@ declare class QdTablePaginatorComponent<T extends string> implements OnInit, OnD
16348
16364
  * `pagination.pageSizes`, finally to the framework constant `PAGE_SIZE_DEFAULT`.
16349
16365
  */
16350
16366
  getPageSizeDefault(): number;
16367
+ /**
16368
+ * Navigates to another page after the user asked for it.
16369
+ *
16370
+ * Unlike `navigateToPage`, this tells the table that the view may follow the
16371
+ * pagination. Programmatic page changes must not use it.
16372
+ */
16373
+ navigateByUser(direction: QdPaginatorDirection): void;
16351
16374
  navigateToPage(direction: QdPaginatorDirection): void;
16375
+ private applyPageParams;
16376
+ private toCount;
16377
+ private getFirstOfferedPageSize;
16352
16378
  private isConfigValid;
16353
16379
  private startPagination;
16354
16380
  private initPagination;