@skyux/data-manager 12.22.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.
- package/fesm2022/skyux-data-manager-testing.mjs.map +1 -1
- package/fesm2022/skyux-data-manager.mjs +41 -41
- package/fesm2022/skyux-data-manager.mjs.map +1 -1
- package/index.d.ts +705 -25
- package/package.json +14 -14
- package/testing/index.d.ts +359 -3
- package/lib/modules/data-manager/data-manager-column-picker/data-manager-column-picker-context.d.ts +0 -8
- package/lib/modules/data-manager/data-manager-column-picker/data-manager-column-picker-impl.service.d.ts +0 -7
- package/lib/modules/data-manager/data-manager-column-picker/data-manager-column-picker-providers.d.ts +0 -2
- package/lib/modules/data-manager/data-manager-column-picker/data-manager-column-picker.component.d.ts +0 -42
- package/lib/modules/data-manager/data-manager-column-picker/data-manager-column-picker.service.d.ts +0 -13
- package/lib/modules/data-manager/data-manager-filter-context.d.ts +0 -10
- package/lib/modules/data-manager/data-manager-toolbar/data-manager-toolbar-left-item.component.d.ts +0 -10
- package/lib/modules/data-manager/data-manager-toolbar/data-manager-toolbar-primary-item.component.d.ts +0 -10
- package/lib/modules/data-manager/data-manager-toolbar/data-manager-toolbar-right-item.component.d.ts +0 -11
- package/lib/modules/data-manager/data-manager-toolbar/data-manager-toolbar-section.component.d.ts +0 -10
- package/lib/modules/data-manager/data-manager-toolbar/data-manager-toolbar.component.d.ts +0 -36
- package/lib/modules/data-manager/data-manager.component.d.ts +0 -22
- package/lib/modules/data-manager/data-manager.module.d.ts +0 -13
- package/lib/modules/data-manager/data-manager.service.d.ts +0 -117
- package/lib/modules/data-manager/data-view.component.d.ts +0 -26
- package/lib/modules/data-manager/models/data-manager-column-picker-option.d.ts +0 -31
- package/lib/modules/data-manager/models/data-manager-column-picker-sort-strategy.d.ts +0 -14
- package/lib/modules/data-manager/models/data-manager-config.d.ts +0 -28
- package/lib/modules/data-manager/models/data-manager-filter-data.d.ts +0 -11
- package/lib/modules/data-manager/models/data-manager-init-args.d.ts +0 -25
- package/lib/modules/data-manager/models/data-manager-sort-option.d.ts +0 -22
- package/lib/modules/data-manager/models/data-manager-state-change.d.ts +0 -9
- package/lib/modules/data-manager/models/data-manager-state-options.d.ts +0 -35
- package/lib/modules/data-manager/models/data-manager-state-update-filter-args.d.ts +0 -16
- package/lib/modules/data-manager/models/data-manager-state.d.ts +0 -58
- package/lib/modules/data-manager/models/data-manager-summary-change.d.ts +0 -9
- package/lib/modules/data-manager/models/data-manager-summary.d.ts +0 -13
- package/lib/modules/data-manager/models/data-view-column-widths.d.ts +0 -10
- package/lib/modules/data-manager/models/data-view-config.d.ts +0 -96
- package/lib/modules/data-manager/models/data-view-state-options.d.ts +0 -24
- package/lib/modules/data-manager/models/data-view-state.d.ts +0 -34
- package/lib/modules/shared/sky-data-manager-resources.module.d.ts +0 -10
- package/testing/modules/data-manager/data-manager-column-picker-column-harness-filters.d.ts +0 -6
- package/testing/modules/data-manager/data-manager-column-picker-column-harness.d.ts +0 -81
- package/testing/modules/data-manager/data-manager-column-picker-harness.d.ts +0 -45
- package/testing/modules/data-manager/data-manager-harness-filters.d.ts +0 -6
- package/testing/modules/data-manager/data-manager-harness.d.ts +0 -33
- package/testing/modules/data-manager/data-manager-toolbar-harness-filters.d.ts +0 -6
- package/testing/modules/data-manager/data-manager-toolbar-harness.d.ts +0 -94
- package/testing/modules/data-manager/data-manager-toolbar-left-item-harness-filters.d.ts +0 -6
- package/testing/modules/data-manager/data-manager-toolbar-left-item-harness.d.ts +0 -17
- package/testing/modules/data-manager/data-manager-toolbar-primary-item-harness-filters.d.ts +0 -6
- package/testing/modules/data-manager/data-manager-toolbar-primary-item-harness.d.ts +0 -17
- package/testing/modules/data-manager/data-manager-toolbar-right-item-harness-filters.d.ts +0 -6
- package/testing/modules/data-manager/data-manager-toolbar-right-item-harness.d.ts +0 -17
- package/testing/modules/data-manager/data-manager-toolbar-section-harness-filters.d.ts +0 -6
- package/testing/modules/data-manager/data-manager-toolbar-section-harness.d.ts +0 -17
- package/testing/modules/data-manager/data-view-harness-filters.d.ts +0 -7
- package/testing/modules/data-manager/data-view-harness.d.ts +0 -17
- package/testing/public-api.d.ts +0 -17
package/index.d.ts
CHANGED
@@ -1,25 +1,705 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
1
|
+
import * as i0 from '@angular/core';
|
2
|
+
import { OnDestroy, OnInit } from '@angular/core';
|
3
|
+
import { SkyBackToTopMessage } from '@skyux/layout';
|
4
|
+
import { Subject, BehaviorSubject, Observable } from 'rxjs';
|
5
|
+
import { SkyCheckboxChange } from '@skyux/forms';
|
6
|
+
import * as i1 from '@skyux/core';
|
7
|
+
import { SkyUIConfigService } from '@skyux/core';
|
8
|
+
import * as i2 from '@skyux/indicators';
|
9
|
+
import { SkyModalInstance } from '@skyux/modals';
|
10
|
+
|
11
|
+
interface SkyDataManagerFilterData {
|
12
|
+
/**
|
13
|
+
* Whether any filters are applied.
|
14
|
+
*/
|
15
|
+
filtersApplied?: boolean;
|
16
|
+
/**
|
17
|
+
* The filter data used in the data manager. You may use any filter model that works for
|
18
|
+
* your data set and models. See the demo for an example.
|
19
|
+
*/
|
20
|
+
filters?: any;
|
21
|
+
}
|
22
|
+
|
23
|
+
/**
|
24
|
+
* Sets the state of the filters.
|
25
|
+
*/
|
26
|
+
declare class SkyDataManagerFilterModalContext {
|
27
|
+
/**
|
28
|
+
* Sets the state of the filters.
|
29
|
+
*/
|
30
|
+
filterData: SkyDataManagerFilterData | undefined;
|
31
|
+
}
|
32
|
+
|
33
|
+
/**
|
34
|
+
* The top-level data manager component. Provide `SkyDataManagerService` at this level.
|
35
|
+
*/
|
36
|
+
declare class SkyDataManagerComponent implements OnDestroy, OnInit {
|
37
|
+
#private;
|
38
|
+
get currentViewkeeperClasses(): string[];
|
39
|
+
set currentViewkeeperClasses(value: string[] | undefined);
|
40
|
+
get isInitialized(): boolean;
|
41
|
+
set isInitialized(value: boolean);
|
42
|
+
backToTopController: Subject<SkyBackToTopMessage>;
|
43
|
+
backToTopOptions: {
|
44
|
+
buttonHidden: boolean;
|
45
|
+
};
|
46
|
+
ngOnInit(): void;
|
47
|
+
ngOnDestroy(): void;
|
48
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerComponent, never>;
|
49
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDataManagerComponent, "sky-data-manager", never, {}, {}, never, ["*"], true, never>;
|
50
|
+
}
|
51
|
+
|
52
|
+
interface SkyDataManagerSortOption {
|
53
|
+
/**
|
54
|
+
* Whether to apply the sort in descending order.
|
55
|
+
* @required
|
56
|
+
*/
|
57
|
+
descending: boolean;
|
58
|
+
/**
|
59
|
+
* An ID for the sort option.
|
60
|
+
* @required
|
61
|
+
*/
|
62
|
+
id: string;
|
63
|
+
/**
|
64
|
+
* The label to display in the sort dropdown.
|
65
|
+
* @required
|
66
|
+
*/
|
67
|
+
label: string;
|
68
|
+
/**
|
69
|
+
* The data property to sort by.
|
70
|
+
* @required
|
71
|
+
*/
|
72
|
+
propertyName: string;
|
73
|
+
}
|
74
|
+
|
75
|
+
/**
|
76
|
+
* The data manager config contains settings that apply to the data manager across all views,
|
77
|
+
* such as the sort and filter settings.
|
78
|
+
*/
|
79
|
+
interface SkyDataManagerConfig {
|
80
|
+
/**
|
81
|
+
* An untyped property that can track any config information relevant to a
|
82
|
+
* data manager that existing options do not include.
|
83
|
+
*/
|
84
|
+
additionalOptions?: any;
|
85
|
+
/**
|
86
|
+
* The modal component to launch when the filter button is selected. The same filter options are
|
87
|
+
* used for all views, but views can use `SkyDataViewConfig` to indicate whether to display
|
88
|
+
* the filter button. The modal receives the `filterData` in the data state as context.
|
89
|
+
*/
|
90
|
+
filterModalComponent?: any;
|
91
|
+
/**
|
92
|
+
* A descriptor for the data that the data manager manipulates. Use a plural term. The descriptor helps set the data manager's `aria-label` attributes for multiselect toolbars, search inputs, sort buttons, and filter buttons to provide text equivalents for screen readers [to support accessibility](https://developer.blackbaud.com/skyux/components/checkbox#accessibility).
|
93
|
+
* For example, when the descriptor is "constituents," the search input's `aria-label` is "Search constituents." For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
|
94
|
+
*/
|
95
|
+
listDescriptor?: string;
|
96
|
+
/**
|
97
|
+
* The sort options displayed in the sort dropdown. The same sort options are used for all views,
|
98
|
+
* but views can use `SkyDataViewConfig` to indicate whether to display the sort button.
|
99
|
+
*/
|
100
|
+
sortOptions?: SkyDataManagerSortOption[];
|
101
|
+
}
|
102
|
+
|
103
|
+
interface SkyDataViewColumnWidths {
|
104
|
+
/**
|
105
|
+
* A map of columnIds to column widths at the xs breakpoint size.
|
106
|
+
*/
|
107
|
+
xs: Record<string, number>;
|
108
|
+
/**
|
109
|
+
* A map of columnIds to column widths at the sm or larger breakpoint size.
|
110
|
+
*/
|
111
|
+
sm: Record<string, number>;
|
112
|
+
}
|
113
|
+
|
114
|
+
interface SkyDataViewStateOptions {
|
115
|
+
/**
|
116
|
+
* The ID of this view.
|
117
|
+
*/
|
118
|
+
viewId: string;
|
119
|
+
/**
|
120
|
+
* The IDs of the columns able to be displayed for column-based views. This property is required when utilizing a grid-based view, a column picker, or both.
|
121
|
+
*/
|
122
|
+
columnIds?: string[];
|
123
|
+
/**
|
124
|
+
* The widths of columns in column-based views for xs and sm+ breakpoints. If using sticky settings, the widths a user sets will be persisted.
|
125
|
+
*/
|
126
|
+
columnWidths?: SkyDataViewColumnWidths;
|
127
|
+
/**
|
128
|
+
* The IDs of the columns displayed for column-based views.
|
129
|
+
*/
|
130
|
+
displayedColumnIds?: string[];
|
131
|
+
/**
|
132
|
+
* An untyped property that tracks any view-specific state information
|
133
|
+
* that is relevant to a data manager but that existing properties do not cover.
|
134
|
+
*/
|
135
|
+
additionalData?: any;
|
136
|
+
}
|
137
|
+
|
138
|
+
interface SkyDataManagerStateOptions {
|
139
|
+
/**
|
140
|
+
* The selected SkyDataManagerSortOption to apply.
|
141
|
+
*/
|
142
|
+
activeSortOption?: SkyDataManagerSortOption;
|
143
|
+
/**
|
144
|
+
* An untyped property that tracks any state information that's relevant to a data
|
145
|
+
* manager but that the existing properties do not cover.
|
146
|
+
*/
|
147
|
+
additionalData?: any;
|
148
|
+
/**
|
149
|
+
* The state of the filters.
|
150
|
+
*/
|
151
|
+
filterData?: SkyDataManagerFilterData;
|
152
|
+
/**
|
153
|
+
* Whether to display only the selected rows or objects. The multiselect toolbar
|
154
|
+
* uses this property.
|
155
|
+
*/
|
156
|
+
onlyShowSelected?: boolean;
|
157
|
+
/**
|
158
|
+
* The search text to apply.
|
159
|
+
*/
|
160
|
+
searchText?: string;
|
161
|
+
/**
|
162
|
+
* The currently selected rows or objects.
|
163
|
+
*/
|
164
|
+
selectedIds?: string[];
|
165
|
+
/**
|
166
|
+
* The states of the individual views.
|
167
|
+
*/
|
168
|
+
views?: SkyDataViewStateOptions[];
|
169
|
+
}
|
170
|
+
|
171
|
+
/**
|
172
|
+
* Provides options for defining how data is displayed, such as which columns appear.
|
173
|
+
*/
|
174
|
+
declare class SkyDataViewState {
|
175
|
+
/**
|
176
|
+
* The IDs of the columns able to be displayed for column-based views. This property is required when utilizing a grid-based view, a column picker, or both.
|
177
|
+
*/
|
178
|
+
columnIds: string[];
|
179
|
+
/**
|
180
|
+
* The widths of columns in column-based views for xs and sm+ breakpoints. If using sticky settings, the widths a user sets will be persisted.
|
181
|
+
*/
|
182
|
+
columnWidths: SkyDataViewColumnWidths;
|
183
|
+
/**
|
184
|
+
* The IDs of the columns displayed for column-based views.
|
185
|
+
*/
|
186
|
+
displayedColumnIds: string[];
|
187
|
+
/**
|
188
|
+
* The ID of this view.
|
189
|
+
*/
|
190
|
+
viewId: string;
|
191
|
+
/**
|
192
|
+
* An untyped property that tracks any view-specific state information
|
193
|
+
* that is relevant to a data manager but that existing properties do not cover.
|
194
|
+
*/
|
195
|
+
additionalData: any;
|
196
|
+
constructor(data: SkyDataViewStateOptions);
|
197
|
+
/**
|
198
|
+
* Returns the `SkyDataViewStateOptions` for the current view.
|
199
|
+
* @returns The `SkyDataViewStateOptions`.
|
200
|
+
*/
|
201
|
+
getViewStateOptions(): SkyDataViewStateOptions;
|
202
|
+
}
|
203
|
+
|
204
|
+
/**
|
205
|
+
* Provides options that control which data to display.
|
206
|
+
*/
|
207
|
+
declare class SkyDataManagerState {
|
208
|
+
/**
|
209
|
+
* The selected SkyDataManagerSortOption to apply.
|
210
|
+
*/
|
211
|
+
activeSortOption: SkyDataManagerSortOption | undefined;
|
212
|
+
/**
|
213
|
+
* An untyped property that tracks any state information that's relevant to a data
|
214
|
+
* manager but that the existing properties do not cover.
|
215
|
+
*/
|
216
|
+
additionalData: any;
|
217
|
+
/**
|
218
|
+
* The state of the filters.
|
219
|
+
*/
|
220
|
+
filterData: SkyDataManagerFilterData | undefined;
|
221
|
+
/**
|
222
|
+
* Whether to display only the selected rows or objects. The multiselect toolbar
|
223
|
+
* uses this property.
|
224
|
+
*/
|
225
|
+
onlyShowSelected: boolean | undefined;
|
226
|
+
/**
|
227
|
+
* The search text to apply.
|
228
|
+
*/
|
229
|
+
searchText: string | undefined;
|
230
|
+
/**
|
231
|
+
* The currently selected rows or objects.
|
232
|
+
*/
|
233
|
+
selectedIds: string[] | undefined;
|
234
|
+
/**
|
235
|
+
* The states of the individual views.
|
236
|
+
*/
|
237
|
+
views: SkyDataViewState[];
|
238
|
+
constructor(data: SkyDataManagerStateOptions);
|
239
|
+
/**
|
240
|
+
* Returns the `SkyDataManagerStateOptions` for the data manager.
|
241
|
+
* @returns The `SkyDataManagerStateOptions` for the data manager.
|
242
|
+
*/
|
243
|
+
getStateOptions(): SkyDataManagerStateOptions;
|
244
|
+
/**
|
245
|
+
* Returns the `SkyDataViewState` for the specified view.
|
246
|
+
* @param viewId The ID for the view.
|
247
|
+
* @returns The `SkyDataViewState` for the specified view.
|
248
|
+
*/
|
249
|
+
getViewStateById(viewId: string): SkyDataViewState | undefined;
|
250
|
+
/**
|
251
|
+
* Adds a `SkyDataViewState` to a view or updates an existing view.
|
252
|
+
* @param viewId The ID for the view.
|
253
|
+
* @param view The `SkyDataViewState` option to add or update.
|
254
|
+
* @returns The state of the data manager for the specified view.
|
255
|
+
*/
|
256
|
+
addOrUpdateView(viewId: string, view: SkyDataViewState): SkyDataManagerState;
|
257
|
+
}
|
258
|
+
|
259
|
+
/**
|
260
|
+
* The options to display in a view's column picker.
|
261
|
+
*/
|
262
|
+
interface SkyDataManagerColumnPickerOption {
|
263
|
+
/**
|
264
|
+
* Whether a column is always visible and is not listed as an option in the column
|
265
|
+
* picker. For example, a context menu column may always be visible.
|
266
|
+
*/
|
267
|
+
alwaysDisplayed?: boolean;
|
268
|
+
/**
|
269
|
+
* The description text rendered beneath the column label in the column picker.
|
270
|
+
*/
|
271
|
+
description?: string;
|
272
|
+
/**
|
273
|
+
* Initially hide the column when it is added to the grid unless given in the view state's
|
274
|
+
* `displayedColumnIds`. When enabled, this column will not be automatically added to a view's
|
275
|
+
* state when this column is recognized as being missing from an initial data state or a data
|
276
|
+
* state returned via the SKY UI config service.
|
277
|
+
*/
|
278
|
+
initialHide?: boolean;
|
279
|
+
/**
|
280
|
+
* The ID of the corresponding column.
|
281
|
+
* @required
|
282
|
+
*/
|
283
|
+
id: string;
|
284
|
+
/**
|
285
|
+
* The label to display in the column picker.
|
286
|
+
* @required
|
287
|
+
*/
|
288
|
+
label: string;
|
289
|
+
}
|
290
|
+
|
291
|
+
/**
|
292
|
+
* These options specify the sorting strategy applied to columns when `columnPickerEnabled` is enabled.
|
293
|
+
*/
|
294
|
+
declare enum SkyDataManagerColumnPickerSortStrategy {
|
295
|
+
/**
|
296
|
+
* No sorting is applied to the columns.
|
297
|
+
*/
|
298
|
+
None = "none",
|
299
|
+
/**
|
300
|
+
* If `sortEnabled` is set to `true`, then the selected columns are displayed before the unselected columns. Unselected columns are sorted alphabetically.
|
301
|
+
* If `sortEnabled` is set to `false`, then the columns are displayed in the order specified by `columnOptions`.
|
302
|
+
*/
|
303
|
+
SelectedThenAlphabetical = "selectedThenAlphabetical"
|
304
|
+
}
|
305
|
+
|
306
|
+
/**
|
307
|
+
* The data view config contains settings that apply to the specific view, such as
|
308
|
+
* column picker options and the buttons to display in the toolbar.
|
309
|
+
*/
|
310
|
+
interface SkyDataViewConfig {
|
311
|
+
/**
|
312
|
+
* An untyped property that can track any view config information relevant to a
|
313
|
+
* data view that the existing options do not include.
|
314
|
+
*/
|
315
|
+
additionalOptions?: Record<string, unknown>;
|
316
|
+
/**
|
317
|
+
* The column data to pass to the column picker. Columns that are always displayed should be
|
318
|
+
* passed in addition to the optional columns. See SkyDataManagerColumnPickerOption.
|
319
|
+
*/
|
320
|
+
columnOptions?: SkyDataManagerColumnPickerOption[];
|
321
|
+
/**
|
322
|
+
* Whether to display the column picker button for this view.
|
323
|
+
*/
|
324
|
+
columnPickerEnabled?: boolean;
|
325
|
+
/**
|
326
|
+
* The strategy used to sort the options in the column picker. If no strategy is provided the columns will be sorted
|
327
|
+
* by selected then alphabetical.
|
328
|
+
*/
|
329
|
+
columnPickerSortStrategy?: SkyDataManagerColumnPickerSortStrategy;
|
330
|
+
/**
|
331
|
+
* Whether to display the filter button for this view.
|
332
|
+
*/
|
333
|
+
filterButtonEnabled?: boolean;
|
334
|
+
/**
|
335
|
+
* The Font Awesome icon name to use for this view in the view switcher.
|
336
|
+
* Required if you have more than one view. Do not include the `fa-` prefix.
|
337
|
+
* @deprecated Use `iconName` instead.
|
338
|
+
*/
|
339
|
+
icon?: string;
|
340
|
+
/**
|
341
|
+
* The name of the Blackbaud SVG icon to display for this view in the view switcher.
|
342
|
+
* Required if you have more than one view.
|
343
|
+
*/
|
344
|
+
iconName?: string;
|
345
|
+
/**
|
346
|
+
* The unique ID for this view.
|
347
|
+
*/
|
348
|
+
id: string;
|
349
|
+
/**
|
350
|
+
* Whether to display the multiselect toolbar for this view.
|
351
|
+
*/
|
352
|
+
multiselectToolbarEnabled?: boolean;
|
353
|
+
/**
|
354
|
+
* The name of the view. This is used in the ARIA label for the view switcher.
|
355
|
+
*/
|
356
|
+
name: string;
|
357
|
+
/**
|
358
|
+
* The function called when a user selects the "Clear all" button on the multi-select toolbar.
|
359
|
+
* Update your displayed data to indicate it is not selected in this function.
|
360
|
+
*/
|
361
|
+
onClearAllClick?: () => void;
|
362
|
+
/**
|
363
|
+
* The function called when a user selects the "Select all" button on the multi-select toolbar.
|
364
|
+
* Update your displayed data to indicate it is selected in this function.
|
365
|
+
*/
|
366
|
+
onSelectAllClick?: () => void;
|
367
|
+
/**
|
368
|
+
* Whether to display the search box for this view.
|
369
|
+
*/
|
370
|
+
searchEnabled?: boolean;
|
371
|
+
/**
|
372
|
+
* Placeholder text to display in the search input until users enter search criteria.
|
373
|
+
* See the <a href="https://developer.blackbaud.com/skyux/components/search">search component</a> for the default value.
|
374
|
+
*/
|
375
|
+
searchPlaceholderText?: string;
|
376
|
+
/**
|
377
|
+
* Sets the `expandMode` property on the search box for this view.
|
378
|
+
* See the <a href="https://developer.blackbaud.com/skyux/components/search">search component</a> for valid options and the default value.
|
379
|
+
*/
|
380
|
+
searchExpandMode?: string;
|
381
|
+
/**
|
382
|
+
* Highlights text that matches the search text using the text highlight directive.
|
383
|
+
*/
|
384
|
+
searchHighlightEnabled?: boolean;
|
385
|
+
/**
|
386
|
+
* Whether to include the "Filter" text on the displayed filter button for this view.
|
387
|
+
* If it is not set, no text appears.
|
388
|
+
*/
|
389
|
+
showFilterButtonText?: boolean;
|
390
|
+
/**
|
391
|
+
* Whether to include the "Sort" text on the displayed sort button for this view.
|
392
|
+
* If it is not set, no text appears.
|
393
|
+
*/
|
394
|
+
showSortButtonText?: boolean;
|
395
|
+
/**
|
396
|
+
* Whether to display the sort button in this view.
|
397
|
+
*/
|
398
|
+
sortEnabled?: boolean;
|
399
|
+
}
|
400
|
+
|
401
|
+
/**
|
402
|
+
* Renders a `sky-toolbar` with the contents specified by the active view's `SkyDataViewConfig`
|
403
|
+
* and the `SkyDataManagerToolbarLeftItemComponent`, `SkyDataManagerToolbarRightItemComponent`,
|
404
|
+
* and `SkyDataManagerToolbarSectionComponent` wrappers.
|
405
|
+
*/
|
406
|
+
declare class SkyDataManagerToolbarComponent implements OnDestroy, OnInit {
|
407
|
+
#private;
|
408
|
+
get activeView(): SkyDataViewConfig | undefined;
|
409
|
+
set activeView(value: SkyDataViewConfig | undefined);
|
410
|
+
get dataManagerConfig(): SkyDataManagerConfig | undefined;
|
411
|
+
set dataManagerConfig(value: SkyDataManagerConfig | undefined);
|
412
|
+
get dataState(): SkyDataManagerState | undefined;
|
413
|
+
set dataState(value: SkyDataManagerState | undefined);
|
414
|
+
get views(): SkyDataViewConfig[];
|
415
|
+
set views(value: SkyDataViewConfig[]);
|
416
|
+
onlyShowSelected: boolean | undefined;
|
417
|
+
ngOnInit(): void;
|
418
|
+
ngOnDestroy(): void;
|
419
|
+
sortSelected(sortOption: SkyDataManagerSortOption): void;
|
420
|
+
onViewChange(viewId: string): void;
|
421
|
+
searchApplied(text: string): void;
|
422
|
+
filterButtonClicked(): void;
|
423
|
+
openColumnPicker(): void;
|
424
|
+
selectAll(): void;
|
425
|
+
clearAll(): void;
|
426
|
+
onOnlyShowSelected(event: SkyCheckboxChange): void;
|
427
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerToolbarComponent, never>;
|
428
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDataManagerToolbarComponent, "sky-data-manager-toolbar", never, {}, {}, never, ["sky-data-manager-toolbar-primary-item", "sky-data-manager-toolbar-left-item", "sky-data-manager-toolbar-right-item", "sky-data-manager-toolbar-section"], true, never>;
|
429
|
+
}
|
430
|
+
|
431
|
+
/**
|
432
|
+
* A wrapper for an item to be rendered in `SkyDataManagerToolbarComponent`. The contents are
|
433
|
+
* rendered after the standard toolbar actions and before the search box. Each item should be
|
434
|
+
* wrapped in its own `sky-data-manager-toolbar-left-item`. The items render in the order they are in in the template.
|
435
|
+
*/
|
436
|
+
declare class SkyDataManagerToolbarLeftItemComponent {
|
437
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerToolbarLeftItemComponent, never>;
|
438
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDataManagerToolbarLeftItemComponent, "sky-data-manager-toolbar-left-item", never, {}, {}, never, ["*"], true, never>;
|
439
|
+
}
|
440
|
+
|
441
|
+
/**
|
442
|
+
* A wrapper for an item to be rendered in `SkyDataManagerToolbarComponent`. The contents are
|
443
|
+
* rendered as the first items in the toolbar and should be standard actions. Each item should be
|
444
|
+
* wrapped in its own `sky-data-manager-toolbar-primary-item`. The items render in the order they are in in the template.
|
445
|
+
*/
|
446
|
+
declare class SkyDataManagerToolbarPrimaryItemComponent {
|
447
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerToolbarPrimaryItemComponent, never>;
|
448
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDataManagerToolbarPrimaryItemComponent, "sky-data-manager-toolbar-primary-item", never, {}, {}, never, ["*"], true, never>;
|
449
|
+
}
|
450
|
+
|
451
|
+
/**
|
452
|
+
* A wrapper for an item to be rendered in `SkyDataManagerToolbarComponent`. The contents are
|
453
|
+
* rendered in `sky-toolbar-view-actions` on the right side of the toolbar and before the view
|
454
|
+
* switcher icons (if present). Each item should be wrapped in its own
|
455
|
+
* `sky-data-manager-toolbar-right-item`. The items render in the order they are in in the template.
|
456
|
+
*/
|
457
|
+
declare class SkyDataManagerToolbarRightItemComponent {
|
458
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerToolbarRightItemComponent, never>;
|
459
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDataManagerToolbarRightItemComponent, "sky-data-manager-toolbar-right-item", never, {}, {}, never, ["*"], true, never>;
|
460
|
+
}
|
461
|
+
|
462
|
+
/**
|
463
|
+
* A wrapper for items to be rendered in `SkyDataManagerToolbarComponent`. The contents are
|
464
|
+
* rendered in an additional toolbar row beneath the primary toolbar and above the multiselect
|
465
|
+
* toolbar (if present).
|
466
|
+
*/
|
467
|
+
declare class SkyDataManagerToolbarSectionComponent {
|
468
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerToolbarSectionComponent, never>;
|
469
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDataManagerToolbarSectionComponent, "sky-data-manager-toolbar-section", never, {}, {}, never, ["*"], true, never>;
|
470
|
+
}
|
471
|
+
|
472
|
+
/**
|
473
|
+
* A data view is rendered within a data manager component.
|
474
|
+
* It can subscribe to data state changes from `SkyDataManagerService` and apply the filters,
|
475
|
+
* search text, and more to the data it displays.
|
476
|
+
*/
|
477
|
+
declare class SkyDataViewComponent implements OnDestroy, OnInit {
|
478
|
+
#private;
|
479
|
+
/**
|
480
|
+
* The configuration for the view. See the `SkyDataViewConfig` interface.
|
481
|
+
* @required
|
482
|
+
*/
|
483
|
+
viewId: string | undefined;
|
484
|
+
get dataViewId(): string | undefined;
|
485
|
+
get isActive(): boolean;
|
486
|
+
set isActive(value: boolean);
|
487
|
+
get textHighlight(): string | undefined;
|
488
|
+
set textHighlight(value: string | undefined);
|
489
|
+
ngOnInit(): void;
|
490
|
+
ngOnDestroy(): void;
|
491
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataViewComponent, never>;
|
492
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDataViewComponent, "sky-data-view", never, { "viewId": { "alias": "viewId"; "required": false; }; }, {}, never, ["*"], true, [{ directive: typeof i1.SkyResponsiveHostDirective; inputs: {}; outputs: {}; }, { directive: typeof i2.SkyTextHighlightDirective; inputs: {}; outputs: {}; }]>;
|
493
|
+
}
|
494
|
+
|
495
|
+
declare class SkyDataManagerModule {
|
496
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerModule, never>;
|
497
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDataManagerModule, never, [typeof SkyDataManagerComponent, typeof SkyDataManagerToolbarComponent, typeof SkyDataManagerToolbarLeftItemComponent, typeof SkyDataManagerToolbarPrimaryItemComponent, typeof SkyDataManagerToolbarRightItemComponent, typeof SkyDataManagerToolbarSectionComponent, typeof SkyDataViewComponent], [typeof SkyDataManagerComponent, typeof SkyDataManagerToolbarComponent, typeof SkyDataManagerToolbarLeftItemComponent, typeof SkyDataManagerToolbarPrimaryItemComponent, typeof SkyDataManagerToolbarRightItemComponent, typeof SkyDataManagerToolbarSectionComponent, typeof SkyDataViewComponent]>;
|
498
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyDataManagerModule>;
|
499
|
+
}
|
500
|
+
|
501
|
+
interface SkyDataManagerInitArgs {
|
502
|
+
/**
|
503
|
+
* The initial active view's ID.
|
504
|
+
* @required
|
505
|
+
*/
|
506
|
+
activeViewId: string;
|
507
|
+
/**
|
508
|
+
* The initial configuration for the data manager. See the SkyDataManagerConfig interface.
|
509
|
+
* @required
|
510
|
+
*/
|
511
|
+
dataManagerConfig: SkyDataManagerConfig;
|
512
|
+
/**
|
513
|
+
* The data state used if no settings key is provided or if no data state is saved in the SKY UI
|
514
|
+
* config service for the user. See the SkyDataManagerState interface.
|
515
|
+
* @required
|
516
|
+
*/
|
517
|
+
defaultDataState: SkyDataManagerState;
|
518
|
+
/**
|
519
|
+
* The unique key for the UI Config Service to retrieve stored settings from a database.
|
520
|
+
* The UI Config Service saves configuration settings for users to preserve the current data state. For more information about the UI Config Service, see [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/develop/sticky-settings).
|
521
|
+
*/
|
522
|
+
settingsKey?: string;
|
523
|
+
}
|
524
|
+
|
525
|
+
/**
|
526
|
+
* Optional arguments to pass to `getDataStateUpdates`.
|
527
|
+
* Provide either a list of properties to filter on OR a custom comparator.
|
528
|
+
*/
|
529
|
+
interface SkyDataManagerStateUpdateFilterArgs {
|
530
|
+
/**
|
531
|
+
* A list of `SkyDataManagerState` properties to compare to test if the new `SkyDataManagerState` is distinct from the previous.
|
532
|
+
* This allows you to subscribe to changes for only the provided properties.
|
533
|
+
*/
|
534
|
+
properties?: string[];
|
535
|
+
/**
|
536
|
+
* A comparator function called to test if the new `SkyDataManagerState` is distinct from the previous.
|
537
|
+
*/
|
538
|
+
comparator?: (state1: SkyDataManagerState, state2: SkyDataManagerState) => boolean;
|
539
|
+
}
|
540
|
+
|
541
|
+
/**
|
542
|
+
* Contains summary details of the data displayed within the data manager.
|
543
|
+
*/
|
544
|
+
interface SkyDataManagerSummary {
|
545
|
+
/**
|
546
|
+
* The total number of items in the data set.
|
547
|
+
*/
|
548
|
+
totalItems: number;
|
549
|
+
/**
|
550
|
+
* The total number of items that match the search and filter criteria.
|
551
|
+
*/
|
552
|
+
itemsMatching: number;
|
553
|
+
}
|
554
|
+
|
555
|
+
/**
|
556
|
+
* The data manager service provides ways for data views, toolbar items, and more to stay up to date
|
557
|
+
* with the active view ID, data manager config, registered views and their configs, and data state.
|
558
|
+
* There are methods to get current values, update values, and get subscriptions to the changing values.
|
559
|
+
*
|
560
|
+
* Provide this service at the component level for each instance of a data manager. Do not
|
561
|
+
* provide it at the module level or in `app-extras`. This allows multiple data
|
562
|
+
* managers to be used and self-contained.
|
563
|
+
*/
|
564
|
+
declare class SkyDataManagerService implements OnDestroy {
|
565
|
+
#private;
|
566
|
+
/**
|
567
|
+
* @internal
|
568
|
+
*/
|
569
|
+
viewkeeperClasses: BehaviorSubject<Record<string, string[]>>;
|
570
|
+
constructor(uiConfigService: SkyUIConfigService);
|
571
|
+
ngOnDestroy(): void;
|
572
|
+
/**
|
573
|
+
* Initializes the data manager with the given settings and sets `isInitialized` to `true`.
|
574
|
+
* This must be called for the data manager to render.
|
575
|
+
* @param args The initial active view ID, data manager config, and state to use for the data manager.
|
576
|
+
* If a settings key is provided, it checks for a saved data state in the SKY UI config service before using the default data state
|
577
|
+
* and saves any state changes to the service.
|
578
|
+
*/
|
579
|
+
initDataManager(args: SkyDataManagerInitArgs): void;
|
580
|
+
/**
|
581
|
+
* Initializes a view within the data manager. This must be called for each view for the views to appear within the data manager.
|
582
|
+
* @param viewConfig The SkyDataViewConfig settings for the view being registered.
|
583
|
+
*/
|
584
|
+
initDataView(viewConfig: SkyDataViewConfig): void;
|
585
|
+
/**
|
586
|
+
* Returns an observable of data state changes that views and other data manager entities can subscribe to.
|
587
|
+
* It excludes updates originating from the provided source. This allows subscribers to only respond to
|
588
|
+
* changes they did not create and helps prevent infinite loops of updates and responses.
|
589
|
+
* @param sourceId The ID of the entity subscribing to data state updates. This can be any value you choose
|
590
|
+
* but should be unique within the data manager instance and should also be used when that entity updates the state.
|
591
|
+
*/
|
592
|
+
getDataStateUpdates(sourceId: string, updateFilter?: SkyDataManagerStateUpdateFilterArgs): Observable<SkyDataManagerState>;
|
593
|
+
/**
|
594
|
+
* Updates the data state and emits a new value to entities subscribed to data state changes.
|
595
|
+
* @param state The new `SkyDataManagerState` value.
|
596
|
+
* @param sourceId The ID of the entity updating the state. This can be any value you choose,
|
597
|
+
* but should be unique within the data manager instance and should also be used when that entity
|
598
|
+
* subscribes to state changes from `getDataStateUpdates`.
|
599
|
+
*/
|
600
|
+
updateDataState(state: SkyDataManagerState, sourceId: string): void;
|
601
|
+
/**
|
602
|
+
* Returns an observable of data summary changes that views and other data manager entities can subscribe to.
|
603
|
+
* It excludes updates originating from the provided source. This allows subscribers to only respond to
|
604
|
+
* changes they did not create and helps prevent infinite loops of updates and responses.
|
605
|
+
* @param sourceId The ID of the entity subscribing to data summary updates. This can be any value you choose
|
606
|
+
* but should be unique within the data manager instance and should also be used when that entity updates the summary.
|
607
|
+
*/
|
608
|
+
getDataSummaryUpdates(sourceId: string): Observable<SkyDataManagerSummary>;
|
609
|
+
/**
|
610
|
+
* Updates the data summary and emits a new value to entities subscribed to data summary changes.
|
611
|
+
* @param summary The new `SkyDataManagerSummary` value.
|
612
|
+
* @param sourceId The ID of the entity updating the summary. This can be any value you choose,
|
613
|
+
* but should be unique within the data manager instance and should also be used when that entity
|
614
|
+
* subscribes to summary changes from `getDataSummaryUpdates`.
|
615
|
+
*/
|
616
|
+
updateDataSummary(summary: SkyDataManagerSummary, sourceId: string): void;
|
617
|
+
/**
|
618
|
+
* Returns the current `SkyDataManagerConfig`.
|
619
|
+
*/
|
620
|
+
getCurrentDataManagerConfig(): SkyDataManagerConfig;
|
621
|
+
/**
|
622
|
+
* Returns an observable of data manager config changes that views and other data manager entities can subscribe to.
|
623
|
+
*/
|
624
|
+
getDataManagerConfigUpdates(): Observable<SkyDataManagerConfig>;
|
625
|
+
/**
|
626
|
+
* Updates the data manager config and emits a new value to entities subscribed to data config changes.
|
627
|
+
* @param value The new `SkyDataManagerConfig` value.
|
628
|
+
*/
|
629
|
+
updateDataManagerConfig(value: SkyDataManagerConfig): void;
|
630
|
+
/**
|
631
|
+
* Returns an observable of data view config changes that views and other data manager entities can subscribe to.
|
632
|
+
*/
|
633
|
+
getDataViewsUpdates(): Observable<SkyDataViewConfig[]>;
|
634
|
+
/**
|
635
|
+
* Returns an observable of the active view ID that views and other data manager entities can subscribe to.
|
636
|
+
*/
|
637
|
+
getActiveViewIdUpdates(): Observable<string>;
|
638
|
+
/**
|
639
|
+
* Updates the active view ID. The data manager changes the displayed view.
|
640
|
+
* @param id The new active view ID.
|
641
|
+
*/
|
642
|
+
updateActiveViewId(id: string): void;
|
643
|
+
/**
|
644
|
+
* Returns the `SkyDataViewConfig` for the given view ID.
|
645
|
+
* @param viewId The ID of the view config to get.
|
646
|
+
*/
|
647
|
+
getViewById(viewId: string): SkyDataViewConfig | undefined;
|
648
|
+
/**
|
649
|
+
* Updates the given view config. The registered view with the same ID is updated to the
|
650
|
+
* provided config, so include all properties regardless of whether they changed. If the
|
651
|
+
* view was not initialized already, no update happens.
|
652
|
+
* @param view The new `SkyDataViewConfig` containing all properties.
|
653
|
+
*/
|
654
|
+
updateViewConfig(view: SkyDataViewConfig): void;
|
655
|
+
/**
|
656
|
+
* @internal
|
657
|
+
*/
|
658
|
+
setViewkeeperClasses(viewId: string, classes: string[]): void;
|
659
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerService, never>;
|
660
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyDataManagerService>;
|
661
|
+
}
|
662
|
+
|
663
|
+
declare class SkyDataManagerColumnPickerContext {
|
664
|
+
columnOptions: SkyDataManagerColumnPickerOption[];
|
665
|
+
displayedColumnIds: string[];
|
666
|
+
columnPickerSortStrategy: SkyDataManagerColumnPickerSortStrategy;
|
667
|
+
constructor(columnOptions: SkyDataManagerColumnPickerOption[], displayedColumnIds: string[], columnPickerSortStrategy?: SkyDataManagerColumnPickerSortStrategy);
|
668
|
+
}
|
669
|
+
|
670
|
+
/**
|
671
|
+
* @internal
|
672
|
+
*/
|
673
|
+
interface Column extends SkyDataManagerColumnPickerOption {
|
674
|
+
isSelected: boolean;
|
675
|
+
}
|
676
|
+
/**
|
677
|
+
* @internal
|
678
|
+
*/
|
679
|
+
declare class SkyDataManagerColumnPickerComponent implements OnDestroy, OnInit {
|
680
|
+
#private;
|
681
|
+
get dataState(): SkyDataManagerState;
|
682
|
+
set dataState(value: SkyDataManagerState);
|
683
|
+
columnData: Column[];
|
684
|
+
displayedColumnData: Column[];
|
685
|
+
viewConfig: SkyDataViewConfig;
|
686
|
+
isAnyDisplayedColumnSelected: boolean;
|
687
|
+
readonly context: SkyDataManagerColumnPickerContext;
|
688
|
+
protected readonly dataManagerService: SkyDataManagerService;
|
689
|
+
protected readonly instance: SkyModalInstance;
|
690
|
+
ngOnInit(): void;
|
691
|
+
ngOnDestroy(): void;
|
692
|
+
updateData(): void;
|
693
|
+
searchColumns(columns: Column[]): Column[];
|
694
|
+
selectAll(): void;
|
695
|
+
clearAll(): void;
|
696
|
+
onIsSelectedChange(): void;
|
697
|
+
cancelChanges(): void;
|
698
|
+
isSelected(id: string): boolean;
|
699
|
+
applyChanges(): void;
|
700
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDataManagerColumnPickerComponent, never>;
|
701
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDataManagerColumnPickerComponent, "sky-data-manager-column-picker", never, {}, {}, never, never, true, never>;
|
702
|
+
}
|
703
|
+
|
704
|
+
export { SkyDataManagerColumnPickerSortStrategy, SkyDataManagerFilterModalContext, SkyDataManagerModule, SkyDataManagerService, SkyDataManagerState, SkyDataViewState, SkyDataManagerColumnPickerComponent as λ1, SkyDataManagerComponent as λ2, SkyDataManagerToolbarLeftItemComponent as λ3, SkyDataManagerToolbarPrimaryItemComponent as λ4, SkyDataManagerToolbarRightItemComponent as λ5, SkyDataManagerToolbarSectionComponent as λ6, SkyDataManagerToolbarComponent as λ7, SkyDataViewComponent as λ8 };
|
705
|
+
export type { SkyDataManagerColumnPickerOption, SkyDataManagerConfig, SkyDataManagerFilterData, SkyDataManagerInitArgs, SkyDataManagerSortOption, SkyDataManagerStateOptions, SkyDataManagerStateUpdateFilterArgs, SkyDataManagerSummary, SkyDataViewColumnWidths, SkyDataViewConfig, SkyDataViewStateOptions };
|