@angular-bootstrap/ngbootstrap 0.0.11 → 0.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-bootstrap/ngbootstrap",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "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

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { TemplateRef, AfterContentInit, OnChanges, EventEmitter, SimpleChanges, InjectionToken, QueryList, ElementRef, AfterViewInit, OnDestroy, ChangeDetectorRef } from '@angular/core';
+import { TemplateRef, AfterContentInit, AfterViewInit, OnChanges, ElementRef, EventEmitter, SimpleChanges, InjectionToken, QueryList, OnDestroy, ChangeDetectorRef } from '@angular/core';
 import { AbstractControl, FormGroup, FormControl, ControlValueAccessor } from '@angular/forms';
 import { Observable } from 'rxjs';
 
@@ -175,9 +175,43 @@ declare class ExportButtonDirective {
     static ɵdir: i0.ɵɵDirectiveDeclaration<ExportButtonDirective, "[ngbExportButton]", never, {}, {}, never, never, true, never>;
 }
 
+interface HighlightItem {
+    row: any;
+    columnKey?: any;
+}
+
 type SortDir = 'asc' | 'desc' | '';
 type KeyOf<T> = Extract<keyof T, string>;
-declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
+type NgbTableResponsive = true | false | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
+interface NgbTableOptions {
+    stripedRows?: boolean;
+    stripedColumns?: boolean;
+    hoverRows?: boolean;
+    activeRows?: boolean;
+    bordered?: boolean;
+    borderless?: boolean;
+    small?: boolean;
+    groupDividers?: boolean;
+    align?: 'top' | 'middle' | 'bottom';
+    caption?: string;
+    captionSide?: 'top' | 'bottom';
+    responsive?: NgbTableResponsive;
+    stickyHeader?: boolean;
+    stickyFooter?: boolean;
+    stickyRows?: boolean;
+}
+type NgbSelectionMode = 'none' | 'single' | 'multiple';
+type NgbSelectionBehavior = 'row' | 'checkbox' | 'both';
+type NgbSelectionKeyMode = 'desktop' | 'mobile';
+type NgbRowKey = string | ((row: any, rowIndex: number) => any);
+type NgbColKey = string | ((column: any, columnIndex: number) => any);
+interface NgbSelectionLabels {
+    selectAll?: string;
+    unselectAll?: string;
+    selectRow?: string;
+    unselectRow?: string;
+}
+declare class Datagrid<T = any> implements AfterContentInit, AfterViewInit, OnChanges {
     /** Column definitions to render */
     columns: ColumnDef<T>[];
     /** Row data to display */
@@ -194,6 +228,41 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     addButtonAriaLabel: string | null;
     /** Visible text rendered inside the add-row button. */
     addButtonText: string;
+    /** Shows sticky toggle column and keeps pinned rows at the top of the list. */
+    stickyRows: boolean;
+    /** Enables sticky column header when scrolling. */
+    stickyHeader: boolean;
+    /** Enables sticky footer when scrolling. */
+    stickyFooter: boolean;
+    /** Enables scroll container (used when pagination is off). */
+    scrollable: boolean;
+    /** Row height used to stack multiple sticky rows without overlap (px). */
+    stickyRowHeight: number;
+    /** Header height (px) used to offset sticky rows below the header. */
+    stickyHeaderHeight: number;
+    /** Footer height (px) used to offset scrollable area. */
+    stickyFooterHeight: number;
+    /** Bootstrap-like table styling options. */
+    tableOptions: NgbTableOptions;
+    /** Selection mode for rows. */
+    selectionMode: NgbSelectionMode;
+    /** Selection activation: row click, checkbox only, or both. */
+    selectionBehavior: NgbSelectionBehavior;
+    /** Keyboard modifier rules for multi-select. */
+    selectionKeyMode: NgbSelectionKeyMode;
+    /** Enable header select-all checkbox for multiple mode. */
+    selectAllEnabled: boolean;
+    /** A11y labels for selection controls. */
+    selectionA11yLabels: NgbSelectionLabels;
+    /** Disable selection for specific rows. */
+    selectionDisabledFn?: (row: T, index: number) => boolean;
+    /** Highlight items (row/cell). */
+    highlightedIndex: HighlightItem[];
+    /** Row key for highlighting. */
+    highlightRowKey: NgbRowKey | null;
+    /** Column key for highlighting. */
+    highlightColKey: NgbColKey | null;
+    scrollbarWidth: number;
     /** Accessible label for the global filter input. */
     globalFilterAriaLabel: string;
     /** Accessible label announced when expanding a row. */
@@ -217,6 +286,9 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     dataProviderAll?: () => Observable<any[]> | Promise<any[]> | any[];
     dataProviderSelection?: () => any[];
     exportButtonDir?: ExportButtonDirective;
+    bodyScroller?: ElementRef<HTMLElement>;
+    headerScroller?: ElementRef<HTMLElement>;
+    colgroupSyncId: string;
     exporting: boolean;
     rowAdd: EventEmitter<{
         newRow: T;
@@ -250,6 +322,14 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
         page: number;
         pageSize: number;
     }>;
+    selectionChange: EventEmitter<{
+        selected: T[];
+        lastAction: {
+            row: T;
+            index: number;
+            selected: boolean;
+        } | null;
+    }>;
     rowDetailTpl?: NgbRowDetailTemplate<T>;
     private exporter;
     expanded: Set<number>;
@@ -263,6 +343,10 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
         active: Extract<keyof T, string> | null;
         direction: SortDir;
     };
