@angular-bootstrap/ngbootstrap 0.0.9 → 0.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-bootstrap/ngbootstrap",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "Angular UI library providing datagrid, drag-and-drop, pagination, stepper, splitter, typeahead and chips components with Bootstrap-friendly styling.",
   "author": {
     "name": "Harmeet Singh"

package/types/angular-bootstrap-ngbootstrap.d.ts

@@ -113,6 +113,59 @@ interface NgbDataGridResponsiveOptions {
     };
 }
 
+type NgbDatagridTrackByFn<T> = (index: number, row: T) => any;
+interface NgbDatagridEditService<T> {
+    /**
+     * Create a new row in the provided data set.
+     * Implementations may mark the row as "new" until `saveChanges` is called.
+     */
+    create(data: readonly T[], newRow: T, rowIndex: number, rowId: any): T[];
+    /**
+     * Update an existing row in the provided data set.
+     * Implementations may snapshot the original row to support `cancelChanges` and `hasChanges`.
+     */
+    update(data: readonly T[], updatedRow: T, rowIndex: number, rowId: any): T[];
+    /**
+     * Remove a row from the provided data set.
+     */
+    remove(data: readonly T[], rowIndex: number, rowId: any): T[];
+    /**
+     * Used by the datagrid while editing to compute a new row instance.
+     * Default behavior is a shallow merge of the values into the row.
+     */
+    assignValues(row: T, values: Partial<T>): T;
+    /**
+     * Whether this row is considered newly created (not yet saved).
+     */
+    isNew(rowId: any): boolean;
+    /**
+     * Whether the row differs from its captured baseline (after `update`/`create` starts tracking).
+     */
+    hasChanges(rowId: any, currentRow: T): boolean;
+    /**
+     * Commit current changes (and clear tracking state) for the row.
+     */
+    saveChanges(data: readonly T[], rowIndex: number, rowId: any, currentRow: T): T[];
+    /**
+     * Revert tracked changes for the row (or remove it if it was new).
+     */
+    cancelChanges(data: readonly T[], rowIndex: number, rowId: any): T[];
+}
+declare class NgbDatagridDefaultEditService<T> implements NgbDatagridEditService<T> {
+    private originals;
+    private newRows;
+    create(data: readonly T[], newRow: T, _rowIndex: number, rowId: any): T[];
+    update(data: readonly T[], updatedRow: T, rowIndex: number, rowId: any): T[];
+    remove(data: readonly T[], rowIndex: number, rowId: any): T[];
+    assignValues(row: T, values: Partial<T>): T;
+    isNew(rowId: any): boolean;
+    hasChanges(rowId: any, currentRow: T): boolean;
+    saveChanges(data: readonly T[], _rowIndex: number, rowId: any, currentRow: T): T[];
+    cancelChanges(data: readonly T[], rowIndex: number, rowId: any): T[];
+    private replaceRow;
+    private removeRow;
+}
+
 interface ExportButtonContext {
     $implicit: (kind: 'pdf' | 'excel') => void;
 }
@@ -159,6 +212,8 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     exportOptions: NgbDataGridExportOptions;
     theme: NgbDataGridTheme;
     responsive: NgbDataGridResponsiveOptions | boolean;
+    trackBy?: NgbDatagridTrackByFn<T>;
+    editService?: NgbDatagridEditService<T>;
     dataProviderAll?: () => Observable<any[]> | Promise<any[]> | any[];
     dataProviderSelection?: () => any[];
     exportButtonDir?: ExportButtonDirective;
@@ -218,19 +273,18 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     saveAttemptedEdit: boolean;
     addForm: FormGroup;
     saveAttemptedNew: boolean;
+    private addDraftRowId;
+    private readonly defaultEditService;
     private norm;
     private keyOf;
-    private passesRowFilters;
     private getDefaults;
     private defaultFor;
     private numberValidator;
     private dateValidator;
     private buildFormFromRow;
-    private rowIsValidAgainst;
     private strictEmailValidator;
     get exportButtonTpl(): TemplateRef<ExportButtonContext> | null;
     get filtered(): T[];
-    private compare;
     get sorted(): T[];
     get paged(): T[];
     get anyFilterable(): boolean;
@@ -259,6 +313,8 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     private resolveDataset;
     ngAfterContentInit(): void;
     ngOnChanges(ch: SimpleChanges): void;
+    private getRowId;
+    private getEditService;
     startAdd(): void;
     saveAdd(): void;
     cancelAdd(): void;
@@ -268,7 +324,7 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     onNewDraftChange(col: ColumnDef<T>): void;
     validateInto(col: ColumnDef<T>, targetDraft: Partial<Record<KeyOf<T>, any>> | null, targetErrors: Partial<Record<KeyOf<T>, string>>): void;
     deleteRow(i: number): void;
