@skyux/list-builder 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-list-builder.mjs +101 -101
- package/fesm2022/skyux-list-builder.mjs.map +1 -1
- package/index.d.ts +1348 -73
- package/package.json +12 -12
- package/lib/modules/list/list-data-request.model.d.ts +0 -38
- package/lib/modules/list/list-data-response.model.d.ts +0 -16
- package/lib/modules/list/list-data.provider.d.ts +0 -13
- package/lib/modules/list/list-paging.component.d.ts +0 -14
- package/lib/modules/list/list-view.component.d.ts +0 -20
- package/lib/modules/list/list.component.d.ts +0 -95
- package/lib/modules/list/list.module.d.ts +0 -11
- package/lib/modules/list/state/filters/filters.orchestrator.d.ts +0 -10
- package/lib/modules/list/state/filters/update.action.d.ts +0 -9
- package/lib/modules/list/state/items/items.orchestrator.d.ts +0 -13
- package/lib/modules/list/state/items/load.action.d.ts +0 -12
- package/lib/modules/list/state/items/set-items-selected.action.d.ts +0 -10
- package/lib/modules/list/state/items/set-loading.action.d.ts +0 -8
- package/lib/modules/list/state/list-state-action.type.d.ts +0 -30
- package/lib/modules/list/state/list-state.model.d.ts +0 -23
- package/lib/modules/list/state/list-state.rxstate.d.ts +0 -36
- package/lib/modules/list/state/list-state.state-node.d.ts +0 -13
- package/lib/modules/list/state/paging/paging.model.d.ts +0 -11
- package/lib/modules/list/state/paging/paging.orchestrator.d.ts +0 -12
- package/lib/modules/list/state/paging/set-items-per-page.action.d.ts +0 -8
- package/lib/modules/list/state/paging/set-max-pages.action.d.ts +0 -8
- package/lib/modules/list/state/paging/set-page-number.action.d.ts +0 -8
- package/lib/modules/list/state/search/search.model.d.ts +0 -26
- package/lib/modules/list/state/search/search.orchestrator.d.ts +0 -13
- package/lib/modules/list/state/search/set-field-selectors.action.d.ts +0 -8
- package/lib/modules/list/state/search/set-functions.action.d.ts +0 -8
- package/lib/modules/list/state/search/set-options.action.d.ts +0 -13
- package/lib/modules/list/state/search/set-search-text.action.d.ts +0 -8
- package/lib/modules/list/state/selected/load.action.d.ts +0 -8
- package/lib/modules/list/state/selected/selected.model.d.ts +0 -12
- package/lib/modules/list/state/selected/selected.orchestrator.d.ts +0 -15
- package/lib/modules/list/state/selected/set-item-selected.action.d.ts +0 -9
- package/lib/modules/list/state/selected/set-items-selected.action.d.ts +0 -11
- package/lib/modules/list/state/selected/set-loading.action.d.ts +0 -8
- package/lib/modules/list/state/sort/label.model.d.ts +0 -29
- package/lib/modules/list/state/sort/set-available.action.d.ts +0 -9
- package/lib/modules/list/state/sort/set-field-selectors.action.d.ts +0 -9
- package/lib/modules/list/state/sort/set-global.action.d.ts +0 -9
- package/lib/modules/list/state/sort/sort.model.d.ts +0 -23
- package/lib/modules/list/state/sort/sort.orchestrator.d.ts +0 -12
- package/lib/modules/list/state/toolbar/disable.action.d.ts +0 -8
- package/lib/modules/list/state/toolbar/load.action.d.ts +0 -10
- package/lib/modules/list/state/toolbar/remove.action.d.ts +0 -8
- package/lib/modules/list/state/toolbar/set-exists.action.d.ts +0 -8
- package/lib/modules/list/state/toolbar/set-type.action.d.ts +0 -8
- package/lib/modules/list/state/toolbar/show-multiselect-toolbar.action.d.ts +0 -8
- package/lib/modules/list/state/toolbar/toolbar-item.model.d.ts +0 -13
- package/lib/modules/list/state/toolbar/toolbar.model.d.ts +0 -13
- package/lib/modules/list/state/toolbar/toolbar.orchestrator.d.ts +0 -15
- package/lib/modules/list/state/views/load.action.d.ts +0 -9
- package/lib/modules/list/state/views/set-active.action.d.ts +0 -8
- package/lib/modules/list/state/views/view.model.d.ts +0 -9
- package/lib/modules/list/state/views/views.model.d.ts +0 -10
- package/lib/modules/list/state/views/views.orchestrator.d.ts +0 -11
- package/lib/modules/list-data-provider-in-memory/list-data-in-memory.provider.d.ts +0 -21
- package/lib/modules/list-filters/filter.model.d.ts +0 -35
- package/lib/modules/list-filters/list-filter-button.component.d.ts +0 -21
- package/lib/modules/list-filters/list-filter-inline-item-renderer.component.d.ts +0 -13
- package/lib/modules/list-filters/list-filter-inline-item.component.d.ts +0 -43
- package/lib/modules/list-filters/list-filter-inline.component.d.ts +0 -22
- package/lib/modules/list-filters/list-filter-inline.model.d.ts +0 -15
- package/lib/modules/list-filters/list-filter-summary.component.d.ts +0 -29
- package/lib/modules/list-filters/list-filters.module.d.ts +0 -16
- package/lib/modules/list-paging/list-paging.component.d.ts +0 -37
- package/lib/modules/list-paging/list-paging.module.d.ts +0 -12
- package/lib/modules/list-toolbar/list-multiselect-toolbar.component.d.ts +0 -29
- package/lib/modules/list-toolbar/list-secondary-actions/list-secondary-action.component.d.ts +0 -15
- package/lib/modules/list-toolbar/list-secondary-actions/list-secondary-action.d.ts +0 -8
- package/lib/modules/list-toolbar/list-secondary-actions/list-secondary-actions-host.component.d.ts +0 -18
- package/lib/modules/list-toolbar/list-secondary-actions/list-secondary-actions.component.d.ts +0 -18
- package/lib/modules/list-toolbar/list-secondary-actions/list-secondary-actions.module.d.ts +0 -16
- package/lib/modules/list-toolbar/list-secondary-actions/list-secondary-actions.service.d.ts +0 -18
- package/lib/modules/list-toolbar/list-toolbar-item-renderer.component.d.ts +0 -12
- package/lib/modules/list-toolbar/list-toolbar-item.component.d.ts +0 -27
- package/lib/modules/list-toolbar/list-toolbar-search-actions.component.d.ts +0 -9
- package/lib/modules/list-toolbar/list-toolbar-sort.component.d.ts +0 -29
- package/lib/modules/list-toolbar/list-toolbar-view-actions.component.d.ts +0 -14
- package/lib/modules/list-toolbar/list-toolbar.component.d.ts +0 -114
- package/lib/modules/list-toolbar/list-toolbar.module.d.ts +0 -24
- package/lib/modules/list-toolbar/state/config/config.model.d.ts +0 -8
- package/lib/modules/list-toolbar/state/config/config.orchestrator.d.ts +0 -10
- package/lib/modules/list-toolbar/state/config/set-search-enabled.action.d.ts +0 -7
- package/lib/modules/list-toolbar/state/config/set-sort-selector-enabled.action.d.ts +0 -7
- package/lib/modules/list-toolbar/state/toolbar-state-action.type.d.ts +0 -6
- package/lib/modules/list-toolbar/state/toolbar-state.model.d.ts +0 -7
- package/lib/modules/list-toolbar/state/toolbar-state.rxstate.d.ts +0 -15
- package/lib/modules/list-toolbar/state/toolbar-state.state-node.d.ts +0 -12
- package/lib/modules/shared/sky-list-builder-resources.module.d.ts +0 -10
package/index.d.ts
CHANGED
|
@@ -1,73 +1,1348 @@
|
|
|
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
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
1
|
+
import { ListItemModel, ListSortFieldSelectorModel, AsyncList, AsyncItem, StateDispatcher, StateOrchestrator, StateNode } from '@skyux/list-builder-common';
|
|
2
|
+
import { Observable, BehaviorSubject, Subject } from 'rxjs';
|
|
3
|
+
import * as i0 from '@angular/core';
|
|
4
|
+
import { TemplateRef, AfterContentInit, OnChanges, OnDestroy, EventEmitter, SimpleChanges, AfterViewInit, OnInit, ChangeDetectorRef } from '@angular/core';
|
|
5
|
+
import { SkyLogService } from '@skyux/core';
|
|
6
|
+
import * as i2 from '@angular/common';
|
|
7
|
+
import * as i12 from '@skyux/lists';
|
|
8
|
+
import * as i5 from '@skyux/popovers';
|
|
9
|
+
import * as i6 from '@skyux/icon';
|
|
10
|
+
import * as i1 from '@skyux/i18n';
|
|
11
|
+
import * as i11 from '@skyux/lookup';
|
|
12
|
+
import { SkySearchComponent } from '@skyux/lookup';
|
|
13
|
+
import * as i9 from '@skyux/forms';
|
|
14
|
+
import { SkyCheckboxChange } from '@skyux/forms';
|
|
15
|
+
import * as i10 from '@skyux/layout';
|
|
16
|
+
|
|
17
|
+
declare class ListFilterModel {
|
|
18
|
+
/**
|
|
19
|
+
* The name of the filter.
|
|
20
|
+
* @required
|
|
21
|
+
*/
|
|
22
|
+
name: string;
|
|
23
|
+
/**
|
|
24
|
+
* The label for the filter's summary item.
|
|
25
|
+
* The label defaults to the `value` of the filter.
|
|
26
|
+
*/
|
|
27
|
+
label: string;
|
|
28
|
+
/**
|
|
29
|
+
* Whether users can dismiss the filter's summary item.
|
|
30
|
+
* @default true
|
|
31
|
+
*/
|
|
32
|
+
dismissible: boolean;
|
|
33
|
+
/**
|
|
34
|
+
* The current value of the filter.
|
|
35
|
+
*/
|
|
36
|
+
value: any;
|
|
37
|
+
/**
|
|
38
|
+
* The default value of the filter. When a filter equals the
|
|
39
|
+
* default value, the filter does not affect the list.
|
|
40
|
+
*/
|
|
41
|
+
defaultValue: any;
|
|
42
|
+
/**
|
|
43
|
+
* The function that determines whether items are filtered.
|
|
44
|
+
* This property is required when using an in-memory data provider.
|
|
45
|
+
* For information about `ListItemModel`, see the
|
|
46
|
+
* [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).
|
|
47
|
+
*/
|
|
48
|
+
filterFunction: (item: ListItemModel, filter: any) => boolean;
|
|
49
|
+
constructor(data?: any);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Specifies a function to dynamically manage the data source when users change the text
|
|
54
|
+
* in the list field. The search function must return an array or a promise of an array.
|
|
55
|
+
* The `search` property is particularly useful when the data source does not live
|
|
56
|
+
* in the source code.
|
|
57
|
+
* @deprecated
|
|
58
|
+
*/
|
|
59
|
+
declare class ListSearchModel {
|
|
60
|
+
/**
|
|
61
|
+
* The text to search.
|
|
62
|
+
* @default ""
|
|
63
|
+
*/
|
|
64
|
+
searchText: string;
|
|
65
|
+
/**
|
|
66
|
+
* The array of functions that returns a `boolean` value of `true` when
|
|
67
|
+
* the search is successful. This property accepts a function of type
|
|
68
|
+
* `(data: any, searchText: string) => boolean>.`
|
|
69
|
+
*/
|
|
70
|
+
functions: ((data: any, searchText: string) => boolean)[];
|
|
71
|
+
/**
|
|
72
|
+
* The columns to search. The columns correspond to `field` values that
|
|
73
|
+
* you specify with the list component's `data` property.
|
|
74
|
+
*/
|
|
75
|
+
fieldSelectors: string[];
|
|
76
|
+
constructor(data?: any);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* These properties are a work in progress, and we do not recommend using them.
|
|
81
|
+
* @deprecated
|
|
82
|
+
*/
|
|
83
|
+
declare class ListSortLabelModel {
|
|
84
|
+
/**
|
|
85
|
+
* The text for the label.
|
|
86
|
+
*/
|
|
87
|
+
text: string;
|
|
88
|
+
/**
|
|
89
|
+
* The label type.
|
|
90
|
+
*/
|
|
91
|
+
fieldType: string;
|
|
92
|
+
/**
|
|
93
|
+
* The fields to sort.
|
|
94
|
+
*/
|
|
95
|
+
fieldSelector: string;
|
|
96
|
+
/**
|
|
97
|
+
* Whether to sort all fields.
|
|
98
|
+
* @default false
|
|
99
|
+
*/
|
|
100
|
+
global: boolean;
|
|
101
|
+
/**
|
|
102
|
+
* Whether to sort in descending order.
|
|
103
|
+
* @default false
|
|
104
|
+
*/
|
|
105
|
+
descending: boolean;
|
|
106
|
+
constructor(data?: any);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Specifies a set of fields to sort by.
|
|
111
|
+
* @deprecated
|
|
112
|
+
*/
|
|
113
|
+
declare class ListSortModel {
|
|
114
|
+
/**
|
|
115
|
+
* The list of available views to sort.
|
|
116
|
+
*/
|
|
117
|
+
available: ListSortLabelModel[];
|
|
118
|
+
/**
|
|
119
|
+
* The list views that the sort applies to.
|
|
120
|
+
*/
|
|
121
|
+
global: ListSortLabelModel[];
|
|
122
|
+
/**
|
|
123
|
+
* The fields to sort.
|
|
124
|
+
* For information about `ListSortFieldSelectorModel`, see the
|
|
125
|
+
* [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).
|
|
126
|
+
*/
|
|
127
|
+
fieldSelectors: ListSortFieldSelectorModel[];
|
|
128
|
+
constructor(data?: any);
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* @deprecated
|
|
133
|
+
*/
|
|
134
|
+
declare class ListDataRequestModel {
|
|
135
|
+
/**
|
|
136
|
+
* The function that determines whether items are filtered.
|
|
137
|
+
* This property is required when using an in-memory data provider.
|
|
138
|
+
*/
|
|
139
|
+
filters: ListFilterModel[];
|
|
140
|
+
/**
|
|
141
|
+
* The number of items to display per page.
|
|
142
|
+
*/
|
|
143
|
+
pageSize: number;
|
|
144
|
+
/**
|
|
145
|
+
* The current page number.
|
|
146
|
+
*/
|
|
147
|
+
pageNumber: number;
|
|
148
|
+
/**
|
|
149
|
+
* The function to dynamically manage the data source when users
|
|
150
|
+
* change the text in the list field. The search function must return an
|
|
151
|
+
* array or a promise of an array. The `search` property is particularly useful
|
|
152
|
+
* when the data source does not live in the source code.
|
|
153
|
+
*/
|
|
154
|
+
search: ListSearchModel;
|
|
155
|
+
/**
|
|
156
|
+
* The set of fields to sort by.
|
|
157
|
+
*/
|
|
158
|
+
sort: ListSortModel;
|
|
159
|
+
/**
|
|
160
|
+
* Whether to disable the search bar and filter button.
|
|
161
|
+
* @default false
|
|
162
|
+
*/
|
|
163
|
+
isToolbarDisabled: boolean;
|
|
164
|
+
constructor(data?: any);
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* @deprecated
|
|
169
|
+
*/
|
|
170
|
+
declare class ListDataResponseModel {
|
|
171
|
+
/**
|
|
172
|
+
* The total number of records in the list.
|
|
173
|
+
*/
|
|
174
|
+
count: number;
|
|
175
|
+
/**
|
|
176
|
+
* An array of the items returned. For information about `ListItemModel`, see the
|
|
177
|
+
* [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).
|
|
178
|
+
*/
|
|
179
|
+
items: ListItemModel[];
|
|
180
|
+
constructor(data?: any);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* @internal
|
|
185
|
+
* @deprecated
|
|
186
|
+
*/
|
|
187
|
+
declare abstract class ListDataProvider {
|
|
188
|
+
data?: Observable<any[]>;
|
|
189
|
+
constructor(data?: Observable<any[]>);
|
|
190
|
+
abstract get(request: ListDataRequestModel): Observable<ListDataResponseModel>;
|
|
191
|
+
abstract count(): Observable<number>;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* @internal
|
|
196
|
+
* @deprecated
|
|
197
|
+
*/
|
|
198
|
+
declare class ListPagingModel {
|
|
199
|
+
itemsPerPage: number;
|
|
200
|
+
maxDisplayedPages: number;
|
|
201
|
+
pageCount: number;
|
|
202
|
+
pageNumber: number;
|
|
203
|
+
constructor(data?: any);
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* Contains data about the selected items in the list.
|
|
208
|
+
* @deprecated
|
|
209
|
+
*/
|
|
210
|
+
declare class ListSelectedModel {
|
|
211
|
+
/**
|
|
212
|
+
* A map of key value pairs that consists of IDs for selected items
|
|
213
|
+
* and boolean values for their selected states.
|
|
214
|
+
*/
|
|
215
|
+
selectedIdMap: Map<string, boolean>;
|
|
216
|
+
constructor();
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* @internal
|
|
221
|
+
* @deprecated
|
|
222
|
+
*/
|
|
223
|
+
declare class ListToolbarItemModel {
|
|
224
|
+
index: number;
|
|
225
|
+
template: TemplateRef<unknown>;
|
|
226
|
+
location: string;
|
|
227
|
+
view: string;
|
|
228
|
+
id: string;
|
|
229
|
+
constructor(data?: any);
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* @internal
|
|
234
|
+
* @deprecated
|
|
235
|
+
*/
|
|
236
|
+
declare class ListToolbarModel {
|
|
237
|
+
exists: boolean;
|
|
238
|
+
disabled: boolean;
|
|
239
|
+
items: ListToolbarItemModel[];
|
|
240
|
+
type: string;
|
|
241
|
+
showMultiselectToolbar: boolean;
|
|
242
|
+
constructor(data?: any);
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* @internal
|
|
247
|
+
* @deprecated
|
|
248
|
+
*/
|
|
249
|
+
declare class ListViewModel {
|
|
250
|
+
id: string;
|
|
251
|
+
name: string;
|
|
252
|
+
constructor(id: string, name: string);
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* @internal
|
|
257
|
+
* @deprecated
|
|
258
|
+
*/
|
|
259
|
+
declare class ListViewsModel {
|
|
260
|
+
active: string;
|
|
261
|
+
views: ListViewModel[];
|
|
262
|
+
constructor(data?: any);
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
/**
|
|
266
|
+
* @internal
|
|
267
|
+
* @deprecated
|
|
268
|
+
*/
|
|
269
|
+
declare class ListStateModel {
|
|
270
|
+
filters: ListFilterModel[];
|
|
271
|
+
items: AsyncList<ListItemModel>;
|
|
272
|
+
paging: ListPagingModel;
|
|
273
|
+
search: ListSearchModel;
|
|
274
|
+
selected: AsyncItem<ListSelectedModel>;
|
|
275
|
+
sort: ListSortModel;
|
|
276
|
+
toolbar: ListToolbarModel;
|
|
277
|
+
views: ListViewsModel;
|
|
278
|
+
constructor();
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* @internal
|
|
283
|
+
* @deprecated
|
|
284
|
+
*/
|
|
285
|
+
declare class ListFiltersUpdateAction {
|
|
286
|
+
filters: ListFilterModel[];
|
|
287
|
+
constructor(filters: ListFilterModel[]);
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* @internal
|
|
292
|
+
* @deprecated
|
|
293
|
+
*/
|
|
294
|
+
declare class ListItemsLoadAction {
|
|
295
|
+
items: ListItemModel[];
|
|
296
|
+
refresh: boolean;
|
|
297
|
+
dataChanged: boolean;
|
|
298
|
+
count?: number;
|
|
299
|
+
constructor(items: ListItemModel[], refresh?: boolean, dataChanged?: boolean, count?: number);
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* @internal
|
|
304
|
+
* @deprecated
|
|
305
|
+
*/
|
|
306
|
+
declare class ListItemsSetSelectedAction {
|
|
307
|
+
items: string[];
|
|
308
|
+
selected: boolean;
|
|
309
|
+
refresh: boolean;
|
|
310
|
+
constructor(items: string[], selected?: boolean, refresh?: boolean);
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* @internal
|
|
315
|
+
* @deprecated
|
|
316
|
+
*/
|
|
317
|
+
declare class ListItemsSetLoadingAction {
|
|
318
|
+
loading: boolean;
|
|
319
|
+
constructor(loading?: boolean);
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* @internal
|
|
324
|
+
* @deprecated
|
|
325
|
+
*/
|
|
326
|
+
declare class ListPagingSetItemsPerPageAction {
|
|
327
|
+
itemsPerPage: number;
|
|
328
|
+
constructor(itemsPerPage: number);
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* @internal
|
|
333
|
+
* @deprecated
|
|
334
|
+
*/
|
|
335
|
+
declare class ListPagingSetMaxPagesAction {
|
|
336
|
+
maxPages: number;
|
|
337
|
+
constructor(maxPages: number);
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* @internal
|
|
342
|
+
* @deprecated
|
|
343
|
+
*/
|
|
344
|
+
declare class ListPagingSetPageNumberAction {
|
|
345
|
+
pageNumber: number;
|
|
346
|
+
constructor(pageNumber: number);
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
/**
|
|
350
|
+
* @internal
|
|
351
|
+
* @deprecated
|
|
352
|
+
*/
|
|
353
|
+
declare class ListSearchSetFieldSelectorsAction {
|
|
354
|
+
fieldSelectors: string[];
|
|
355
|
+
constructor(fieldSelectors?: string[]);
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* @internal
|
|
360
|
+
* @deprecated
|
|
361
|
+
*/
|
|
362
|
+
declare class ListSearchSetFunctionsAction {
|
|
363
|
+
functions: ((data: any, searchText: string) => boolean)[];
|
|
364
|
+
constructor(functions?: ((data: any, searchText: string) => boolean)[]);
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
/**
|
|
368
|
+
* @internal
|
|
369
|
+
* @deprecated
|
|
370
|
+
*/
|
|
371
|
+
declare class ListSearchSetSearchTextAction {
|
|
372
|
+
searchText: string;
|
|
373
|
+
constructor(searchText: string);
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* @internal
|
|
378
|
+
* @deprecated
|
|
379
|
+
*/
|
|
380
|
+
declare class ListSearchSetOptionsAction {
|
|
381
|
+
searchTextAction: ListSearchSetSearchTextAction;
|
|
382
|
+
setFieldSelectorsAction: ListSearchSetFieldSelectorsAction;
|
|
383
|
+
setFunctionsAction: ListSearchSetFunctionsAction;
|
|
384
|
+
constructor(searchTextAction: ListSearchSetSearchTextAction, setFieldSelectorsAction: ListSearchSetFieldSelectorsAction, setFunctionsAction: ListSearchSetFunctionsAction);
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* @internal
|
|
389
|
+
* @deprecated
|
|
390
|
+
*/
|
|
391
|
+
declare class ListSelectedLoadAction {
|
|
392
|
+
items: string[];
|
|
393
|
+
constructor(items: string[]);
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* @internal
|
|
398
|
+
* @deprecated
|
|
399
|
+
*/
|
|
400
|
+
declare class ListSelectedSetItemSelectedAction {
|
|
401
|
+
id: any;
|
|
402
|
+
selected: boolean;
|
|
403
|
+
constructor(id: any, selected: boolean);
|
|
404
|
+
}
|
|
405
|
+
|
|
406
|
+
/**
|
|
407
|
+
* @internal
|
|
408
|
+
* @deprecated
|
|
409
|
+
*/
|
|
410
|
+
declare class ListSelectedSetItemsSelectedAction {
|
|
411
|
+
items: string[] | Observable<string[]>;
|
|
412
|
+
selected: boolean;
|
|
413
|
+
refresh: boolean;
|
|
414
|
+
constructor(items: string[] | Observable<string[]>, selected?: boolean, refresh?: boolean);
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* @internal
|
|
419
|
+
* @deprecated
|
|
420
|
+
*/
|
|
421
|
+
declare class ListSelectedSetLoadingAction {
|
|
422
|
+
loading: boolean;
|
|
423
|
+
constructor(loading?: boolean);
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
/**
|
|
427
|
+
* @internal
|
|
428
|
+
* @deprecated
|
|
429
|
+
*/
|
|
430
|
+
declare class ListSortSetAvailableAction {
|
|
431
|
+
available: ListSortLabelModel[];
|
|
432
|
+
constructor(available: ListSortLabelModel[]);
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
/**
|
|
436
|
+
* @internal
|
|
437
|
+
* @deprecated
|
|
438
|
+
*/
|
|
439
|
+
declare class ListSortSetFieldSelectorsAction {
|
|
440
|
+
fieldSelectors: ListSortFieldSelectorModel[];
|
|
441
|
+
constructor(fieldSelectors: ListSortFieldSelectorModel[]);
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
/**
|
|
445
|
+
* @internal
|
|
446
|
+
* @deprecated
|
|
447
|
+
*/
|
|
448
|
+
declare class ListSortSetGlobalAction {
|
|
449
|
+
global: ListSortLabelModel[];
|
|
450
|
+
constructor(global: ListSortLabelModel[]);
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* @internal
|
|
455
|
+
* @deprecated
|
|
456
|
+
*/
|
|
457
|
+
declare class ListToolbarItemsDisableAction {
|
|
458
|
+
disable: boolean;
|
|
459
|
+
constructor(disable: boolean);
|
|
460
|
+
}
|
|
461
|
+
|
|
462
|
+
/**
|
|
463
|
+
* @internal
|
|
464
|
+
* @deprecated
|
|
465
|
+
*/
|
|
466
|
+
declare class ListToolbarItemsLoadAction {
|
|
467
|
+
items: ListToolbarItemModel[];
|
|
468
|
+
index: number;
|
|
469
|
+
constructor(items: ListToolbarItemModel[], index?: number);
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
/**
|
|
473
|
+
* @internal
|
|
474
|
+
* @deprecated
|
|
475
|
+
*/
|
|
476
|
+
declare class ListToolbarItemsRemoveAction {
|
|
477
|
+
ids: string[];
|
|
478
|
+
constructor(ids: string[]);
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* @internal
|
|
483
|
+
* @deprecated
|
|
484
|
+
*/
|
|
485
|
+
declare class ListToolbarSetExistsAction {
|
|
486
|
+
exists: boolean;
|
|
487
|
+
constructor(exists: boolean);
|
|
488
|
+
}
|
|
489
|
+
|
|
490
|
+
/**
|
|
491
|
+
* @internal
|
|
492
|
+
* @deprecated
|
|
493
|
+
*/
|
|
494
|
+
declare class ListToolbarSetTypeAction {
|
|
495
|
+
type: string;
|
|
496
|
+
constructor(type: string);
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* @internal
|
|
501
|
+
* @deprecated
|
|
502
|
+
*/
|
|
503
|
+
declare class ListViewsLoadAction {
|
|
504
|
+
views: ListViewModel[];
|
|
505
|
+
constructor(views: ListViewModel[]);
|
|
506
|
+
}
|
|
507
|
+
|
|
508
|
+
/**
|
|
509
|
+
* @internal
|
|
510
|
+
* @deprecated
|
|
511
|
+
*/
|
|
512
|
+
declare class ListViewsSetActiveAction {
|
|
513
|
+
view: string;
|
|
514
|
+
constructor(view: string);
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* @internal
|
|
519
|
+
* @deprecated
|
|
520
|
+
*/
|
|
521
|
+
type ListStateAction = ListItemsSetLoadingAction | ListItemsLoadAction | ListItemsSetSelectedAction | ListPagingSetMaxPagesAction | ListPagingSetItemsPerPageAction | ListPagingSetPageNumberAction | ListViewsLoadAction | ListViewsSetActiveAction | ListToolbarItemsLoadAction | ListToolbarSetExistsAction | ListSearchSetSearchTextAction | ListSearchSetFunctionsAction | ListSearchSetFieldSelectorsAction | ListSearchSetOptionsAction | ListSelectedSetLoadingAction | ListSelectedLoadAction | ListSelectedSetItemSelectedAction | ListSelectedSetItemsSelectedAction | ListToolbarSetTypeAction | ListSortSetFieldSelectorsAction | ListSortSetAvailableAction | ListSortSetGlobalAction | ListFiltersUpdateAction | ListToolbarItemsRemoveAction | ListToolbarItemsDisableAction;
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* @internal
|
|
525
|
+
* @deprecated
|
|
526
|
+
*/
|
|
527
|
+
declare class ListStateOrchestrator<T> extends StateOrchestrator<T, ListStateAction> {
|
|
528
|
+
}
|
|
529
|
+
/**
|
|
530
|
+
* @internal
|
|
531
|
+
* @deprecated
|
|
532
|
+
*/
|
|
533
|
+
declare class ListStateDispatcher extends StateDispatcher<ListStateAction> {
|
|
534
|
+
viewsSetActive(id: string): void;
|
|
535
|
+
toolbarExists(exists: boolean): void;
|
|
536
|
+
toolbarSetDisabled(disabled: boolean): void;
|
|
537
|
+
toolbarAddItems(items: ListToolbarItemModel[], index?: number): void;
|
|
538
|
+
toolbarRemoveItems(ids: string[]): void;
|
|
539
|
+
toolbarShowMultiselectToolbar(show: boolean): void;
|
|
540
|
+
searchSetFunctions(sortFunctions: ((data: any, searchText: string) => boolean)[]): void;
|
|
541
|
+
searchSetFieldSelectors(fieldSelectors: string[]): void;
|
|
542
|
+
searchSetText(searchText: string): void;
|
|
543
|
+
searchSetOptions(searchOptions: ListSearchModel): void;
|
|
544
|
+
sortSetAvailable(sortLabels: ListSortLabelModel[]): void;
|
|
545
|
+
sortSetFieldSelectors(fieldSelectors: ListSortFieldSelectorModel[]): void;
|
|
546
|
+
sortSetGlobal(sortLabels: ListSortLabelModel[]): void;
|
|
547
|
+
filtersUpdate(filters: ListFilterModel[]): void;
|
|
548
|
+
setSelected(selectedIds: string[], selected: boolean, refresh?: boolean): void;
|
|
549
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ListStateDispatcher, never>;
|
|
550
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ListStateDispatcher>;
|
|
551
|
+
}
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* @internal
|
|
555
|
+
* @deprecated
|
|
556
|
+
*/
|
|
557
|
+
declare class ListState extends StateNode<ListStateModel> {
|
|
558
|
+
constructor(dispatcher: ListStateDispatcher);
|
|
559
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ListState, never>;
|
|
560
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ListState>;
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* @internal
|
|
565
|
+
* @deprecated
|
|
566
|
+
*/
|
|
567
|
+
declare abstract class ListViewComponent {
|
|
568
|
+
active: Observable<boolean>;
|
|
569
|
+
protected viewName: string;
|
|
570
|
+
protected state: ListState;
|
|
571
|
+
protected list: SkyListComponent;
|
|
572
|
+
protected hasToolbar: Observable<boolean>;
|
|
573
|
+
private viewId;
|
|
574
|
+
constructor(state: ListState, defaultName: string);
|
|
575
|
+
get id(): string;
|
|
576
|
+
get label(): string;
|
|
577
|
+
onViewActive(): void;
|
|
578
|
+
onViewInactive(): void;
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager.
|
|
583
|
+
*/
|
|
584
|
+
declare class SkyListComponent implements AfterContentInit, OnChanges, OnDestroy {
|
|
585
|
+
private state;
|
|
586
|
+
private dispatcher;
|
|
587
|
+
id: string;
|
|
588
|
+
/**
|
|
589
|
+
* The data to display. The list component requires this property or the
|
|
590
|
+
* `dataProvider` property. For checklist or multiselect grids, each row requires an
|
|
591
|
+
* `id` property to manage selected items with the `selectedIds` input and the
|
|
592
|
+
* `selectedIdsChange` event. If you do not provide an `id`, the list automatically
|
|
593
|
+
* generates one. To update data in your view outside of a `dataProvider`, you must use
|
|
594
|
+
* an observable instead of a static array.
|
|
595
|
+
*/
|
|
596
|
+
data?: any[] | Observable<any[]>;
|
|
597
|
+
/**
|
|
598
|
+
* The data provider that obtains the data to display. The list component requires
|
|
599
|
+
* this property or the `data` property. For lists that use `dataProvider` instead of `data`,
|
|
600
|
+
* consumers are responsible for managing all `ListDataRequestModel` properties.
|
|
601
|
+
* @default SkyListInMemoryDataProvider
|
|
602
|
+
*/
|
|
603
|
+
dataProvider?: ListDataProvider;
|
|
604
|
+
/**
|
|
605
|
+
* @internal
|
|
606
|
+
*/
|
|
607
|
+
defaultView?: ListViewComponent;
|
|
608
|
+
/**
|
|
609
|
+
* The total number of items for the initial data set when initialized. When
|
|
610
|
+
* used in conjunction with `data` and `dataProvider`, it allows an initial data to be
|
|
611
|
+
* set with the need to call the `dataProvider`.
|
|
612
|
+
*/
|
|
613
|
+
initialTotal?: number;
|
|
614
|
+
/**
|
|
615
|
+
* The set of IDs for the items to select in a checklist or multiselect grid.
|
|
616
|
+
* The IDs match the `id` properties of the `data` objects. Items with IDs that are not
|
|
617
|
+
* included are de-selected in the checklist or multiselect grid.
|
|
618
|
+
*/
|
|
619
|
+
selectedIds?: string[] | Observable<string[]>;
|
|
620
|
+
/**
|
|
621
|
+
* The set of fields to sort by. If array of fields then sorted by order of array.
|
|
622
|
+
* For information about `ListSortFieldSelectorModel`, see the
|
|
623
|
+
* [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).
|
|
624
|
+
*/
|
|
625
|
+
sortFields?: ListSortFieldSelectorModel | ListSortFieldSelectorModel[] | Observable<ListSortFieldSelectorModel[]> | Observable<ListSortFieldSelectorModel>;
|
|
626
|
+
/**
|
|
627
|
+
* The set of filters to apply to list data.
|
|
628
|
+
* These filters create a filter summary when the list includes the
|
|
629
|
+
* [`sky-list-filter-summary`](https://developer.blackbaud.com/skyux/components/list/filters)
|
|
630
|
+
* component.
|
|
631
|
+
*/
|
|
632
|
+
appliedFilters: ListFilterModel[];
|
|
633
|
+
/**
|
|
634
|
+
* For list views that support item selection, emits the selected entries.
|
|
635
|
+
*/
|
|
636
|
+
selectedIdsChange: EventEmitter<Map<string, boolean>>;
|
|
637
|
+
/**
|
|
638
|
+
* Emits the filters applied to the list.
|
|
639
|
+
*/
|
|
640
|
+
appliedFiltersChange: EventEmitter<ListFilterModel[]>;
|
|
641
|
+
/**
|
|
642
|
+
* The function to apply as a global sort on the list.
|
|
643
|
+
*/
|
|
644
|
+
searchFunction: (data: any, searchText: string) => boolean;
|
|
645
|
+
private dataFirstLoad;
|
|
646
|
+
private listViews;
|
|
647
|
+
private lastSelectedIds;
|
|
648
|
+
private lastFilters;
|
|
649
|
+
private ngUnsubscribe;
|
|
650
|
+
constructor(state: ListState, dispatcher: ListStateDispatcher, logger: SkyLogService);
|
|
651
|
+
ngAfterContentInit(): void;
|
|
652
|
+
ngOnChanges(changes: SimpleChanges): void;
|
|
653
|
+
ngOnDestroy(): void;
|
|
654
|
+
refreshDisplayedItems(): void;
|
|
655
|
+
get displayedItems(): Observable<ListDataResponseModel>;
|
|
656
|
+
get selectedItems(): Observable<ListItemModel[]>;
|
|
657
|
+
get lastUpdate(): Observable<Date>;
|
|
658
|
+
get views(): ListViewComponent[];
|
|
659
|
+
get itemCount(): Observable<number>;
|
|
660
|
+
private getItemsAndRetainSelections;
|
|
661
|
+
private arraysEqual;
|
|
662
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListComponent, never>;
|
|
663
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListComponent, "sky-list", never, { "data": { "alias": "data"; "required": false; }; "dataProvider": { "alias": "dataProvider"; "required": false; }; "defaultView": { "alias": "defaultView"; "required": false; }; "initialTotal": { "alias": "initialTotal"; "required": false; }; "selectedIds": { "alias": "selectedIds"; "required": false; }; "sortFields": { "alias": "sortFields"; "required": false; }; "appliedFilters": { "alias": "appliedFilters"; "required": false; }; "searchFunction": { "alias": "search"; "required": false; }; }, { "selectedIdsChange": "selectedIdsChange"; "appliedFiltersChange": "appliedFiltersChange"; }, ["listViews"], ["*"], false, never>;
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
/**
|
|
667
|
+
* @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager.
|
|
668
|
+
*/
|
|
669
|
+
declare class SkyListModule {
|
|
670
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListModule, never>;
|
|
671
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyListModule, [typeof SkyListComponent], [typeof i2.CommonModule], [typeof SkyListComponent]>;
|
|
672
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyListModule>;
|
|
673
|
+
}
|
|
674
|
+
|
|
675
|
+
/**
|
|
676
|
+
* @internal
|
|
677
|
+
* @deprecated
|
|
678
|
+
*/
|
|
679
|
+
declare class ListFiltersOrchestrator extends ListStateOrchestrator<ListFilterModel[]> {
|
|
680
|
+
constructor();
|
|
681
|
+
private update;
|
|
682
|
+
}
|
|
683
|
+
|
|
684
|
+
/**
|
|
685
|
+
* @internal
|
|
686
|
+
* @deprecated
|
|
687
|
+
*/
|
|
688
|
+
declare class ListItemsOrchestrator extends ListStateOrchestrator<AsyncList<ListItemModel>> {
|
|
689
|
+
constructor();
|
|
690
|
+
private setLoading;
|
|
691
|
+
private load;
|
|
692
|
+
private setItemsSelected;
|
|
693
|
+
private cloneListItemModelArray;
|
|
694
|
+
}
|
|
695
|
+
|
|
696
|
+
/**
|
|
697
|
+
* @internal
|
|
698
|
+
* @deprecated
|
|
699
|
+
*/
|
|
700
|
+
declare class ListPagingOrchestrator extends ListStateOrchestrator<ListPagingModel> {
|
|
701
|
+
constructor();
|
|
702
|
+
private setMaxPages;
|
|
703
|
+
private setItemsPerPage;
|
|
704
|
+
private setPageNumber;
|
|
705
|
+
}
|
|
706
|
+
|
|
707
|
+
/**
|
|
708
|
+
* @internal
|
|
709
|
+
* @deprecated
|
|
710
|
+
*/
|
|
711
|
+
declare class ListSearchOrchestrator extends ListStateOrchestrator<ListSearchModel> {
|
|
712
|
+
constructor();
|
|
713
|
+
private setSearchText;
|
|
714
|
+
private setFunctions;
|
|
715
|
+
private setFieldSelectors;
|
|
716
|
+
private setOptions;
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
/**
|
|
720
|
+
* @internal
|
|
721
|
+
* @deprecated
|
|
722
|
+
*/
|
|
723
|
+
declare class ListSelectedOrchestrator extends ListStateOrchestrator<AsyncItem<ListSelectedModel>> {
|
|
724
|
+
constructor();
|
|
725
|
+
private setLoading;
|
|
726
|
+
private load;
|
|
727
|
+
private setItemSelected;
|
|
728
|
+
private setItemsSelected;
|
|
729
|
+
private cloneListSelectedModel;
|
|
730
|
+
}
|
|
731
|
+
|
|
732
|
+
/**
|
|
733
|
+
* @internal
|
|
734
|
+
* @deprecated
|
|
735
|
+
*/
|
|
736
|
+
declare class ListSortOrchestrator extends ListStateOrchestrator<ListSortModel> {
|
|
737
|
+
constructor();
|
|
738
|
+
private setFieldSelectors;
|
|
739
|
+
private setAvailable;
|
|
740
|
+
private setGlobal;
|
|
741
|
+
}
|
|
742
|
+
|
|
743
|
+
/**
|
|
744
|
+
* @internal
|
|
745
|
+
* @deprecated
|
|
746
|
+
*/
|
|
747
|
+
declare class ListToolbarShowMultiselectToolbarAction {
|
|
748
|
+
exists: boolean;
|
|
749
|
+
constructor(exists: boolean);
|
|
750
|
+
}
|
|
751
|
+
|
|
752
|
+
/**
|
|
753
|
+
* @internal
|
|
754
|
+
* @deprecated
|
|
755
|
+
*/
|
|
756
|
+
declare class ListToolbarOrchestrator extends ListStateOrchestrator<ListToolbarModel> {
|
|
757
|
+
constructor();
|
|
758
|
+
private setExists;
|
|
759
|
+
private setDisabled;
|
|
760
|
+
private setType;
|
|
761
|
+
private load;
|
|
762
|
+
private remove;
|
|
763
|
+
private showMultiselectToolbar;
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
/**
|
|
767
|
+
* @internal
|
|
768
|
+
* @deprecated
|
|
769
|
+
*/
|
|
770
|
+
declare class ListViewsOrchestrator extends ListStateOrchestrator<ListViewsModel> {
|
|
771
|
+
constructor();
|
|
772
|
+
private setActive;
|
|
773
|
+
private load;
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
/**
|
|
777
|
+
* @deprecated
|
|
778
|
+
*/
|
|
779
|
+
declare class SkyListInMemoryDataProvider extends ListDataProvider {
|
|
780
|
+
items: BehaviorSubject<ListItemModel[]>;
|
|
781
|
+
private lastItems;
|
|
782
|
+
private lastSearch;
|
|
783
|
+
private lastSearchResults;
|
|
784
|
+
private searchFunction;
|
|
785
|
+
private lastFilters;
|
|
786
|
+
private lastFilterResults;
|
|
787
|
+
constructor(data?: Observable<any[]>, searchFunction?: (data: any, searchText: string) => boolean);
|
|
788
|
+
count(): Observable<number>;
|
|
789
|
+
get(request: ListDataRequestModel): Observable<ListDataResponseModel>;
|
|
790
|
+
private filteredItems;
|
|
791
|
+
}
|
|
792
|
+
|
|
793
|
+
/**
|
|
794
|
+
* @internal
|
|
795
|
+
*/
|
|
796
|
+
declare class SkyListFilterInlineModel {
|
|
797
|
+
name: string;
|
|
798
|
+
value: any;
|
|
799
|
+
defaultValue: any;
|
|
800
|
+
filterFunction: (item: ListItemModel, filter: any) => boolean;
|
|
801
|
+
onChange: EventEmitter<any>;
|
|
802
|
+
template: TemplateRef<unknown>;
|
|
803
|
+
constructor(data?: any);
|
|
804
|
+
changed(value: any): void;
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
/**
|
|
808
|
+
* Contains a filter button for the list toolbar. Place a
|
|
809
|
+
* [`sky-filter-button`](https://developer.blackbaud.com/skyux/components/filter)
|
|
810
|
+
* component inside this component to open a modal with filtering options.
|
|
811
|
+
* To apply filter options, use the
|
|
812
|
+
* [list component's](https://developer.blackbaud.com/skyux/components/list/overview#list-properties)
|
|
813
|
+
* `appliedFilters` property.
|
|
814
|
+
* @deprecated
|
|
815
|
+
*/
|
|
816
|
+
declare class SkyListFilterButtonComponent implements AfterViewInit {
|
|
817
|
+
private dispatcher;
|
|
818
|
+
private filterButtonTemplate;
|
|
819
|
+
private filterButtonItemToolbarIndex;
|
|
820
|
+
constructor(dispatcher: ListStateDispatcher);
|
|
821
|
+
ngAfterViewInit(): void;
|
|
822
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListFilterButtonComponent, never>;
|
|
823
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListFilterButtonComponent, "sky-list-filter-button", never, {}, {}, never, ["*"], false, never>;
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
/**
|
|
827
|
+
* Creates a filter summary based on the
|
|
828
|
+
* [list component's](https://developer.blackbaud.com/skyux/components/list/overview#list-properties)
|
|
829
|
+
* `appliedFilters` property. Place this component within the
|
|
830
|
+
* [`sky-list-toolbar`](https://developer.blackbaud.com/skyux/components/list/toolbar) component.
|
|
831
|
+
* @deprecated
|
|
832
|
+
*/
|
|
833
|
+
declare class SkyListFilterSummaryComponent implements AfterContentInit {
|
|
834
|
+
private state;
|
|
835
|
+
private dispatcher;
|
|
836
|
+
/**
|
|
837
|
+
* Emits a `ListFilterModel` when users select a summary item. A common use case is
|
|
838
|
+
* to open a filter modal when this event is received.
|
|
839
|
+
*/
|
|
840
|
+
summaryItemClick: EventEmitter<ListFilterModel>;
|
|
841
|
+
appliedFilters: Observable<ListFilterModel[]>;
|
|
842
|
+
constructor(state: ListState, dispatcher: ListStateDispatcher);
|
|
843
|
+
ngAfterContentInit(): void;
|
|
844
|
+
filterSummaryItemDismiss(index: number): void;
|
|
845
|
+
filterSummaryItemClick(item: ListFilterModel): void;
|
|
846
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListFilterSummaryComponent, never>;
|
|
847
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListFilterSummaryComponent, "sky-list-filter-summary", never, {}, { "summaryItemClick": "summaryItemClick"; }, never, never, false, never>;
|
|
848
|
+
}
|
|
849
|
+
|
|
850
|
+
/**
|
|
851
|
+
* Creates a filter in the list's inline filter area.
|
|
852
|
+
* @deprecated
|
|
853
|
+
*/
|
|
854
|
+
declare class SkyListFilterInlineItemComponent implements OnInit {
|
|
855
|
+
/**
|
|
856
|
+
* The name of the filter.
|
|
857
|
+
* @required
|
|
858
|
+
*/
|
|
859
|
+
name: string;
|
|
860
|
+
/**
|
|
861
|
+
* The current value of the filter.
|
|
862
|
+
*/
|
|
863
|
+
value: any;
|
|
864
|
+
/**
|
|
865
|
+
* The default value of the filter. If the value of the filter
|
|
866
|
+
* is set to the default value, then the filter is not applied.
|
|
867
|
+
*/
|
|
868
|
+
defaultValue: any;
|
|
869
|
+
/**
|
|
870
|
+
* The function that determines whether an item is filtered.
|
|
871
|
+
* This property is required when using an in-memory data provider. For information
|
|
872
|
+
* about `ListItemModel`, see the
|
|
873
|
+
* [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).
|
|
874
|
+
*/
|
|
875
|
+
filterFunction: (item: ListItemModel, filter: any) => boolean;
|
|
876
|
+
/**
|
|
877
|
+
* The template for the filter. The template can access the `filter`
|
|
878
|
+
* variable that contains the `value` of the filter control, which should be bound to
|
|
879
|
+
* `ngModel`, and the `changed` function, which should be called when the model changes.
|
|
880
|
+
* @required
|
|
881
|
+
*/
|
|
882
|
+
templateInput: TemplateRef<unknown>;
|
|
883
|
+
onChange: EventEmitter<any>;
|
|
884
|
+
private templates;
|
|
885
|
+
ngOnInit(): void;
|
|
886
|
+
get template(): TemplateRef<unknown>;
|
|
887
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListFilterInlineItemComponent, never>;
|
|
888
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListFilterInlineItemComponent, "sky-list-filter-inline-item", never, { "name": { "alias": "name"; "required": false; }; "value": { "alias": "value"; "required": false; }; "defaultValue": { "alias": "defaultValue"; "required": false; }; "filterFunction": { "alias": "filter"; "required": false; }; "templateInput": { "alias": "template"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
/**
|
|
892
|
+
* Creates an inline filter area for the list. Place each filter
|
|
893
|
+
* in a `sky-list-filter-inline-item` component.
|
|
894
|
+
* @deprecated
|
|
895
|
+
*/
|
|
896
|
+
declare class SkyListFilterInlineComponent implements AfterContentInit {
|
|
897
|
+
private dispatcher;
|
|
898
|
+
private state;
|
|
899
|
+
inlineFilters: SkyListFilterInlineModel[];
|
|
900
|
+
private filters;
|
|
901
|
+
constructor(dispatcher: ListStateDispatcher, state: ListState);
|
|
902
|
+
ngAfterContentInit(): void;
|
|
903
|
+
applyFilters(): void;
|
|
904
|
+
private getFilterModelFromInline;
|
|
905
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListFilterInlineComponent, never>;
|
|
906
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListFilterInlineComponent, "sky-list-filter-inline", never, {}, {}, ["filters"], ["*"], false, never>;
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
/**
|
|
910
|
+
* @internal
|
|
911
|
+
*/
|
|
912
|
+
declare class SkyListFilterInlineItemRendererComponent implements OnInit {
|
|
913
|
+
template: TemplateRef<unknown>;
|
|
914
|
+
filter: any;
|
|
915
|
+
private container;
|
|
916
|
+
ngOnInit(): void;
|
|
917
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListFilterInlineItemRendererComponent, never>;
|
|
918
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListFilterInlineItemRendererComponent, "sky-list-filter-inline-item-renderer", never, { "template": { "alias": "template"; "required": false; }; "filter": { "alias": "filter"; "required": false; }; }, {}, never, never, false, never>;
|
|
919
|
+
}
|
|
920
|
+
|
|
921
|
+
/**
|
|
922
|
+
* @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager.
|
|
923
|
+
*/
|
|
924
|
+
declare class SkyListFiltersModule {
|
|
925
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListFiltersModule, never>;
|
|
926
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyListFiltersModule, [typeof SkyListFilterButtonComponent, typeof SkyListFilterSummaryComponent, typeof SkyListFilterInlineItemComponent, typeof SkyListFilterInlineComponent, typeof SkyListFilterInlineItemRendererComponent], [typeof i2.CommonModule, typeof i12.SkyFilterModule], [typeof SkyListFilterButtonComponent, typeof SkyListFilterSummaryComponent, typeof SkyListFilterInlineItemComponent, typeof SkyListFilterInlineComponent]>;
|
|
927
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyListFiltersModule>;
|
|
928
|
+
}
|
|
929
|
+
|
|
930
|
+
/**
|
|
931
|
+
* The SKY UX-themed pagination control that displays list data across multiple pages.
|
|
932
|
+
* @internal
|
|
933
|
+
* @deprecated
|
|
934
|
+
*/
|
|
935
|
+
declare abstract class ListPagingComponent {
|
|
936
|
+
protected initialized: BehaviorSubject<boolean>;
|
|
937
|
+
protected state: ListState;
|
|
938
|
+
protected dispatcher: ListStateDispatcher;
|
|
939
|
+
constructor(state: ListState, dispatcher: ListStateDispatcher);
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* Displays a pagination control for a SKY UX-themed list of data.
|
|
944
|
+
* @deprecated
|
|
945
|
+
*/
|
|
946
|
+
declare class SkyListPagingComponent extends ListPagingComponent implements OnInit {
|
|
947
|
+
/**
|
|
948
|
+
* The number of list items per page.
|
|
949
|
+
* @default 10
|
|
950
|
+
*/
|
|
951
|
+
pageSize: Observable<number> | number;
|
|
952
|
+
/**
|
|
953
|
+
* The maximum pages to display.
|
|
954
|
+
* @default 5
|
|
955
|
+
*/
|
|
956
|
+
maxPages: Observable<number> | number;
|
|
957
|
+
/**
|
|
958
|
+
* The current page number.
|
|
959
|
+
* @default 1
|
|
960
|
+
*/
|
|
961
|
+
pageNumber: Observable<number> | number;
|
|
962
|
+
currentPageNumber: Observable<number>;
|
|
963
|
+
maxDisplayedPages: Observable<number>;
|
|
964
|
+
itemsPerPage: Observable<number>;
|
|
965
|
+
itemCount: Observable<number>;
|
|
966
|
+
constructor(state: ListState, dispatcher: ListStateDispatcher, logger: SkyLogService);
|
|
967
|
+
ngOnInit(): void;
|
|
968
|
+
pageChange(currentPage: number): void;
|
|
969
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListPagingComponent, never>;
|
|
970
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListPagingComponent, "sky-list-paging", never, { "pageSize": { "alias": "pageSize"; "required": false; }; "maxPages": { "alias": "maxPages"; "required": false; }; "pageNumber": { "alias": "pageNumber"; "required": false; }; }, {}, never, never, false, never>;
|
|
971
|
+
}
|
|
972
|
+
|
|
973
|
+
/**
|
|
974
|
+
* @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager.
|
|
975
|
+
*/
|
|
976
|
+
declare class SkyListPagingModule {
|
|
977
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListPagingModule, never>;
|
|
978
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyListPagingModule, [typeof SkyListPagingComponent], [typeof i2.CommonModule, typeof i12.SkyPagingModule], [typeof SkyListPagingComponent]>;
|
|
979
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyListPagingModule>;
|
|
980
|
+
}
|
|
981
|
+
|
|
982
|
+
/**
|
|
983
|
+
* @internal
|
|
984
|
+
* @deprecated
|
|
985
|
+
*/
|
|
986
|
+
interface SkyListSecondaryAction {
|
|
987
|
+
template: TemplateRef<unknown>;
|
|
988
|
+
}
|
|
989
|
+
|
|
990
|
+
/**
|
|
991
|
+
* Adds a dropdown to the list toolbar for secondary actions. If the dropdown does not
|
|
992
|
+
* include actions, the secondary actions dropdown is hidden.
|
|
993
|
+
* @deprecated
|
|
994
|
+
*/
|
|
995
|
+
declare class SkyListSecondaryActionsComponent implements AfterViewInit {
|
|
996
|
+
private dispatcher;
|
|
997
|
+
actions: any[];
|
|
998
|
+
private secondaryActionsTemplate;
|
|
999
|
+
private secondaryActionsItemToolbarIndex;
|
|
1000
|
+
constructor(dispatcher: ListStateDispatcher);
|
|
1001
|
+
ngAfterViewInit(): void;
|
|
1002
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListSecondaryActionsComponent, never>;
|
|
1003
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListSecondaryActionsComponent, "sky-list-secondary-actions", never, {}, {}, never, ["*"], false, never>;
|
|
1004
|
+
}
|
|
1005
|
+
|
|
1006
|
+
/**
|
|
1007
|
+
* @internal
|
|
1008
|
+
*/
|
|
1009
|
+
declare class SkyListSecondaryActionsService implements OnDestroy {
|
|
1010
|
+
secondaryActionsCount: number;
|
|
1011
|
+
secondaryActionsSubject: BehaviorSubject<number>;
|
|
1012
|
+
actionsStream: BehaviorSubject<SkyListSecondaryAction[]>;
|
|
1013
|
+
private actions;
|
|
1014
|
+
addSecondaryAction(action: SkyListSecondaryAction): void;
|
|
1015
|
+
removeSecondaryAction(action: any): void;
|
|
1016
|
+
ngOnDestroy(): void;
|
|
1017
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListSecondaryActionsService, never>;
|
|
1018
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyListSecondaryActionsService>;
|
|
1019
|
+
}
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
* @internal
|
|
1023
|
+
*/
|
|
1024
|
+
declare class SkyListSecondaryActionsHostComponent implements OnInit, OnDestroy {
|
|
1025
|
+
private changeDetector;
|
|
1026
|
+
private actionService;
|
|
1027
|
+
dropdownHidden: boolean;
|
|
1028
|
+
actions: any[];
|
|
1029
|
+
private ngUnsubscribe;
|
|
1030
|
+
constructor(changeDetector: ChangeDetectorRef, actionService: SkyListSecondaryActionsService);
|
|
1031
|
+
ngOnInit(): void;
|
|
1032
|
+
ngOnDestroy(): void;
|
|
1033
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListSecondaryActionsHostComponent, never>;
|
|
1034
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListSecondaryActionsHostComponent, "sky-list-secondary-actions-host", never, {}, {}, never, ["*"], false, never>;
|
|
1035
|
+
}
|
|
1036
|
+
|
|
1037
|
+
/**
|
|
1038
|
+
* Adds actions to the secondary actions dropdown in the list toolbar.
|
|
1039
|
+
* @deprecated
|
|
1040
|
+
*/
|
|
1041
|
+
declare class SkyListSecondaryActionComponent implements AfterContentInit {
|
|
1042
|
+
private actionService;
|
|
1043
|
+
private templateRef;
|
|
1044
|
+
constructor(actionService: SkyListSecondaryActionsService);
|
|
1045
|
+
ngAfterContentInit(): void;
|
|
1046
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListSecondaryActionComponent, never>;
|
|
1047
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListSecondaryActionComponent, "sky-list-secondary-action", never, {}, {}, never, ["*"], false, never>;
|
|
1048
|
+
}
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* Import into any component library module that needs to use resource strings.
|
|
1052
|
+
*/
|
|
1053
|
+
declare class SkyListBuilderResourcesModule {
|
|
1054
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListBuilderResourcesModule, never>;
|
|
1055
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyListBuilderResourcesModule, never, never, [typeof i1.SkyI18nModule]>;
|
|
1056
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyListBuilderResourcesModule>;
|
|
1057
|
+
}
|
|
1058
|
+
|
|
1059
|
+
/**
|
|
1060
|
+
* @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager.
|
|
1061
|
+
*/
|
|
1062
|
+
declare class SkyListSecondaryActionsModule {
|
|
1063
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListSecondaryActionsModule, never>;
|
|
1064
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyListSecondaryActionsModule, [typeof SkyListSecondaryActionsComponent, typeof SkyListSecondaryActionsHostComponent, typeof SkyListSecondaryActionComponent], [typeof i2.CommonModule, typeof i5.SkyDropdownModule, typeof i6.SkyIconModule, typeof SkyListBuilderResourcesModule], [typeof SkyListSecondaryActionsComponent, typeof SkyListSecondaryActionComponent]>;
|
|
1065
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyListSecondaryActionsModule>;
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
/**
|
|
1069
|
+
* @internal
|
|
1070
|
+
*/
|
|
1071
|
+
declare class ListToolbarConfigSetSearchEnabledAction {
|
|
1072
|
+
enabled: boolean;
|
|
1073
|
+
constructor(enabled: boolean);
|
|
1074
|
+
}
|
|
1075
|
+
|
|
1076
|
+
/**
|
|
1077
|
+
* @internal
|
|
1078
|
+
*/
|
|
1079
|
+
declare class ListToolbarConfigSetSortSelectorEnabledAction {
|
|
1080
|
+
enabled: boolean;
|
|
1081
|
+
constructor(enabled?: boolean);
|
|
1082
|
+
}
|
|
1083
|
+
|
|
1084
|
+
/**
|
|
1085
|
+
* @internal
|
|
1086
|
+
*/
|
|
1087
|
+
type ListToolbarStateAction = ListToolbarConfigSetSearchEnabledAction | ListToolbarConfigSetSortSelectorEnabledAction;
|
|
1088
|
+
|
|
1089
|
+
/**
|
|
1090
|
+
* @internal
|
|
1091
|
+
*/
|
|
1092
|
+
declare class ListToolbarStateDispatcher extends StateDispatcher<ListToolbarStateAction> {
|
|
1093
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ListToolbarStateDispatcher, never>;
|
|
1094
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ListToolbarStateDispatcher>;
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
/**
|
|
1098
|
+
* @internal
|
|
1099
|
+
*/
|
|
1100
|
+
declare class ListToolbarConfigModel {
|
|
1101
|
+
searchEnabled: boolean;
|
|
1102
|
+
sortSelectorEnabled: boolean;
|
|
1103
|
+
constructor(data?: any);
|
|
1104
|
+
}
|
|
1105
|
+
|
|
1106
|
+
/**
|
|
1107
|
+
* @internal
|
|
1108
|
+
*/
|
|
1109
|
+
declare class ListToolbarStateModel {
|
|
1110
|
+
config: ListToolbarConfigModel;
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
/**
|
|
1114
|
+
* @internal
|
|
1115
|
+
*/
|
|
1116
|
+
declare class ListToolbarState extends StateNode<ListToolbarStateModel> {
|
|
1117
|
+
constructor(initialState: ListToolbarStateModel, dispatcher: ListToolbarStateDispatcher);
|
|
1118
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ListToolbarState, never>;
|
|
1119
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ListToolbarState>;
|
|
1120
|
+
}
|
|
1121
|
+
|
|
1122
|
+
/**
|
|
1123
|
+
* Displays a toolbar for a SKY UX-themed list of data.
|
|
1124
|
+
* @deprecated
|
|
1125
|
+
*/
|
|
1126
|
+
declare class SkyListToolbarComponent implements OnInit, AfterContentInit, OnDestroy {
|
|
1127
|
+
private changeDetector;
|
|
1128
|
+
private state;
|
|
1129
|
+
private dispatcher;
|
|
1130
|
+
private toolbarState;
|
|
1131
|
+
toolbarDispatcher: ListToolbarStateDispatcher;
|
|
1132
|
+
/**
|
|
1133
|
+
* Whether to use the in-memory search.
|
|
1134
|
+
* Setting this to `false` will allow consumers to run their own searches remotely,
|
|
1135
|
+
* and push new values to the list component by updating the `data` property.
|
|
1136
|
+
* @default true
|
|
1137
|
+
* @internal
|
|
1138
|
+
*/
|
|
1139
|
+
set inMemorySearchEnabled(value: boolean);
|
|
1140
|
+
get inMemorySearchEnabled(): boolean;
|
|
1141
|
+
/**
|
|
1142
|
+
* Placeholder text for the search bar that the list toolbar creates with
|
|
1143
|
+
* a [search component](https://developer.blackbaud.com/skyux/components/search).
|
|
1144
|
+
* @default "Find in this list"
|
|
1145
|
+
*/
|
|
1146
|
+
placeholder: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* Whether to enable the search bar.
|
|
1149
|
+
* @default true
|
|
1150
|
+
*/
|
|
1151
|
+
searchEnabled: boolean | Observable<boolean>;
|
|
1152
|
+
searchComponent: SkySearchComponent;
|
|
1153
|
+
/**
|
|
1154
|
+
* Whether to enable the sort selector.
|
|
1155
|
+
* @default false
|
|
1156
|
+
*/
|
|
1157
|
+
sortSelectorEnabled: boolean | Observable<boolean>;
|
|
1158
|
+
/**
|
|
1159
|
+
* Display the search bar in the standard position or in a separate section.
|
|
1160
|
+
* To highlight the search bar in a section above all other toolbar items,
|
|
1161
|
+
* set this property to `search`.
|
|
1162
|
+
* @default "standard"
|
|
1163
|
+
*/
|
|
1164
|
+
toolbarType: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* The text string to search with.
|
|
1167
|
+
*/
|
|
1168
|
+
searchText: string | Observable<string>;
|
|
1169
|
+
get isFilterBarDisplayed(): boolean;
|
|
1170
|
+
get filterButtonAriaControls(): string;
|
|
1171
|
+
sortSelectors: Observable<any[]>;
|
|
1172
|
+
searchTextInput: Observable<string>;
|
|
1173
|
+
view: Observable<string>;
|
|
1174
|
+
leftTemplates: ListToolbarItemModel[];
|
|
1175
|
+
centerTemplates: ListToolbarItemModel[];
|
|
1176
|
+
rightTemplates: ListToolbarItemModel[];
|
|
1177
|
+
type: Observable<string>;
|
|
1178
|
+
isSearchEnabled: Observable<boolean>;
|
|
1179
|
+
isToolbarDisabled: boolean;
|
|
1180
|
+
isMultiselectEnabled: Observable<boolean>;
|
|
1181
|
+
isSortSelectorEnabled: Observable<boolean>;
|
|
1182
|
+
appliedFilters: Observable<ListFilterModel[]>;
|
|
1183
|
+
hasAppliedFilters: Observable<boolean>;
|
|
1184
|
+
showFilterSummary: boolean;
|
|
1185
|
+
hasInlineFilters: boolean;
|
|
1186
|
+
inlineFilterBarExpanded: boolean;
|
|
1187
|
+
hasAdditionalToolbarSection: boolean;
|
|
1188
|
+
hasViewActions: boolean;
|
|
1189
|
+
filterButtonId: string;
|
|
1190
|
+
listFilterInlineId: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* Fires when users submit a search.
|
|
1193
|
+
* @internal
|
|
1194
|
+
* @deprecated
|
|
1195
|
+
*/
|
|
1196
|
+
searchApplied: Subject<string>;
|
|
1197
|
+
private toolbarItems;
|
|
1198
|
+
private toolbarSorts;
|
|
1199
|
+
private filterSummary;
|
|
1200
|
+
private inlineFilter;
|
|
1201
|
+
private viewActions;
|
|
1202
|
+
private searchTemplate;
|
|
1203
|
+
private sortSelectorTemplate;
|
|
1204
|
+
private inlineFilterButtonTemplate;
|
|
1205
|
+
private customItemIds;
|
|
1206
|
+
private hasSortSelectors;
|
|
1207
|
+
private inlineFiltersItemToolbarIndex;
|
|
1208
|
+
private sortSelectorItemToolbarIndex;
|
|
1209
|
+
private ngUnsubscribe;
|
|
1210
|
+
private _inMemorySearchEnabled;
|
|
1211
|
+
constructor(changeDetector: ChangeDetectorRef, state: ListState, dispatcher: ListStateDispatcher, toolbarState: ListToolbarState, toolbarDispatcher: ListToolbarStateDispatcher, logger: SkyLogService);
|
|
1212
|
+
ngOnInit(): void;
|
|
1213
|
+
ngAfterContentInit(): void;
|
|
1214
|
+
ngOnDestroy(): void;
|
|
1215
|
+
setSort(sort: ListSortLabelModel): void;
|
|
1216
|
+
inlineFilterButtonClick(): void;
|
|
1217
|
+
updateSearchText(searchText: string): void;
|
|
1218
|
+
private itemIsInView;
|
|
1219
|
+
private getSortSelectors;
|
|
1220
|
+
private watchTemplates;
|
|
1221
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListToolbarComponent, never>;
|
|
1222
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListToolbarComponent, "sky-list-toolbar", never, { "inMemorySearchEnabled": { "alias": "inMemorySearchEnabled"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "searchEnabled": { "alias": "searchEnabled"; "required": false; }; "sortSelectorEnabled": { "alias": "sortSelectorEnabled"; "required": false; }; "toolbarType": { "alias": "toolbarType"; "required": false; }; "searchText": { "alias": "searchText"; "required": false; }; }, {}, ["toolbarItems", "toolbarSorts", "filterSummary", "inlineFilter", "viewActions"], ["*", "sky-list-toolbar-view-actions", "sky-list-filter-summary", "*", "sky-list-toolbar-view-actions", "sky-list-filter-inline", "sky-list-toolbar-search-actions"], false, never>;
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1225
|
+
/**
|
|
1226
|
+
* Defines a toolbar item for the list toolbar.
|
|
1227
|
+
* @deprecated
|
|
1228
|
+
*/
|
|
1229
|
+
declare class SkyListToolbarItemComponent {
|
|
1230
|
+
/**
|
|
1231
|
+
* The ID of the item.
|
|
1232
|
+
*/
|
|
1233
|
+
id: string;
|
|
1234
|
+
/**
|
|
1235
|
+
* The index of the item at the given item location.
|
|
1236
|
+
* @default -1
|
|
1237
|
+
*/
|
|
1238
|
+
index: number;
|
|
1239
|
+
/**
|
|
1240
|
+
* The toolbar location of the item. The valid options are `"left"`,
|
|
1241
|
+
* `"center"`, and `"right"`.
|
|
1242
|
+
* @default "left"
|
|
1243
|
+
*/
|
|
1244
|
+
location: string;
|
|
1245
|
+
private templates;
|
|
1246
|
+
get template(): TemplateRef<unknown>;
|
|
1247
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListToolbarItemComponent, never>;
|
|
1248
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListToolbarItemComponent, "sky-list-toolbar-item", never, { "id": { "alias": "id"; "required": false; }; "index": { "alias": "index"; "required": false; }; "location": { "alias": "location"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;
|
|
1249
|
+
}
|
|
1250
|
+
|
|
1251
|
+
/**
|
|
1252
|
+
* @internal
|
|
1253
|
+
*/
|
|
1254
|
+
declare class SkyListToolbarItemRendererComponent implements OnInit {
|
|
1255
|
+
template: TemplateRef<unknown>;
|
|
1256
|
+
private container;
|
|
1257
|
+
ngOnInit(): void;
|
|
1258
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListToolbarItemRendererComponent, never>;
|
|
1259
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListToolbarItemRendererComponent, "sky-list-toolbar-item-renderer", never, { "template": { "alias": "template"; "required": false; }; }, {}, never, never, false, never>;
|
|
1260
|
+
}
|
|
1261
|
+
|
|
1262
|
+
/**
|
|
1263
|
+
* @internal
|
|
1264
|
+
* @deprecated
|
|
1265
|
+
*/
|
|
1266
|
+
declare class SkyListMultiselectToolbarComponent implements OnInit, OnDestroy {
|
|
1267
|
+
private state;
|
|
1268
|
+
private dispatcher;
|
|
1269
|
+
showOnlySelected: boolean;
|
|
1270
|
+
multiselectToolbarId: string;
|
|
1271
|
+
private selectedIdMap;
|
|
1272
|
+
private ngUnsubscribe;
|
|
1273
|
+
constructor(state: ListState, dispatcher: ListStateDispatcher);
|
|
1274
|
+
ngOnInit(): void;
|
|
1275
|
+
ngOnDestroy(): void;
|
|
1276
|
+
selectAll(): void;
|
|
1277
|
+
clearSelections(): void;
|
|
1278
|
+
changeVisibleItems(change: SkyCheckboxChange): void;
|
|
1279
|
+
private reapplyFilter;
|
|
1280
|
+
private getShowSelectedFilter;
|
|
1281
|
+
private showSelectedValuesEqual;
|
|
1282
|
+
private selectedMapEqual;
|
|
1283
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListMultiselectToolbarComponent, never>;
|
|
1284
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListMultiselectToolbarComponent, "sky-list-multiselect-toolbar", never, { "showOnlySelected": { "alias": "showOnlySelected"; "required": false; }; }, {}, never, never, false, never>;
|
|
1285
|
+
}
|
|
1286
|
+
|
|
1287
|
+
/**
|
|
1288
|
+
* Displays custom actions in the toolbar beside to the search bar.
|
|
1289
|
+
* @deprecated
|
|
1290
|
+
*/
|
|
1291
|
+
declare class SkyListToolbarSearchActionsComponent {
|
|
1292
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListToolbarSearchActionsComponent, never>;
|
|
1293
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListToolbarSearchActionsComponent, "sky-list-toolbar-search-actions", never, {}, {}, never, ["*"], false, never>;
|
|
1294
|
+
}
|
|
1295
|
+
|
|
1296
|
+
/**
|
|
1297
|
+
* Adds a sort dropdown to the list toolbar.
|
|
1298
|
+
* @deprecated
|
|
1299
|
+
*/
|
|
1300
|
+
declare class SkyListToolbarSortComponent {
|
|
1301
|
+
/**
|
|
1302
|
+
* The label for a sort option.
|
|
1303
|
+
* @required
|
|
1304
|
+
*/
|
|
1305
|
+
label: string;
|
|
1306
|
+
/**
|
|
1307
|
+
* The data field to sort the list on.
|
|
1308
|
+
* @required
|
|
1309
|
+
*/
|
|
1310
|
+
field: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* The data type of the data field to sort the list on.
|
|
1313
|
+
* @required
|
|
1314
|
+
*/
|
|
1315
|
+
type: string;
|
|
1316
|
+
/**
|
|
1317
|
+
* Whether to sort data in descending order.
|
|
1318
|
+
* @default false
|
|
1319
|
+
*/
|
|
1320
|
+
descending: boolean;
|
|
1321
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListToolbarSortComponent, never>;
|
|
1322
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListToolbarSortComponent, "sky-list-toolbar-sort", never, { "label": { "alias": "label"; "required": false; }; "field": { "alias": "field"; "required": false; }; "type": { "alias": "type"; "required": false; }; "descending": { "alias": "descending"; "required": false; }; }, {}, never, never, false, never>;
|
|
1323
|
+
}
|
|
1324
|
+
|
|
1325
|
+
/**
|
|
1326
|
+
* Adds a section on the right side of the toolbar for items that substantially change
|
|
1327
|
+
* or affect the view of the list. This includes simple filters and view switchers.
|
|
1328
|
+
* If the view section includes more than one item, simple filters appear on the left
|
|
1329
|
+
* and view switchers appear on the right.
|
|
1330
|
+
* @deprecated
|
|
1331
|
+
*/
|
|
1332
|
+
declare class SkyListToolbarViewActionsComponent {
|
|
1333
|
+
constructor(logger: SkyLogService);
|
|
1334
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListToolbarViewActionsComponent, never>;
|
|
1335
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyListToolbarViewActionsComponent, "sky-list-toolbar-view-actions", never, {}, {}, never, ["*"], false, never>;
|
|
1336
|
+
}
|
|
1337
|
+
|
|
1338
|
+
/**
|
|
1339
|
+
* @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager.
|
|
1340
|
+
*/
|
|
1341
|
+
declare class SkyListToolbarModule {
|
|
1342
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyListToolbarModule, never>;
|
|
1343
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyListToolbarModule, [typeof SkyListToolbarComponent, typeof SkyListToolbarItemComponent, typeof SkyListToolbarItemRendererComponent, typeof SkyListMultiselectToolbarComponent, typeof SkyListToolbarSearchActionsComponent, typeof SkyListToolbarSortComponent, typeof SkyListToolbarViewActionsComponent], [typeof i2.CommonModule, typeof i9.SkyCheckboxModule, typeof i10.SkyToolbarModule, typeof i11.SkySearchModule, typeof i12.SkySortModule, typeof i12.SkyFilterModule, typeof SkyListFiltersModule, typeof i6.SkyIconModule, typeof SkyListBuilderResourcesModule], [typeof SkyListToolbarComponent, typeof SkyListToolbarItemComponent, typeof SkyListToolbarSearchActionsComponent, typeof SkyListToolbarSortComponent, typeof SkyListToolbarViewActionsComponent]>;
|
|
1344
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyListToolbarModule>;
|
|
1345
|
+
}
|
|
1346
|
+
|
|
1347
|
+
export { ListDataProvider, ListDataRequestModel, ListDataResponseModel, ListFilterModel, ListFiltersOrchestrator, ListFiltersUpdateAction, ListItemsLoadAction, ListItemsOrchestrator, ListItemsSetLoadingAction, ListItemsSetSelectedAction, ListPagingModel, ListPagingOrchestrator, ListPagingSetItemsPerPageAction, ListPagingSetMaxPagesAction, ListPagingSetPageNumberAction, ListSearchModel, ListSearchOrchestrator, ListSearchSetFieldSelectorsAction, ListSearchSetFunctionsAction, ListSearchSetOptionsAction, ListSearchSetSearchTextAction, ListSelectedLoadAction, ListSelectedModel, ListSelectedOrchestrator, ListSelectedSetItemSelectedAction, ListSelectedSetItemsSelectedAction, ListSelectedSetLoadingAction, ListSortLabelModel, ListSortModel, ListSortOrchestrator, ListSortSetAvailableAction, ListSortSetFieldSelectorsAction, ListSortSetGlobalAction, ListState, ListStateDispatcher, ListStateModel, ListStateOrchestrator, ListToolbarItemModel, ListToolbarItemsDisableAction, ListToolbarItemsLoadAction, ListToolbarItemsRemoveAction, ListToolbarModel, ListToolbarOrchestrator, ListToolbarSetExistsAction, ListToolbarSetTypeAction, ListToolbarShowMultiselectToolbarAction, ListViewComponent, ListViewModel, ListViewsLoadAction, ListViewsModel, ListViewsOrchestrator, ListViewsSetActiveAction, SkyListComponent, SkyListFilterInlineModel, SkyListFiltersModule, SkyListInMemoryDataProvider, SkyListModule, SkyListPagingModule, SkyListSecondaryActionsComponent, SkyListSecondaryActionsModule, SkyListToolbarComponent, SkyListToolbarModule, SkyListFilterButtonComponent as λ1, SkyListToolbarViewActionsComponent as λ10, SkyListToolbarSearchActionsComponent as λ11, SkyListFilterSummaryComponent as λ2, SkyListFilterInlineItemComponent as λ3, SkyListFilterInlineComponent as λ4, SkyListPagingComponent as λ5, SkyListSecondaryActionComponent as λ6, SkyListToolbarItemComponent as λ8, SkyListToolbarSortComponent as λ9 };
|
|
1348
|
+
export type { ListStateAction, SkyListSecondaryAction };
|