+    stickyRowIds: Set<any>;
+    selectedRowIds: Set<any>;
+    private selectionAnchor;
+    private highlightRowMap;
     globalFilter: string;
     filters: Record<string, string>;
     page: number;
@@ -275,6 +359,7 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     saveAttemptedNew: boolean;
     private addDraftRowId;
     private readonly defaultEditService;
+    private cdr;
     private norm;
     private keyOf;
     private getDefaults;
@@ -290,13 +375,20 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     get anyFilterable(): boolean;
     get startIndex(): number;
     get endIndex(): number;
+    get shouldEnableScroll(): boolean;
+    get isHeaderSticky(): boolean;
+    get isFooterSticky(): boolean;
     get detailColspan(): number;
+    get tableClassList(): string[];
+    get responsiveWrapperClasses(): string[];
+    updateHighlightCache(): void;
     headerText(col: ColumnDef<T>): string;
     columnFilterAriaLabel(col: ColumnDef<T>): string;
     inputAriaLabel(col: ColumnDef<T>): string;
     ariaSortFor(field: Extract<keyof T, string>): 'ascending' | 'descending' | 'none';
     sortButtonAriaLabel(col: ColumnDef<T>): string;
     exportAriaLabel(kind: 'pdf' | 'excel'): string;
+    private withStickyRowsFirst;
     private dataIndexFromPaged;
     private rebuildFilterForm;
     private cellTplQ;
@@ -312,6 +404,7 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     export(kind: 'pdf' | 'excel'): Promise<void>;
     private resolveDataset;
     ngAfterContentInit(): void;
+    ngAfterViewInit(): void;
     ngOnChanges(ch: SimpleChanges): void;
     private getRowId;
     private getEditService;
@@ -325,6 +418,10 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     validateInto(col: ColumnDef<T>, targetDraft: Partial<Record<KeyOf<T>, any>> | null, targetErrors: Partial<Record<KeyOf<T>, string>>): void;
     deleteRow(i: number): void;
     trackRow: (index: number, row: T) => any;
+    private rowKeyValue;
+    private colKeyValue;
+    isRowHighlighted(row: T, rowIndex: number): boolean;
+    isCellHighlighted(row: T, rowIndex: number, column: ColumnDef<T>, colIndex: number): boolean;
     toggleSort(field: Extract<keyof T, string>): void;
     onGlobalFilterChange(): void;
     onColumnFilterChange(): void;
