@skyux/grids 12.23.0 → 13.0.0-alpha.0

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.
Files changed (25) hide show
  1. package/fesm2022/skyux-grids.mjs +21 -21
  2. package/fesm2022/skyux-grids.mjs.map +1 -1
  3. package/index.d.ts +584 -17
  4. package/package.json +13 -13
  5. package/lib/modules/grid/grid-adapter.service.d.ts +0 -17
  6. package/lib/modules/grid/grid-cell.component.d.ts +0 -19
  7. package/lib/modules/grid/grid-column.component.d.ts +0 -99
  8. package/lib/modules/grid/grid-column.model.d.ts +0 -25
  9. package/lib/modules/grid/grid.component.d.ts +0 -254
  10. package/lib/modules/grid/grid.module.d.ts +0 -23
  11. package/lib/modules/grid/types/grid-column-alignment.d.ts +0 -5
  12. package/lib/modules/grid/types/grid-column-description-model-change.d.ts +0 -9
  13. package/lib/modules/grid/types/grid-column-heading-model-change.d.ts +0 -9
  14. package/lib/modules/grid/types/grid-column-inline-help-popover-model-change.d.ts +0 -9
  15. package/lib/modules/grid/types/grid-column-width-model-change.d.ts +0 -17
  16. package/lib/modules/grid/types/grid-message-type.d.ts +0 -21
  17. package/lib/modules/grid/types/grid-message.d.ts +0 -21
  18. package/lib/modules/grid/types/grid-row-delete-cancel-args.d.ts +0 -7
  19. package/lib/modules/grid/types/grid-row-delete-config.d.ts +0 -8
  20. package/lib/modules/grid/types/grid-row-delete-confirm-args.d.ts +0 -7
  21. package/lib/modules/grid/types/grid-row-delete-contents.d.ts +0 -10
  22. package/lib/modules/grid/types/grid-selected-rows-model-change.d.ts +0 -16
  23. package/lib/modules/grid/types/grid-selected-rows-source.d.ts +0 -11
  24. package/lib/modules/grid/types/grid-ui-config.d.ts +0 -7
  25. package/lib/modules/shared/sky-grids-resources.module.d.ts +0 -10