-    trackRow: (_: number, row: T) => T;
+    trackRow: (index: number, row: T) => any;
     toggleSort(field: Extract<keyof T, string>): void;
     onGlobalFilterChange(): void;
     onColumnFilterChange(): void;
@@ -283,7 +339,7 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     triggerExport(kind: 'pdf' | 'excel'): void;
     isResponsiveEnabled(): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<Datagrid<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<Datagrid<any>, "ngb-datagrid", never, { "columns": { "alias": "columns"; "required": false; }; "data": { "alias": "data"; "required": false; }; "enableSorting": { "alias": "enableSorting"; "required": false; }; "enableFiltering": { "alias": "enableFiltering"; "required": false; }; "enableGlobalFilter": { "alias": "enableGlobalFilter"; "required": false; }; "enablePagination": { "alias": "enablePagination"; "required": false; }; "enableEdit": { "alias": "enableEdit"; "required": false; }; "enableDelete": { "alias": "enableDelete"; "required": false; }; "pageSizeOptions": { "alias": "pageSizeOptions"; "required": false; }; "enableAdd": { "alias": "enableAdd"; "required": false; }; "addButtonAriaLabel": { "alias": "addButtonAriaLabel"; "required": false; }; "addButtonText": { "alias": "addButtonText"; "required": false; }; "globalFilterAriaLabel": { "alias": "globalFilterAriaLabel"; "required": false; }; "expandRowAriaLabel": { "alias": "expandRowAriaLabel"; "required": false; }; "collapseRowAriaLabel": { "alias": "collapseRowAriaLabel"; "required": false; }; "exportPdfAriaLabel": { "alias": "exportPdfAriaLabel"; "required": false; }; "exportExcelAriaLabel": { "alias": "exportExcelAriaLabel"; "required": false; }; "newRowDefaults": { "alias": "newRowDefaults"; "required": false; }; "strictEmail": { "alias": "strictEmail"; "required": false; }; "editOnRowClick": { "alias": "editOnRowClick"; "required": false; }; "singleExpand": { "alias": "singleExpand"; "required": false; }; "exportOptions": { "alias": "exportOptions"; "required": false; }; "theme": { "alias": "theme"; "required": false; }; "responsive": { "alias": "responsive"; "required": false; }; "dataProviderAll": { "alias": "dataProviderAll"; "required": false; }; "dataProviderSelection": { "alias": "dataProviderSelection"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; }, { "rowAdd": "rowAdd"; "rowEdit": "rowEdit"; "rowSave": "rowSave"; "rowCancel": "rowCancel"; "rowDelete": "rowDelete"; "sortChange": "sortChange"; "filtersChange": "filtersChange"; "pageChange": "pageChange"; }, ["exportButtonDir", "rowDetailTpl", "cellTplQ", "editTplQ", "filterTplQ", "globalTplQ"], never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Datagrid<any>, "ngb-datagrid", never, { "columns": { "alias": "columns"; "required": false; }; "data": { "alias": "data"; "required": false; }; "enableSorting": { "alias": "enableSorting"; "required": false; }; "enableFiltering": { "alias": "enableFiltering"; "required": false; }; "enableGlobalFilter": { "alias": "enableGlobalFilter"; "required": false; }; "enablePagination": { "alias": "enablePagination"; "required": false; }; "enableEdit": { "alias": "enableEdit"; "required": false; }; "enableDelete": { "alias": "enableDelete"; "required": false; }; "pageSizeOptions": { "alias": "pageSizeOptions"; "required": false; }; "enableAdd": { "alias": "enableAdd"; "required": false; }; "addButtonAriaLabel": { "alias": "addButtonAriaLabel"; "required": false; }; "addButtonText": { "alias": "addButtonText"; "required": false; }; "globalFilterAriaLabel": { "alias": "globalFilterAriaLabel"; "required": false; }; "expandRowAriaLabel": { "alias": "expandRowAriaLabel"; "required": false; }; "collapseRowAriaLabel": { "alias": "collapseRowAriaLabel"; "required": false; }; "exportPdfAriaLabel": { "alias": "exportPdfAriaLabel"; "required": false; }; "exportExcelAriaLabel": { "alias": "exportExcelAriaLabel"; "required": false; }; "newRowDefaults": { "alias": "newRowDefaults"; "required": false; }; "strictEmail": { "alias": "strictEmail"; "required": false; }; "editOnRowClick": { "alias": "editOnRowClick"; "required": false; }; "singleExpand": { "alias": "singleExpand"; "required": false; }; "exportOptions": { "alias": "exportOptions"; "required": false; }; "theme": { "alias": "theme"; "required": false; }; "responsive": { "alias": "responsive"; "required": false; }; "trackBy": { "alias": "trackBy"; "required": false; }; "editService": { "alias": "editService"; "required": false; }; "dataProviderAll": { "alias": "dataProviderAll"; "required": false; }; "dataProviderSelection": { "alias": "dataProviderSelection"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; }, { "rowAdd": "rowAdd"; "rowEdit": "rowEdit"; "rowSave": "rowSave"; "rowCancel": "rowCancel"; "rowDelete": "rowDelete"; "sortChange": "sortChange"; "filtersChange": "filtersChange"; "pageChange": "pageChange"; }, ["exportButtonDir", "rowDetailTpl", "cellTplQ", "editTplQ", "filterTplQ", "globalTplQ"], never, true, never>;
 }
 
 interface PdfExportPayload {
@@ -831,5 +887,5 @@ declare class NgbChipsComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<NgbChipsComponent, "ngb-chips", never, { "items": { "alias": "items"; "required": false; }; "removable": { "alias": "removable"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "removeLabel": { "alias": "removeLabel"; "required": false; }; }, { "remove": "remove"; }, never, never, true, never>;
 }
 
-export { DATAGRID_TEMPLATE_DIRECTIVES, DND_I18N, DND_LIVE_ANNOUNCE, Datagrid, ExcelExportAdapter, ExportButtonDirective, JsPdfAdapter, NgbCellTemplate, NgbChipsComponent, NgbDndItemDirective, NgbDndListDirective, NgbDndState, NgbEditorTemplate, NgbExportService, NgbFilterTemplate, NgbGlobalFilterTemplate, NgbLiveAnnouncer, NgbPaginationComponent, NgbRowDetailTemplate, NgbSplitterComponent, NgbSplitterPaneComponent, NgbStepLabelDirective, NgbStepperComponent, NgbTreeComponent, NgbTypeaheadComponent, PdfExportAdapter, XlsxAdapter, defaultDndI18n };
-export type { CellCtx, ColumnDef, ColumnType, DndCanDropFn, DndCanDropPayload, DndI18n, DndSession, EditCtx, ExcelExportPayload, ExportButtonContext, FilterCtx, GlobalFilterCtx, NgbChip, NgbDataGridExportOptions, NgbDataGridExportPages, NgbDataGridExportType, NgbDataGridResponsiveOptions, NgbDataGridTheme, NgbDndDropEvent, NgbSplitterOrientation, NgbSplitterPaneSize, NgbStepperContentPosition, NgbStepperLabelPosition, NgbStepperOrientation, NgbStepperSelectionChangeEvent, NgbStepperState, NgbStepperStep, NgbStepperTheme, NgbTreeI18n, NgbTreeNode, NgbTreeType, NgbTypeaheadI18n, NgbTypeaheadItem, PdfExportPayload };
+export { DATAGRID_TEMPLATE_DIRECTIVES, DND_I18N, DND_LIVE_ANNOUNCE, Datagrid, ExcelExportAdapter, ExportButtonDirective, JsPdfAdapter, NgbCellTemplate, NgbChipsComponent, NgbDatagridDefaultEditService, NgbDndItemDirective, NgbDndListDirective, NgbDndState, NgbEditorTemplate, NgbExportService, NgbFilterTemplate, NgbGlobalFilterTemplate, NgbLiveAnnouncer, NgbPaginationComponent, NgbRowDetailTemplate, NgbSplitterComponent, NgbSplitterPaneComponent, NgbStepLabelDirective, NgbStepperComponent, NgbTreeComponent, NgbTypeaheadComponent, PdfExportAdapter, XlsxAdapter, defaultDndI18n };
+export type { CellCtx, ColumnDef, ColumnType, DndCanDropFn, DndCanDropPayload, DndI18n, DndSession, EditCtx, ExcelExportPayload, ExportButtonContext, FilterCtx, GlobalFilterCtx, NgbChip, NgbDataGridExportOptions, NgbDataGridExportPages, NgbDataGridExportType, NgbDataGridResponsiveOptions, NgbDataGridTheme, NgbDatagridEditService, NgbDatagridTrackByFn, NgbDndDropEvent, NgbSplitterOrientation, NgbSplitterPaneSize, NgbStepperContentPosition, NgbStepperLabelPosition, NgbStepperOrientation, NgbStepperSelectionChangeEvent, NgbStepperState, NgbStepperStep, NgbStepperTheme, NgbTreeI18n, NgbTreeNode, NgbTreeType, NgbTypeaheadI18n, NgbTypeaheadItem, PdfExportPayload };