@@ -338,8 +435,29 @@ declare class Datagrid<T = any> implements AfterContentInit, OnChanges {
     asBool(v: any): boolean;
     triggerExport(kind: 'pdf' | 'excel'): void;
     isResponsiveEnabled(): boolean;
+    isRowSticky(row: T, pagedIndex: number): boolean;
+    toggleStickyRow(pagedIndex: number): void;
+    stickyIcon(row: T, pagedIndex: number): string;
+    stickyTop(row: T, pagedIndex: number): number | null;
+    get stickyRowsEnabled(): boolean;
+    get stickyHeaderEnabled(): boolean;
+    get stickyFooterEnabled(): boolean;
+    isSelectionEnabled(): boolean;
+    isCheckboxOnly(): boolean;
+    isSelectionDisabled(row: T, pagedIndex: number): boolean;
+    isRowSelected(row: T, pagedIndex: number): boolean;
+    toggleSelection(pagedIndex: number, event?: Event): void;
+    private emitSelection;
+    toggleSelectAllCurrentPage(): void;
+    isPageAllSelected(): boolean;
+    isPageIndeterminate(): boolean;
+    selectAllLabel(): string;
+    rowSelectionLabel(index: number): string;
+    onRowSelect(ev: MouseEvent, pagedIndex: number): void;
+    onHeaderScroll(): void;
+    private syncScrollbarWidth;
     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; }; "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>;
+    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; }; "stickyRows": { "alias": "stickyRows"; "required": false; }; "stickyHeader": { "alias": "stickyHeader"; "required": false; }; "stickyFooter": { "alias": "stickyFooter"; "required": false; }; "scrollable": { "alias": "scrollable"; "required": false; }; "stickyRowHeight": { "alias": "stickyRowHeight"; "required": false; }; "stickyHeaderHeight": { "alias": "stickyHeaderHeight"; "required": false; }; "stickyFooterHeight": { "alias": "stickyFooterHeight"; "required": false; }; "tableOptions": { "alias": "tableOptions"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "selectionBehavior": { "alias": "selectionBehavior"; "required": false; }; "selectionKeyMode": { "alias": "selectionKeyMode"; "required": false; }; "selectAllEnabled": { "alias": "selectAllEnabled"; "required": false; }; "selectionA11yLabels": { "alias": "selectionA11yLabels"; "required": false; }; "selectionDisabledFn": { "alias": "selectionDisabledFn"; "required": false; }; "highlightedIndex": { "alias": "highlightedIndex"; "required": false; }; "highlightRowKey": { "alias": "highlightRowKey"; "required": false; }; "highlightColKey": { "alias": "highlightColKey"; "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"; "selectionChange": "selectionChange"; }, ["exportButtonDir", "rowDetailTpl", "cellTplQ", "editTplQ", "filterTplQ", "globalTplQ"], never, true, never>;
 }
 
 interface PdfExportPayload {
@@ -888,4 +1006,4 @@ declare class NgbChipsComponent {
 }
 
 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 };
+export type { CellCtx, ColumnDef, ColumnType, DndCanDropFn, DndCanDropPayload, DndI18n, DndSession, EditCtx, ExcelExportPayload, ExportButtonContext, FilterCtx, GlobalFilterCtx, NgbChip, NgbColKey, NgbDataGridExportOptions, NgbDataGridExportPages, NgbDataGridExportType, NgbDataGridResponsiveOptions, NgbDataGridTheme, NgbDatagridEditService, NgbDatagridTrackByFn, NgbDndDropEvent, NgbRowKey, NgbSelectionBehavior, NgbSelectionKeyMode, NgbSelectionLabels, NgbSelectionMode, NgbSplitterOrientation, NgbSplitterPaneSize, NgbStepperContentPosition, NgbStepperLabelPosition, NgbStepperOrientation, NgbStepperSelectionChangeEvent, NgbStepperState, NgbStepperStep, NgbStepperTheme, NgbTableOptions, NgbTableResponsive, NgbTreeI18n, NgbTreeNode, NgbTreeType, NgbTypeaheadI18n, NgbTypeaheadItem, PdfExportPayload };