package/index.d.ts CHANGED
@@ -1,17 +1,584 @@
1
- export { SkyGridColumnModel } from './lib/modules/grid/grid-column.model';
2
- export { SkyGridModule } from './lib/modules/grid/grid.module';
3
- export { SkyGridColumnAlignment } from './lib/modules/grid/types/grid-column-alignment';
4
- export { SkyGridColumnDescriptionModelChange } from './lib/modules/grid/types/grid-column-description-model-change';
5
- export { SkyGridColumnHeadingModelChange } from './lib/modules/grid/types/grid-column-heading-model-change';
6
- export { SkyGridColumnInlineHelpPopoverModelChange } from './lib/modules/grid/types/grid-column-inline-help-popover-model-change';
7
- export { SkyGridColumnWidthModelChange } from './lib/modules/grid/types/grid-column-width-model-change';
8
- export { SkyGridMessage } from './lib/modules/grid/types/grid-message';
9
- export { SkyGridMessageType } from './lib/modules/grid/types/grid-message-type';
10
- export { SkyGridRowDeleteCancelArgs } from './lib/modules/grid/types/grid-row-delete-cancel-args';
11
- export { SkyGridRowDeleteConfig } from './lib/modules/grid/types/grid-row-delete-config';
12
- export { SkyGridRowDeleteConfirmArgs } from './lib/modules/grid/types/grid-row-delete-confirm-args';
13
- export { SkyGridSelectedRowsModelChange } from './lib/modules/grid/types/grid-selected-rows-model-change';
14
- export { SkyGridSelectedRowsSource } from './lib/modules/grid/types/grid-selected-rows-source';
15
- export { SkyGridUIConfig } from './lib/modules/grid/types/grid-ui-config';
16
- export { SkyGridColumnComponent } from './lib/modules/grid/grid-column.component';
17
- export { SkyGridComponent } from './lib/modules/grid/grid.component';
1
+ import * as i0 from '@angular/core';
2
+ import { TemplateRef, RendererFactory2, ElementRef, OnInit, AfterContentInit, AfterViewInit, OnChanges, OnDestroy, EventEmitter, ChangeDetectorRef, SimpleChanges } from '@angular/core';
3
+ import * as i7 from '@skyux/core';
4
+ import { SkyAffixService, SkyOverlayService, SkyAppWindowRef, SkyUIConfigService, SkyLogService } from '@skyux/core';
5
+ import { ListSortFieldSelectorModel, ListItemModel } from '@skyux/list-builder-common';
6
+ import * as i5 from 'ng2-dragula';
7
+ import { DragulaService } from 'ng2-dragula';
8
+ import { Subject, BehaviorSubject, Observable } from 'rxjs';
9
+ import * as i4 from '@angular/common';
10
+ import * as i6 from '@angular/forms';
11
+ import * as i8 from '@skyux/forms';
12
+ import * as i1 from '@skyux/i18n';
13
+ import * as i10 from '@skyux/help-inline';
14
+ import * as i11 from '@skyux/icon';
15
+ import * as i12 from '@skyux/layout';
16
+ import * as i13 from '@skyux/popovers';
17
+ import * as i14 from '@skyux/indicators';
18
+
19
+ /**
20
+ * Represents the horizontal alignment of the column's data and header.
21
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
22
+ */
23
+ type SkyGridColumnAlignment = 'left' | 'center' | 'right';
24
+
25
+ /**
26
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
27
+ */
28
+ declare class SkyGridColumnModel {
29
+ template: TemplateRef<unknown>;
30
+ id: string;
31
+ field: string;
32
+ heading: string;
33
+ inlineHelpPopover: any;
34
+ type: string;
35
+ width: number;
36
+ hidden: boolean;
37
+ locked: boolean;
38
+ description: string;
39
+ isSortable: boolean;
40
+ excludeFromHighlighting: boolean;
41
+ /**
42
+ * The horizontal alignment of the column's data and header.
43
+ */
44
+ alignment: SkyGridColumnAlignment;
45
+ searchFunction: (data: any, searchText: string) => boolean;
46
+ constructor(template: TemplateRef<unknown>, data?: any);
47
+ }
48
+
49
+ /**
50
+ * @internal
51
+ */
52
+ declare class SkyGridAdapterService {
53
+ private rendererFactory;
54
+ private renderer;
55
+ constructor(rendererFactory: RendererFactory2);
56
+ initializeDragAndDrop(dragulaGroupName: string, dragulaService: DragulaService, dropCallback: (newColumnIds: string[]) => void): void;
57
+ getRowHeight(el: ElementRef, index: number): string;
58
+ setStyle(el: ElementRef, style: string, value: string): void;
59
+ private isLeftOfLocked;
60
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyGridAdapterService, never>;
61
+ static ɵprov: i0.ɵɵInjectableDeclaration<SkyGridAdapterService>;
62
+ }
63
+
64
+ /**
65
+ * @internal
66
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
67
+ */
68
+ interface SkyGridColumnDescriptionModelChange {
69
+ value?: string;
70
+ id?: string;
71
+ field?: string;
72
+ }
73
+
74
+ /**
75
+ * @internal
76
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
77
+ */
78
+ interface SkyGridColumnHeadingModelChange {
79
+ value?: string;
80
+ id?: string;
81
+ field?: string;
82
+ }
83
+
84
+ /**
85
+ * @internal
86
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
87
+ */
88
+ interface SkyGridColumnInlineHelpPopoverModelChange {
89
+ value?: any;
90
+ id?: string;
91
+ field?: string;
92
+ }
93
+
94
+ /**
95
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
96
+ */
97
+ interface SkyGridColumnWidthModelChange {
98
+ /**
99
+ * The ID of the column.
100
+ */
101
+ id?: string;
102
+ /**
103
+ * The field of the column.
104
+ */
105
+ field?: string;
106
+ /**
107
+ * The width of the column in pixels.
108
+ */
109
+ width: number;
110
+ }
111
+
112
+ /**
113
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
114
+ */
115
+ declare enum SkyGridMessageType {
116
+ /**
117
+ * Selects the multiselect checkboxes for all rows in the grid.
118
+ */
119
+ SelectAll = 0,
120
+ /**
121
+ * Clears the multiselect checkboxes for all rows in the grid.
122
+ */
123
+ ClearAll = 1,
124
+ /**
125
+ * @internal
126
+ */
127
+ PromptDeleteRow = 2,
128
+ /**
129
+ * @internal
130
+ */
131
+ AbortDeleteRow = 3
132
+ }
133
+
134
+ /**
135
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
136
+ */
137
+ interface SkyGridMessage {
138
+ /**
139
+ * The type of message being sent.
140
+ */
141
+ type: SkyGridMessageType;
142
+ /**
143
+ * @internal
144
+ */
145
+ data?: {
146
+ abortDeleteRow?: {
147
+ id: string;
148
+ };
149
+ promptDeleteRow?: {
150
+ id: string;
151
+ };
152
+ };
153
+ }
154
+
155
+ /**
156
+ * @internal
157
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
158
+ */
159
+ interface SkyGridRowDeleteCancelArgs {
160
+ id: string;
161
+ }
162
+
163
+ /**
164
+ * @internal
165
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
166
+ */
167
+ interface SkyGridRowDeleteConfig {
168
+ id: string;
169
+ pending: boolean;
170
+ }
171
+
172
+ /**
173
+ * @internal
174
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
175
+ */
176
+ interface SkyGridRowDeleteConfirmArgs {
177
+ id: string;
178
+ }
179
+
180
+ /**
181
+ * @internal
182
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
183
+ */
184
+ declare enum SkyGridSelectedRowsSource {
185
+ CheckboxChange = 0,
186
+ ClearAll = 1,
187
+ RowClick = 2,
188
+ SelectAll = 3,
189
+ SelectedRowIdsChange = 4
190
+ }
191
+
192
+ /**
193
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
194
+ */
195
+ interface SkyGridSelectedRowsModelChange {
196
+ /**
197
+ * The IDs of the rows that are selected.
198
+ */
199
+ selectedRowIds?: string[];
200
+ /**
201
+ * @internal
202
+ * Defines the source of the change. This will typically be used to determine
203
+ * if the change came from user interaction or a programmatic source.
204
+ */
205
+ source?: SkyGridSelectedRowsSource;
206
+ }
207
+
208
+ /**
209
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
210
+ */
211
+ declare class SkyGridComponent implements OnInit, AfterContentInit, AfterViewInit, OnChanges, OnDestroy {
212
+ #private;
213
+ private affixService;
214
+ private changeDetector;
215
+ private dragulaService;
216
+ private gridAdapter;
217
+ private overlayService;
218
+ private skyWindow;
219
+ private uiConfigService;
220
+ /**
221
+ * Columns and column properties for the grid.
222
+ */
223
+ set columns(newColumns: SkyGridColumnModel[]);
224
+ get columns(): SkyGridColumnModel[];
225
+ /**
226
+ * The data for the grid. Each item requires an `id` and a property that maps
227
+ * to the `field` or `id` property of each column in the grid.
228
+ */
229
+ data: any[];
230
+ /**
231
+ * Whether to enable the multiselect feature to display a column of
232
+ * checkboxes on the left side of the grid. You can specify a unique ID with
233
+ * the `multiselectRowId` property, but multiselect defaults to the `id` property on
234
+ * the `data` object.
235
+ * @default false
236
+ */
237
+ enableMultiselect: boolean;
238
+ /**
239
+ * How the grid fits to its parent. The valid options are `width`,
240
+ * which fits the grid to the parent's full width, and `scroll`, which allows the grid
241
+ * to exceed the parent's width. If the grid does not have enough columns to fill
242
+ * the parent's width, it always stretches to the parent's full width.
243
+ * @default "width"
244
+ */
245
+ fit: string;
246
+ /**
247
+ * Whether to display a toolbar with the grid.
248
+ */
249
+ hasToolbar: boolean;
250
+ /**
251
+ * The height of the grid.
252
+ */
253
+ height: number;
254
+ /**
255
+ * Text to highlight within the grid.
256
+ * Typically, this property is used in conjunction with search.
257
+ */
258
+ highlightText: string;
259
+ /**
260
+ * The observable to send commands to the grid.
261
+ */
262
+ messageStream: Subject<SkyGridMessage>;
263
+ /**
264
+ * The unique ID that matches a property on the `data` object.
265
+ * By default, this property uses the `id` property.
266
+ */
267
+ multiselectRowId: string;
268
+ /**
269
+ * The ID of the row to highlight. The ID matches the `id` property
270
+ * of the `data` object. Typically, this property is used in conjunction with
271
+ * the flyout component to indicate the currently selected row.
272
+ */
273
+ rowHighlightedId: string;
274
+ /**
275
+ * The columns to display in the grid based on the `id` or `field` properties
276
+ * of the columns. If no columns are specified, then the grid displays all columns.
277
+ */
278
+ set selectedColumnIds(value: string[]);
279
+ get selectedColumnIds(): string[];
280
+ /**
281
+ * The set of IDs for the rows to select in a multiselect grid.
282
+ * The IDs match the `id` properties of the `data` objects.
283
+ * Rows with IDs that are not included are de-selected in the grid.
284
+ */
285
+ set selectedRowIds(value: string[]);
286
+ get selectedRowIds(): string[];
287
+ /**
288
+ * The unique key for the UI Config Service to retrieve stored settings from a database.
289
+ * The UI Config Service saves configuration settings for users and returns
290
+ * `selectedColumnIds` to preserve the columns to display and the preferred column order. You must provide `id` values for your `sky-grid-column` elements because the UI Config Service depends on those values to organize columns based on user settings. For more information about the UI Config Service, see [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/develop/sticky-settings).
291
+ */
292
+ settingsKey: string;
293
+ /**
294
+ * Displays a caret in the column that was used to sort the grid. This is particularly useful
295
+ * when you programmatically sort data and want to visually indicate how the grid was sorted.
296
+ * This property accepts a `ListSortFieldSelectorModel` value with the following properties:
297
+ * - `fieldSelector` Represents the current sort field. This property accepts `string` values.
298
+ * - `descending` Indicates whether to sort in descending order. The caret that visually
299
+ * indicates the sort order points down for descending order and up for ascending order.
300
+ * This property accepts `boolean` values. Default is `false`.
301
+ */
302
+ sortField: ListSortFieldSelectorModel;
303
+ /**
304
+ * The width of the grid in pixels.
305
+ */
306
+ width: number;
307
+ /**
308
+ * Fires when the width of a column changes.
309
+ */
310
+ columnWidthChange: EventEmitter<SkyGridColumnWidthModelChange[]>;
311
+ /**
312
+ * Fires when the selection of multiselect checkboxes changes.
313
+ * Emits an array of IDs for the selected rows based on the `multiselectRowId` property
314
+ * that the consumer provides.
315
+ */
316
+ multiselectSelectionChange: EventEmitter<SkyGridSelectedRowsModelChange>;
317
+ /**
318
+ * @internal
319
+ */
320
+ rowDeleteCancel: EventEmitter<SkyGridRowDeleteCancelArgs>;
321
+ /**
322
+ * @internal
323
+ */
324
+ rowDeleteConfirm: EventEmitter<SkyGridRowDeleteConfirmArgs>;
325
+ /**
326
+ * Fires when the columns to display in the grid change or when the order of the columns changes.
327
+ * The event emits an array of IDs for the displayed columns that reflects the column order.
328
+ */
329
+ selectedColumnIdsChange: EventEmitter<string[]>;
330
+ /**
331
+ * Fires when the active sort field changes.
332
+ */
333
+ sortFieldChange: EventEmitter<ListSortFieldSelectorModel>;
334
+ columnResizeStep: number;
335
+ currentSortField: BehaviorSubject<ListSortFieldSelectorModel>;
336
+ displayedColumns: SkyGridColumnModel[];
337
+ dragulaGroupName: string;
338
+ gridId: number;
339
+ rowDeleteConfigs: SkyGridRowDeleteConfig[];
340
+ items: any[];
341
+ maxColWidth: number;
342
+ minColWidth: number;
343
+ showResizeBar: boolean;
344
+ showTopScroll: boolean;
345
+ get tableWidth(): any;
346
+ private columnComponents;
347
+ private columnElementRefs;
348
+ private columnRangeInputElementRefs;
349
+ private inlineDeleteRefs;
350
+ private inlineDeleteTemplateRef;
351
+ private tableContainerElementRef;
352
+ private tableElementRef;
353
+ private topScrollContainerElementRef;
354
+ private resizeBar;
355
+ private activeResizeColumnIndex;
356
+ private isDraggingResizeHandle;
357
+ private isResized;
358
+ private ngUnsubscribe;
359
+ private rowDeleteContents;
360
+ private startColumnWidth;
361
+ private subscriptions;
362
+ private scrollTriggered;
363
+ private selectedColumnIdsSet;
364
+ private xPosStart;
365
+ private _columns;
366
+ private _selectedColumnIds;
367
+ private _selectedRowIds;
368
+ constructor(affixService: SkyAffixService, changeDetector: ChangeDetectorRef, dragulaService: DragulaService, gridAdapter: SkyGridAdapterService, overlayService: SkyOverlayService, skyWindow: SkyAppWindowRef, uiConfigService: SkyUIConfigService, logger: SkyLogService);
369
+ ngOnInit(): void;
370
+ ngAfterContentInit(): void;
371
+ ngAfterViewInit(): void;
372
+ ngOnChanges(changes: SimpleChanges): void;
373
+ ngOnDestroy(): void;
374
+ onWindowResize(): void;
375
+ getTopScrollWidth(): string;
376
+ getTableClassNames(): string;
377
+ getTableHeaderClassNames(column: SkyGridColumnModel): string;
378
+ getCaretIconNames(column: SkyGridColumnModel): string;
379
+ onKeydown(event: KeyboardEvent, column: SkyGridColumnModel): void;
380
+ sortByColumn(column: SkyGridColumnModel): void;
381
+ getSortDirection(columnField: string): Observable<string>;
382
+ getAriaSortDirection(column: SkyGridColumnModel): Observable<string>;
383
+ getCaretVisibility(columnField: string): Observable<string>;
384
+ getHelpInlineClass(columnField: string): Observable<boolean>;
385
+ onMultiselectCheckboxChange(): void;
386
+ updateColumnHeading(change: SkyGridColumnHeadingModelChange): void;
387
+ updateInlineHelpPopover(change: SkyGridColumnInlineHelpPopoverModelChange): void;
388
+ updateColumnDescription(change: SkyGridColumnDescriptionModelChange): void;
389
+ onResizeColumnStart(event: {
390
+ stopPropagation: () => void;
391
+ preventDefault: () => void;
392
+ pageX?: number;
393
+ }): void;
394
+ onKeydownResizeCol(event: KeyboardEvent): void;
395
+ onInputChangeResizeCol(event: Event): void;
396
+ onResizeHandleMove(event: MouseEvent): void;
397
+ onResizeHandleBlur(): void;
398
+ onResizeHandleFocus(event: FocusEvent): void;
399
+ onResizeHandleRelease(event: MouseEvent): void;
400
+ onRowClick(event: any, selectedItem: ListItemModel): void;
401
+ isRowHighlighted(id: string): boolean;
402
+ getRowHeight(index: number): string;
403
+ cancelRowDelete(id: string): void;
404
+ confirmRowDelete(id: string): void;
405
+ getRowDeleteItem(id: string): SkyGridRowDeleteConfig;
406
+ onTouchMove(event: any): void;
407
+ onTopScroll(event: any): void;
408
+ onGridScroll(event: any): void;
409
+ private checkUserColumnWidthsForScroll;
410
+ private multiselectSelectAll;
411
+ private multiselectClearAll;
412
+ private handleIncomingMessages;
413
+ private onHeaderDrop;
414
+ private setDisplayedColumns;
415
+ private transformData;
416
+ private getGridDataWithSelectedRows;
417
+ private applySelectedRows;
418
+ private setSortHeaders;
419
+ private getColumnsFromComponent;
420
+ private updateColumns;
421
+ private resizeColumnByIndex;
422
+ private initColumnWidths;
423
+ private transferColumnWidths;
424
+ private getColumnWidthModelChange;
425
+ private updateMaxRange;
426
+ private initializeResizeColumn;
427
+ private resetTableWidth;
428
+ private getRangeInputByIndex;
429
+ private getColumnModelByIndex;
430
+ private getMaxRangeByIndex;
431
+ private getLastDisplayedColumn;
432
+ private addDelimiter;
433
+ private destroyRowDelete;
434
+ private emitSelectedRows;
435
+ private getSelectedRows;
436
+ private isInteractiveElement;
437
+ private setResizeBarPosition;
438
+ private applyUserConfig;
439
+ private setUserConfig;
440
+ private initColumns;
441
+ private arraysEqual;
442
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyGridComponent, never>;
443
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyGridComponent, "sky-grid", never, { "columns": { "alias": "columns"; "required": false; }; "data": { "alias": "data"; "required": false; }; "enableMultiselect": { "alias": "enableMultiselect"; "required": false; }; "fit": { "alias": "fit"; "required": false; }; "hasToolbar": { "alias": "hasToolbar"; "required": false; }; "height": { "alias": "height"; "required": false; }; "highlightText": { "alias": "highlightText"; "required": false; }; "messageStream": { "alias": "messageStream"; "required": false; }; "multiselectRowId": { "alias": "multiselectRowId"; "required": false; }; "rowHighlightedId": { "alias": "rowHighlightedId"; "required": false; }; "selectedColumnIds": { "alias": "selectedColumnIds"; "required": false; }; "selectedRowIds": { "alias": "selectedRowIds"; "required": false; }; "settingsKey": { "alias": "settingsKey"; "required": false; }; "sortField": { "alias": "sortField"; "required": false; }; "width": { "alias": "width"; "required": false; }; }, { "columnWidthChange": "columnWidthChange"; "multiselectSelectionChange": "multiselectSelectionChange"; "rowDeleteCancel": "rowDeleteCancel"; "rowDeleteConfirm": "rowDeleteConfirm"; "selectedColumnIdsChange": "selectedColumnIdsChange"; "sortFieldChange": "sortFieldChange"; }, ["columnComponents"], never, false, never>;
444
+ }
445
+
446
+ /**
447
+ * Specifies the column information.
448
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
449
+ */
450
+ declare class SkyGridColumnComponent implements OnChanges {
451
+ /**
452
+ * The horizontal alignment of the column's data and header.
453
+ * Options include: `"left"`, `"center"`, and `"right"`.
454
+ * @default "left"
455
+ */
456
+ alignment: SkyGridColumnAlignment;
457
+ /**
458
+ * The description for the column.
459
+ */
460
+ description: string;
461
+ /**
462
+ * Whether to disable the highlighting of search text in the column.
463
+ * @default false
464
+ */
465
+ excludeFromHighlighting: boolean;
466
+ /**
467
+ * The property to retrieve cell information from an entry on the grid `data` array.
468
+ * You must provide either the `id` or `field` property for every column,
469
+ * but do not provide both. If `id` does not exist on a column, then `field` is the entry
470
+ * for the grid `selectedColumnIds` array.
471
+ */
472
+ field: string;
473
+ /**
474
+ * Text to display in the column header.
475
+ */
476
+ heading: string;
477
+ /**
478
+ * Whether the column is initially hidden when grid `selectedColumnIds` are not provided.
479
+ * @default false
480
+ */
481
+ hidden: boolean;
482
+ /**
483
+ * The unique ID for the column. You must provide either the `id` or `field` property
484
+ * for every column, but do not provide both. If `field` does not exist on a column,
485
+ * then the `id` property retrieves cell information from an entry on the grid `data` array.
486
+ */
487
+ id: string;
488
+ /**
489
+ * The template to display inside an inline help popup for this column.
490
+ */
491
+ inlineHelpPopover: any;
492
+ /**
493
+ * Whether the column sorts the grid when users click the column header.
494
+ * @default true
495
+ */
496
+ isSortable: boolean;
497
+ /**
498
+ * Whether the column is locked. The intent is to display locked columns first
499
+ * on the left side of the grid. If set to `true`, then users cannot drag the column
500
+ * to another position and or drag other columns before the locked column.
501
+ * @default false
502
+ */
503
+ locked: boolean;
504
+ /**
505
+ * The search function to apply for the specific column. By default,
506
+ * the column executes a string compare on the column data.
507
+ * @default (value, searchText) => value.toString().toLowerCase().indexOf(searchText) !== -1
508
+ */
509
+ searchFunction: (value: any, searchText: string) => boolean;
510
+ /**
511
+ * @internal
512
+ */
513
+ type: string;
514
+ /**
515
+ * The template for a column. This can be assigned as a reference
516
+ * to the `template` attribute, or it can be assigned as a child of the `template` element
517
+ * inside the `sky-grid-column` component. The template has access to the `value` variable,
518
+ * which contains the value passed to the column, and the `row` variable, which contains
519
+ * the entire row data.
520
+ */
521
+ templateInput: TemplateRef<unknown>;
522
+ /**
523
+ * The width of the column in pixels.
524
+ * If undefined, the column width is evenly distributed.
525
+ */
526
+ width: number;
527
+ descriptionChanges: EventEmitter<string>;
528
+ descriptionModelChanges: EventEmitter<SkyGridColumnDescriptionModelChange>;
529
+ headingChanges: EventEmitter<string>;
530
+ headingModelChanges: EventEmitter<SkyGridColumnHeadingModelChange>;
531
+ inlineHelpPopoverModelChanges: EventEmitter<SkyGridColumnInlineHelpPopoverModelChange>;
532
+ private templates;
533
+ ngOnChanges(changes: SimpleChanges): void;
534
+ get template(): TemplateRef<unknown>;
535
+ private search;
536
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyGridColumnComponent, never>;
537
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyGridColumnComponent, "sky-grid-column", never, { "alignment": { "alias": "alignment"; "required": false; }; "description": { "alias": "description"; "required": false; }; "excludeFromHighlighting": { "alias": "excludeFromHighlighting"; "required": false; }; "field": { "alias": "field"; "required": false; }; "heading": { "alias": "heading"; "required": false; }; "hidden": { "alias": "hidden"; "required": false; }; "id": { "alias": "id"; "required": false; }; "inlineHelpPopover": { "alias": "inlineHelpPopover"; "required": false; }; "isSortable": { "alias": "isSortable"; "required": false; }; "locked": { "alias": "locked"; "required": false; }; "searchFunction": { "alias": "search"; "required": false; }; "type": { "alias": "type"; "required": false; }; "templateInput": { "alias": "template"; "required": false; }; "width": { "alias": "width"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;
538
+ }
539
+
540
+ /**
541
+ * @internal
542
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
543
+ */
544
+ declare class SkyGridCellComponent implements OnInit {
545
+ item: ListItemModel;
546
+ columnId: string;
547
+ template: TemplateRef<unknown>;
548
+ fieldSelector: string;
549
+ private container;
550
+ ngOnInit(): void;
551
+ get row(): any;
552
+ get value(): any;
553
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyGridCellComponent, never>;
554
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyGridCellComponent, "sky-grid-cell", never, { "item": { "alias": "item"; "required": false; }; "columnId": { "alias": "columnId"; "required": false; }; "template": { "alias": "template"; "required": false; }; "fieldSelector": { "alias": "fieldSelector"; "required": false; }; }, {}, never, never, false, never>;
555
+ }
556
+
557
+ /**
558
+ * Import into any component library module that needs to use resource strings.
559
+ */
560
+ declare class SkyGridsResourcesModule {
561
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyGridsResourcesModule, never>;
562
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyGridsResourcesModule, never, never, [typeof i1.SkyI18nModule]>;
563
+ static ɵinj: i0.ɵɵInjectorDeclaration<SkyGridsResourcesModule>;
564
+ }
565
+
566
+ /**
567
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
568
+ */
569
+ declare class SkyGridModule {
570
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyGridModule, never>;
571
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyGridModule, [typeof SkyGridComponent, typeof SkyGridColumnComponent, typeof SkyGridCellComponent], [typeof i4.CommonModule, typeof i5.DragulaModule, typeof i6.FormsModule, typeof i7.SkyAffixModule, typeof i8.SkyCheckboxModule, typeof SkyGridsResourcesModule, typeof i10.SkyHelpInlineModule, typeof i11.SkyIconModule, typeof i12.SkyInlineDeleteModule, typeof i13.SkyPopoverModule, typeof i14.SkyTextHighlightModule], [typeof SkyGridComponent, typeof SkyGridColumnComponent]>;
572
+ static ɵinj: i0.ɵɵInjectorDeclaration<SkyGridModule>;
573
+ }
574
+
575
+ /**
576
+ * @internal
577
+ * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid
578
+ */
579
+ interface SkyGridUIConfig {
580
+ selectedColumnIds?: string[];
581
+ }
582
+
583
+ export { SkyGridColumnComponent, SkyGridColumnModel, SkyGridComponent, SkyGridMessageType, SkyGridModule, SkyGridSelectedRowsSource };
584
+ export type { SkyGridColumnAlignment, SkyGridColumnDescriptionModelChange, SkyGridColumnHeadingModelChange, SkyGridColumnInlineHelpPopoverModelChange, SkyGridColumnWidthModelChange, SkyGridMessage, SkyGridRowDeleteCancelArgs, SkyGridRowDeleteConfig, SkyGridRowDeleteConfirmArgs, SkyGridSelectedRowsModelChange, SkyGridUIConfig };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/grids",
3
- "version": "12.23.0",
3
+ "version": "13.0.0-alpha.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -16,18 +16,18 @@
16
16
  },
17
17
  "homepage": "https://github.com/blackbaud/skyux#readme",
18
18
  "peerDependencies": {
19
- "@angular/common": "^19.2.14",
20
- "@angular/core": "^19.2.14",
21
- "@angular/forms": "^19.2.14",
22
- "@skyux/core": "12.23.0",
23
- "@skyux/forms": "12.23.0",
24
- "@skyux/help-inline": "12.23.0",
25
- "@skyux/i18n": "12.23.0",
26
- "@skyux/icon": "12.23.0",
27
- "@skyux/indicators": "12.23.0",
28
- "@skyux/layout": "12.23.0",
29
- "@skyux/list-builder-common": "12.23.0",
30
- "@skyux/popovers": "12.23.0"
19
+ "@angular/common": "^20.0.5",
20
+ "@angular/core": "^20.0.5",
21
+ "@angular/forms": "^20.0.5",
22
+ "@skyux/core": "13.0.0-alpha.0",
23
+ "@skyux/forms": "13.0.0-alpha.0",
24
+ "@skyux/help-inline": "13.0.0-alpha.0",
25
+ "@skyux/i18n": "13.0.0-alpha.0",
26
+ "@skyux/icon": "13.0.0-alpha.0",
27
+ "@skyux/indicators": "13.0.0-alpha.0",
28
+ "@skyux/layout": "13.0.0-alpha.0",
29
+ "@skyux/list-builder-common": "13.0.0-alpha.0",
30
+ "@skyux/popovers": "13.0.0-alpha.0"
31
31
  },
32
32
  "dependencies": {
33
33
  "@types/dragula": "2.1.36",
@@ -1,17 +0,0 @@
1
- import { ElementRef, RendererFactory2 } from '@angular/core';
2
- import { DragulaService } from 'ng2-dragula';
3
- import * as i0 from "@angular/core";
4
- /**
5
- * @internal
6
- */
7
- export declare class SkyGridAdapterService {
8
- private rendererFactory;
9
- private renderer;
10
- constructor(rendererFactory: RendererFactory2);
11
- initializeDragAndDrop(dragulaGroupName: string, dragulaService: DragulaService, dropCallback: (newColumnIds: string[]) => void): void;
12
- getRowHeight(el: ElementRef, index: number): string;
13
- setStyle(el: ElementRef, style: string, value: string): void;
14
- private isLeftOfLocked;
15
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyGridAdapterService, never>;
16
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyGridAdapterService>;
17
- }