@progress/kendo-angular-listview 24.2.2-develop.9 → 25.0.0-develop.1
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/progress-kendo-angular-listview.mjs +54 -54
- package/index.d.ts +1036 -27
- package/package-metadata.mjs +2 -2
- package/package.json +13 -13
- package/schematics/ngAdd/index.js +6 -6
- package/data-binding/data-binding.directive.d.ts +0 -47
- package/directives.d.ts +0 -21
- package/editing/commands/add-command.directive.d.ts +0 -36
- package/editing/commands/cancel-command.directive.d.ts +0 -48
- package/editing/commands/edit-command.directive.d.ts +0 -37
- package/editing/commands/remove-command.directive.d.ts +0 -37
- package/editing/commands/save-command.directive.d.ts +0 -48
- package/editing/edit-template.directive.d.ts +0 -42
- package/editing/edit.service.d.ts +0 -60
- package/editing/events/add-event-args.interface.d.ts +0 -11
- package/editing/events/cancel-event-args.interface.d.ts +0 -10
- package/editing/events/edit-event-args.interface.d.ts +0 -27
- package/editing/events/remove-event-args.interface.d.ts +0 -11
- package/editing/events/save-event-args.interface.d.ts +0 -16
- package/listview.component.d.ts +0 -354
- package/listview.module.d.ts +0 -43
- package/models/listview-data-result.d.ts +0 -18
- package/models/page-change-event.d.ts +0 -11
- package/models/page-size-change-event.d.ts +0 -11
- package/models/page-size-item.d.ts +0 -12
- package/models/pager-position.d.ts +0 -12
- package/models/pager-settings.d.ts +0 -39
- package/models/pager-type.d.ts +0 -12
- package/models/scroll-bottom-event.d.ts +0 -14
- package/navigation/listview-navigable-item.directive.d.ts +0 -29
- package/navigation/navigation.service.d.ts +0 -55
- package/package-metadata.d.ts +0 -9
- package/templates/footer-template.directive.d.ts +0 -33
- package/templates/header-template.directive.d.ts +0 -34
- package/templates/item-template.directive.d.ts +0 -40
- package/templates/loader-template.directive.d.ts +0 -34
- package/templates/no-data-template.directive.d.ts +0 -27
- package/utils.d.ts +0 -55
package/index.d.ts
CHANGED
|
@@ -2,30 +2,1039 @@
|
|
|
2
2
|
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
3
3
|
* Licensed under commercial license. See LICENSE.md in the project root for more information
|
|
4
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
|
-
|
|
5
|
+
import * as i0 from '@angular/core';
|
|
6
|
+
import { OnChanges, ElementRef, Renderer2, TemplateRef, NgZone, EventEmitter, AfterViewInit, OnDestroy, QueryList, ChangeDetectorRef, SimpleChanges } from '@angular/core';
|
|
7
|
+
import { Subject, Observable } from 'rxjs';
|
|
8
|
+
import { PageChangeEvent as PageChangeEvent$1, PageSizeChangeEvent as PageSizeChangeEvent$1, PagerType as PagerType$1, PageSizeItem as PageSizeItem$1 } from '@progress/kendo-angular-pager';
|
|
9
|
+
import { FormGroup } from '@angular/forms';
|
|
10
|
+
import { Button } from '@progress/kendo-angular-buttons';
|
|
11
|
+
import { LocalizationService } from '@progress/kendo-angular-l10n';
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* @hidden
|
|
15
|
+
*
|
|
16
|
+
* Provided per ListView instance. Keeps the availability, active index and focused state of the current ListView.
|
|
17
|
+
* Emits `changes` when any of the aforementioned states changes.
|
|
18
|
+
*/
|
|
19
|
+
declare class NavigationService {
|
|
20
|
+
/**
|
|
21
|
+
* Emits every time a change in active index/focus/blur/navigation availability occurs.
|
|
22
|
+
*/
|
|
23
|
+
changes: Subject<any>;
|
|
24
|
+
/**
|
|
25
|
+
* Sets or gets if the navigation is enabled.
|
|
26
|
+
* When no activeIndex is present, the navigation is inferred as disabled.
|
|
27
|
+
* Toggling the service availability clears the current active index or activates the first one.
|
|
28
|
+
*/
|
|
29
|
+
get isEnabled(): boolean;
|
|
30
|
+
set isEnabled(enabled: boolean);
|
|
31
|
+
/**
|
|
32
|
+
* Specifies if a ListView item currently holds focus.
|
|
33
|
+
*/
|
|
34
|
+
isFocused: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* Keeps track of the index of the items that should be the current focus target (tabindex="0").
|
|
37
|
+
* When set to `null`/`undefined`, the navigation is disabled and the items should not render a tabindex.
|
|
38
|
+
*/
|
|
39
|
+
activeIndex: number;
|
|
40
|
+
/**
|
|
41
|
+
* Shows if the checked index should be the current available focus target (tabindex="0").
|
|
42
|
+
*/
|
|
43
|
+
isActive(index: number): boolean;
|
|
44
|
+
handleKeyDown(event: KeyboardEvent, totalItemsCount: number): void;
|
|
45
|
+
handleFocusIn(event: FocusEvent): void;
|
|
46
|
+
handleFocusOut(event: FocusEvent): void;
|
|
47
|
+
/**
|
|
48
|
+
* Sets the `activeIndex` and triggers changes without focusing the corresponding ListView item.
|
|
49
|
+
*/
|
|
50
|
+
setActiveIndex(index: number): void;
|
|
51
|
+
/**
|
|
52
|
+
* Focuses item at the targeted index. If no index is passed, the current `activeIndex` is used.
|
|
53
|
+
* The passed target index is normalized to fit the min/max available indices bounds.
|
|
54
|
+
*/
|
|
55
|
+
focusIndex(index: any, totalItemsCount: number): void;
|
|
56
|
+
private navigateTo;
|
|
57
|
+
private navigateToPrevious;
|
|
58
|
+
private navigateToNext;
|
|
59
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<NavigationService, never>;
|
|
60
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<NavigationService>;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* @hidden
|
|
65
|
+
*/
|
|
66
|
+
declare class ListViewNavigableItemDirective implements OnChanges {
|
|
67
|
+
private hostElement;
|
|
68
|
+
private renderer;
|
|
69
|
+
private navigationService;
|
|
70
|
+
/**
|
|
71
|
+
* The current item index. Used to track which navigation changes apply to this item.
|
|
72
|
+
*/
|
|
73
|
+
index: number;
|
|
74
|
+
private navigationSubscription;
|
|
75
|
+
constructor(hostElement: ElementRef<HTMLElement>, renderer: Renderer2, navigationService: NavigationService);
|
|
76
|
+
ngOnChanges(): void;
|
|
77
|
+
ngOnInit(): void;
|
|
78
|
+
ngOnDestroy(): void;
|
|
79
|
+
private updateNavigationState;
|
|
80
|
+
private updateFocusedState;
|
|
81
|
+
private updateTabIndex;
|
|
82
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ListViewNavigableItemDirective, never>;
|
|
83
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ListViewNavigableItemDirective, "[kendoListViewNavigableItem]", never, { "index": { "alias": "index"; "required": false; }; }, {}, never, never, true, never>;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Allows customizing the list item content. To define an item template, nest an `<ng-template>` tag
|
|
88
|
+
* with the `kendoListViewItemTemplate` directive inside the `<kendo-listview>` tag
|
|
89
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/templates#item-template)).
|
|
90
|
+
*
|
|
91
|
+
* The following values are available as context variables:
|
|
92
|
+
* - `let-dataItem="dataItem"` (`any`)&mdashThe current data item. Also available as implicit context variable.
|
|
93
|
+
* - `let-index="index"` (`number`)&mdashThe current item index.
|
|
94
|
+
* - `let-isFirst="isFirst"` (`boolean`)&mdashIndicates whether the current data item renders as the first item on the list.
|
|
95
|
+
* - `let-isLast="isLast"` (`boolean`)&mdashIndicates whether the current data item renders as the last item on the list.
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```typescript
|
|
99
|
+
* @Component({
|
|
100
|
+
* template: `
|
|
101
|
+
* <kendo-listview [data]="items">
|
|
102
|
+
* <ng-template kendoListViewItemTemplate let-dataItem let-index="index">
|
|
103
|
+
* <div class="item-wrapper">
|
|
104
|
+
* <h4>{{ dataItem.name }}</h4>
|
|
105
|
+
* <p>Item #{{ index + 1 }}: {{ dataItem.description }}</p>
|
|
106
|
+
* </div>
|
|
107
|
+
* </ng-template>
|
|
108
|
+
* </kendo-listview>
|
|
109
|
+
* `
|
|
110
|
+
* })
|
|
111
|
+
* export class AppComponent { }
|
|
112
|
+
* ```
|
|
113
|
+
*/
|
|
114
|
+
declare class ItemTemplateDirective {
|
|
115
|
+
templateRef: TemplateRef<any>;
|
|
116
|
+
constructor(templateRef: TemplateRef<any>);
|
|
117
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ItemTemplateDirective, never>;
|
|
118
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ItemTemplateDirective, "[kendoListViewItemTemplate]", never, {}, {}, never, never, true, never>;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Allows customizing the header content of the ListView. To define a header template, nest an `<ng-template>` tag
|
|
123
|
+
* with the `kendoListViewHeaderTemplate` directive inside the `<kendo-listview>` tag
|
|
124
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/templates#header-template)).
|
|
125
|
+
*
|
|
126
|
+
* @example
|
|
127
|
+
* ```typescript
|
|
128
|
+
* @Component({
|
|
129
|
+
* template: `
|
|
130
|
+
* <kendo-listview [data]="items">
|
|
131
|
+
* <ng-template kendoListViewHeaderTemplate>
|
|
132
|
+
* <div class="header-content">
|
|
133
|
+
* <h3>Product List</h3>
|
|
134
|
+
* <button kendoListViewAddCommand>Add New Item</button>
|
|
135
|
+
* </div>
|
|
136
|
+
* </ng-template>
|
|
137
|
+
* </kendo-listview>
|
|
138
|
+
* `
|
|
139
|
+
* })
|
|
140
|
+
* export class AppComponent { }
|
|
141
|
+
* ```
|
|
142
|
+
*/
|
|
143
|
+
declare class HeaderTemplateDirective {
|
|
144
|
+
templateRef: TemplateRef<any>;
|
|
145
|
+
constructor(templateRef: TemplateRef<any>);
|
|
146
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<HeaderTemplateDirective, never>;
|
|
147
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<HeaderTemplateDirective, "[kendoListViewHeaderTemplate]", never, {}, {}, never, never, true, never>;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Allows customizing the footer content of the ListView. To define a footer template, nest an `<ng-template>` tag
|
|
152
|
+
* with the `kendoListViewFooterTemplate` directive inside the `<kendo-listview>` tag
|
|
153
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/templates#footer-template)).
|
|
154
|
+
*
|
|
155
|
+
* @example
|
|
156
|
+
* ```typescript
|
|
157
|
+
* @Component({
|
|
158
|
+
* template: `
|
|
159
|
+
* <kendo-listview [data]="items">
|
|
160
|
+
* <ng-template kendoListViewFooterTemplate>
|
|
161
|
+
* <div class="footer-content">
|
|
162
|
+
* <p>Total items: {{ items.length }}</p>
|
|
163
|
+
* </div>
|
|
164
|
+
* </ng-template>
|
|
165
|
+
* </kendo-listview>
|
|
166
|
+
* `
|
|
167
|
+
* })
|
|
168
|
+
* export class AppComponent { }
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
declare class FooterTemplateDirective {
|
|
172
|
+
templateRef: TemplateRef<any>;
|
|
173
|
+
constructor(templateRef: TemplateRef<any>);
|
|
174
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<FooterTemplateDirective, never>;
|
|
175
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<FooterTemplateDirective, "[kendoListViewFooterTemplate]", never, {}, {}, never, never, true, never>;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Overrides the default loader content of the ListView. To define a loader template, nest an `<ng-template>` tag
|
|
180
|
+
* with the `kendoListViewLoaderTemplate` directive inside the `<kendo-listview>` tag
|
|
181
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/templates#loader-template)).
|
|
182
|
+
*
|
|
183
|
+
* @example
|
|
184
|
+
* ```typescript
|
|
185
|
+
* @Component({
|
|
186
|
+
* template: `
|
|
187
|
+
* <kendo-listview [data]="items" [loading]="isLoading">
|
|
188
|
+
* <ng-template kendoListViewLoaderTemplate>
|
|
189
|
+
* <div class="custom-loader">
|
|
190
|
+
* <kendo-loader></kendo-loader>
|
|
191
|
+
* <p>Loading data, please wait...</p>
|
|
192
|
+
* </div>
|
|
193
|
+
* </ng-template>
|
|
194
|
+
* </kendo-listview>
|
|
195
|
+
* `
|
|
196
|
+
* })
|
|
197
|
+
* export class AppComponent { }
|
|
198
|
+
* ```
|
|
199
|
+
*/
|
|
200
|
+
declare class LoaderTemplateDirective {
|
|
201
|
+
templateRef: TemplateRef<any>;
|
|
202
|
+
constructor(templateRef: TemplateRef<any>);
|
|
203
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LoaderTemplateDirective, never>;
|
|
204
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<LoaderTemplateDirective, "[kendoListViewLoaderTemplate]", never, {}, {}, never, never, true, never>;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Lets you customize the content shown when the ListView has no data to display.
|
|
209
|
+
* To define a no-data template, nest an `<ng-template>` tag
|
|
210
|
+
* with the `kendoListViewNoDataTemplate` directive inside the `<kendo-listview>` tag
|
|
211
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/templates#no-data-template)).
|
|
212
|
+
*
|
|
213
|
+
* @example
|
|
214
|
+
* ```html
|
|
215
|
+
* <kendo-listview [data]="[]">
|
|
216
|
+
* <ng-template kendoListViewNoDataTemplate>
|
|
217
|
+
* No items to display.
|
|
218
|
+
* </ng-template>
|
|
219
|
+
* </kendo-listview>
|
|
220
|
+
* ```
|
|
221
|
+
*/
|
|
222
|
+
declare class NoDataTemplateDirective {
|
|
223
|
+
templateRef: TemplateRef<any>;
|
|
224
|
+
constructor(templateRef: TemplateRef<any>);
|
|
225
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<NoDataTemplateDirective, never>;
|
|
226
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<NoDataTemplateDirective, "[kendoListViewNoDataTemplate]", never, {}, {}, never, never, true, never>;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Defines the arguments of the [`scrollBottom`](https://www.telerik.com/kendo-angular-ui/components/listview/api/listviewcomponent#scrollbottom) event of the ListView.
|
|
231
|
+
*/
|
|
232
|
+
interface ScrollBottomEvent {
|
|
233
|
+
/**
|
|
234
|
+
* Specifies the instance of the `ListViewComponent`.
|
|
235
|
+
*/
|
|
236
|
+
sender: ListViewComponent;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Defines the arguments of the [`pageChange`](https://www.telerik.com/kendo-angular-ui/components/listview/api/listviewcomponent#pagechange) event of the ListView
|
|
241
|
+
* ([more details](https://www.telerik.com/kendo-angular-ui/components/listview/paging)).
|
|
242
|
+
*
|
|
243
|
+
*/
|
|
244
|
+
type PageChangeEvent = PageChangeEvent$1;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Defines the arguments of the [`pageSizeChange`](https://www.telerik.com/kendo-angular-ui/components/listview/api/listviewcomponent#pagesizechange) event of the ListView
|
|
248
|
+
* ([more details](https://www.telerik.com/kendo-angular-ui/components/listview/paging)).
|
|
249
|
+
*/
|
|
250
|
+
declare class PageSizeChangeEvent extends PageSizeChangeEvent$1 {
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* Defines the type that the pager [`type`](https://www.telerik.com/kendo-angular-ui/components/listview/api/pagersettings#type) property accepts.
|
|
255
|
+
* Specifies whether the pager renders a set of buttons for page control or a single HTML `input` element
|
|
256
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/paging#pager-options)).
|
|
257
|
+
*
|
|
258
|
+
*/
|
|
259
|
+
declare type PagerType = Partial<PagerType$1>;
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* Defines the type that the pager [`pageSizeValues`](https://www.telerik.com/kendo-angular-ui/components/listview/api/pagersettings#pagesizevalues) property accepts.
|
|
263
|
+
* Specifies the text and value of each page size item
|
|
264
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/paging#pager-options)).
|
|
265
|
+
*/
|
|
266
|
+
interface PageSizeItem extends PageSizeItem$1 {
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* Defines the type that the pager [`position`](https://www.telerik.com/kendo-angular-ui/components/listview/api/pagersettings#position) property accepts.
|
|
271
|
+
* Specifies whether the pager appears above the content container, beneath it, or in both places
|
|
272
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/paging#pager-options)).
|
|
273
|
+
*
|
|
274
|
+
* @default 'bottom'
|
|
275
|
+
*/
|
|
276
|
+
type PagerPosition = 'bottom' | 'top' | 'both';
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* Defines the pager settings of the ListView
|
|
280
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/paging#pager-options)).
|
|
281
|
+
*/
|
|
282
|
+
interface PagerSettings {
|
|
283
|
+
/**
|
|
284
|
+
* Specifies the position of the pager.
|
|
285
|
+
*/
|
|
286
|
+
position?: PagerPosition;
|
|
287
|
+
/**
|
|
288
|
+
* Specifies the maximum count of numeric buttons before the buttons collapse.
|
|
289
|
+
*/
|
|
290
|
+
buttonCount?: number;
|
|
291
|
+
/**
|
|
292
|
+
* Toggles the information about the current page and the total number of records.
|
|
293
|
+
*/
|
|
294
|
+
info?: boolean;
|
|
295
|
+
/**
|
|
296
|
+
* Toggles the Previous and Next buttons.
|
|
297
|
+
*/
|
|
298
|
+
previousNext?: boolean;
|
|
299
|
+
/**
|
|
300
|
+
* Specifies the type of the pager.
|
|
301
|
+
*/
|
|
302
|
+
type?: PagerType;
|
|
303
|
+
/**
|
|
304
|
+
* Shows a dropdown for selecting the page size. When you set this to `true`, the dropdown contains the default list of options: 5, 10, 20.
|
|
305
|
+
* To customize the list of options, set `pageSizeValues` to an array of the desired values.
|
|
306
|
+
* The array can contain numbers and `PageSizeItem` objects.
|
|
307
|
+
*/
|
|
308
|
+
pageSizeValues?: boolean | number[] | PageSizeItem[];
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Defines the data type that the ListView expects
|
|
313
|
+
* ([see data binding examples](https://www.telerik.com/kendo-angular-ui/components/listview/paging)).
|
|
314
|
+
*/
|
|
315
|
+
interface ListViewDataResult {
|
|
316
|
+
/**
|
|
317
|
+
* Specifies the data that the ListView renders.
|
|
318
|
+
*/
|
|
319
|
+
data: any[];
|
|
320
|
+
/**
|
|
321
|
+
* Specifies the total number of available records.
|
|
322
|
+
*/
|
|
323
|
+
total: number;
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Defines the edit template of the ListView ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms)).
|
|
328
|
+
* Helps you customize the content of the edited items. To define the template, nest an `<ng-template>`
|
|
329
|
+
* tag with the `kendoListViewEditTemplate` directive inside a `<kendo-listview>` tag.
|
|
330
|
+
*
|
|
331
|
+
* The template context contains the following fields:
|
|
332
|
+
* - `formGroup`—The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']). When you use the ListView inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
|
|
333
|
+
* - `itemIndex`—The current item index. When inside a new item, `itemIndex` is `-1`.
|
|
334
|
+
* - `dataItem`—The current data item.
|
|
335
|
+
* - `isNew`—The state of the current item.
|
|
336
|
+
*
|
|
337
|
+
*
|
|
338
|
+
* @example
|
|
339
|
+
* ```typescript
|
|
340
|
+
* @Component({
|
|
341
|
+
* template: `
|
|
342
|
+
* <kendo-listview [data]="items">
|
|
343
|
+
* <ng-template kendoListViewEditTemplate let-dataItem let-formGroup="formGroup">
|
|
344
|
+
* <div class="edit-form">
|
|
345
|
+
* <input [(ngModel)]="dataItem.name" [formControl]="formGroup.get('name')" />
|
|
346
|
+
* <button kendoListViewSaveCommand>Save</button>
|
|
347
|
+
* <button kendoListViewCancelCommand>Cancel</button>
|
|
348
|
+
* </div>
|
|
349
|
+
* </ng-template>
|
|
350
|
+
* </kendo-listview>
|
|
351
|
+
* `
|
|
352
|
+
* })
|
|
353
|
+
* export class AppComponent { }
|
|
354
|
+
* ```
|
|
355
|
+
*/
|
|
356
|
+
declare class EditTemplateDirective {
|
|
357
|
+
templateRef: TemplateRef<any>;
|
|
358
|
+
constructor(templateRef: TemplateRef<any>);
|
|
359
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EditTemplateDirective, [{ optional: true; }]>;
|
|
360
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<EditTemplateDirective, "[kendoListViewEditTemplate]", never, {}, {}, never, never, true, never>;
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
/**
|
|
364
|
+
* @hidden
|
|
365
|
+
*/
|
|
366
|
+
type Entity = {
|
|
367
|
+
index: number;
|
|
368
|
+
group: any;
|
|
369
|
+
};
|
|
370
|
+
/**
|
|
371
|
+
* @hidden
|
|
372
|
+
*/
|
|
373
|
+
type CommandAction = 'edit' | 'remove' | 'cancel' | 'save' | 'add';
|
|
374
|
+
/**
|
|
375
|
+
* @hidden
|
|
376
|
+
*/
|
|
377
|
+
type CommandEvent = {
|
|
378
|
+
action: CommandAction;
|
|
379
|
+
formGroup?: FormGroup;
|
|
380
|
+
isNew?: boolean;
|
|
381
|
+
itemIndex?: number;
|
|
382
|
+
};
|
|
383
|
+
/**
|
|
384
|
+
* @hidden
|
|
385
|
+
*/
|
|
386
|
+
declare class EditService {
|
|
387
|
+
ngZone: NgZone;
|
|
388
|
+
changes: EventEmitter<CommandEvent>;
|
|
389
|
+
changed: Observable<any>;
|
|
390
|
+
private editedIndices;
|
|
391
|
+
private newItem;
|
|
392
|
+
private changedSource;
|
|
393
|
+
constructor(ngZone: NgZone);
|
|
394
|
+
editItem(index: number, group?: any): void;
|
|
395
|
+
addItem(group: any): void;
|
|
396
|
+
isEditing(): boolean;
|
|
397
|
+
get hasNewItem(): boolean;
|
|
398
|
+
get newDataItem(): any;
|
|
399
|
+
get newItemGroup(): FormGroup;
|
|
400
|
+
editGroup(index: number): any;
|
|
401
|
+
close(index?: number): void;
|
|
402
|
+
context(index?: number): Entity;
|
|
403
|
+
isEdited(index: number): boolean;
|
|
404
|
+
hasEdited(index: number): boolean;
|
|
405
|
+
beginEdit(itemIndex: number): void;
|
|
406
|
+
beginAdd(): void;
|
|
407
|
+
endEdit(itemIndex?: number): void;
|
|
408
|
+
save(itemIndex?: number): void;
|
|
409
|
+
remove(itemIndex: number): void;
|
|
410
|
+
private findByIndex;
|
|
411
|
+
private onChanged;
|
|
412
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EditService, never>;
|
|
413
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<EditService>;
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
* Defines the arguments for the `edit` event.
|
|
418
|
+
*
|
|
419
|
+
*/
|
|
420
|
+
interface EditEvent {
|
|
421
|
+
/**
|
|
422
|
+
* Specifies the data item.
|
|
423
|
+
*/
|
|
424
|
+
dataItem: any;
|
|
425
|
+
/**
|
|
426
|
+
* Indicates whether the data item is new or existing.
|
|
427
|
+
*/
|
|
428
|
+
isNew: boolean;
|
|
429
|
+
/**
|
|
430
|
+
* Specifies the item index for the operation.
|
|
431
|
+
*/
|
|
432
|
+
itemIndex: number;
|
|
433
|
+
/**
|
|
434
|
+
* Specifies the `ListViewComponent` instance.
|
|
435
|
+
*/
|
|
436
|
+
sender: ListViewComponent;
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
* Defines the arguments for the `remove` event.
|
|
441
|
+
*
|
|
442
|
+
*/
|
|
443
|
+
interface RemoveEvent extends EditEvent {
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* Defines the arguments for the `save` event.
|
|
448
|
+
*
|
|
449
|
+
*/
|
|
450
|
+
interface SaveEvent extends EditEvent {
|
|
451
|
+
/**
|
|
452
|
+
* Specifies the edited `FormGroup` instance.
|
|
453
|
+
*/
|
|
454
|
+
formGroup: FormGroup;
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* Defines the arguments for the `cancel` event.
|
|
459
|
+
*
|
|
460
|
+
*/
|
|
461
|
+
type CancelEvent = SaveEvent;
|
|
462
|
+
|
|
463
|
+
/**
|
|
464
|
+
* Defines the arguments for the `add` event.
|
|
465
|
+
*
|
|
466
|
+
*/
|
|
467
|
+
interface AddEvent extends EditEvent {
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
/**
|
|
471
|
+
* Represents the Kendo UI ListView component for Angular.
|
|
472
|
+
* Displays a list of data items and supports paging, editing, and custom templates
|
|
473
|
+
* ([see overview](https://www.telerik.com/kendo-angular-ui/components/listview)).
|
|
474
|
+
*
|
|
475
|
+
* @example
|
|
476
|
+
* ```typescript
|
|
477
|
+
* @Component({
|
|
478
|
+
* selector: 'my-app',
|
|
479
|
+
* template: `
|
|
480
|
+
* <kendo-listview
|
|
481
|
+
* [data]="items"
|
|
482
|
+
* [pageable]="true"
|
|
483
|
+
* [pageSize]="5">
|
|
484
|
+
* <ng-template kendoListViewItemTemplate let-dataItem>
|
|
485
|
+
* <div class="item">
|
|
486
|
+
* <h3>{{ dataItem.name }}</h3>
|
|
487
|
+
* <p>{{ dataItem.description }}</p>
|
|
488
|
+
* </div>
|
|
489
|
+
* </ng-template>
|
|
490
|
+
* </kendo-listview>
|
|
491
|
+
* `
|
|
492
|
+
* })
|
|
493
|
+
* export class AppComponent {
|
|
494
|
+
* items = [
|
|
495
|
+
* { name: 'Item 1', description: 'First item' },
|
|
496
|
+
* { name: 'Item 2', description: 'Second item' }
|
|
497
|
+
* ];
|
|
498
|
+
* }
|
|
499
|
+
* ```
|
|
500
|
+
*/
|
|
501
|
+
declare class ListViewComponent implements AfterViewInit, OnChanges, OnDestroy {
|
|
502
|
+
ngZone: NgZone;
|
|
503
|
+
element: ElementRef;
|
|
504
|
+
renderer: Renderer2;
|
|
505
|
+
private changeDetectorRef;
|
|
506
|
+
editService: EditService;
|
|
507
|
+
private navigationService;
|
|
508
|
+
/**
|
|
509
|
+
* @hidden
|
|
510
|
+
*/
|
|
511
|
+
className: boolean;
|
|
512
|
+
/**
|
|
513
|
+
* @hidden
|
|
514
|
+
*/
|
|
515
|
+
itemTemplate: ItemTemplateDirective;
|
|
516
|
+
/**
|
|
517
|
+
* @hidden
|
|
518
|
+
*/
|
|
519
|
+
headerTemplate: HeaderTemplateDirective;
|
|
520
|
+
/**
|
|
521
|
+
* @hidden
|
|
522
|
+
*/
|
|
523
|
+
footerTemplate: FooterTemplateDirective;
|
|
524
|
+
/**
|
|
525
|
+
* @hidden
|
|
526
|
+
*/
|
|
527
|
+
loaderTemplate: LoaderTemplateDirective;
|
|
528
|
+
/**
|
|
529
|
+
* @hidden
|
|
530
|
+
*/
|
|
531
|
+
contentContainer: ElementRef<HTMLElement>;
|
|
532
|
+
/**
|
|
533
|
+
* @hidden
|
|
534
|
+
*/
|
|
535
|
+
noDataTemplate: NoDataTemplateDirective;
|
|
536
|
+
/**
|
|
537
|
+
* @hidden
|
|
538
|
+
*/
|
|
539
|
+
editTemplate: EditTemplateDirective;
|
|
540
|
+
/**
|
|
541
|
+
* @hidden
|
|
542
|
+
*/
|
|
543
|
+
listViewItems: QueryList<ListViewNavigableItemDirective>;
|
|
544
|
+
/**
|
|
545
|
+
* Specifies if a border should be rendered around the listview element.
|
|
546
|
+
*
|
|
547
|
+
* @default false
|
|
548
|
+
*/
|
|
549
|
+
bordered: boolean;
|
|
550
|
+
/**
|
|
551
|
+
* Specifies the data collection that populates the ListView
|
|
552
|
+
* ([see data binding examples](https://www.telerik.com/kendo-angular-ui/components/listview/paging)).
|
|
553
|
+
*/
|
|
554
|
+
set data(value: any[] | ListViewDataResult | undefined);
|
|
555
|
+
get data(): any[] | ListViewDataResult | undefined;
|
|
556
|
+
/**
|
|
557
|
+
* Specifies whether the loading indicator of the ListView displays
|
|
558
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/paging#remote-binding)).
|
|
559
|
+
*
|
|
560
|
+
* @default false
|
|
561
|
+
*/
|
|
562
|
+
loading: boolean;
|
|
563
|
+
/**
|
|
564
|
+
* Specifies the CSS styles that render on the content container element of the ListView.
|
|
565
|
+
* Supports the type of values that [`ngStyle`](link:site.data.urls.angular['ngstyleapi']) supports.
|
|
566
|
+
*/
|
|
567
|
+
containerStyle?: {
|
|
568
|
+
[key: string]: string;
|
|
569
|
+
};
|
|
570
|
+
/**
|
|
571
|
+
* Specifies the CSS styles that render on each item element wrapper of the ListView.
|
|
572
|
+
* Supports the type of values that [`ngStyle`](link:site.data.urls.angular['ngstyleapi']) supports.
|
|
573
|
+
*/
|
|
574
|
+
itemStyle?: {
|
|
575
|
+
[key: string]: string;
|
|
576
|
+
};
|
|
577
|
+
/**
|
|
578
|
+
* Specifies the CSS class that renders on the content container element of the ListView.
|
|
579
|
+
* Supports the type of values that [`ngClass`](link:site.data.urls.angular['ngclassapi']) supports.
|
|
580
|
+
*/
|
|
581
|
+
containerClass?: string | string[] | Set<string> | {
|
|
582
|
+
[key: string]: boolean;
|
|
583
|
+
};
|
|
584
|
+
/**
|
|
585
|
+
* Specifies the CSS class that renders on each item element wrapper of the ListView.
|
|
586
|
+
* Supports the type of values that [`ngClass`](link:site.data.urls.angular['ngclassapi']) supports.
|
|
587
|
+
*/
|
|
588
|
+
itemClass?: string | string[] | Set<string> | {
|
|
589
|
+
[key: string]: boolean;
|
|
590
|
+
};
|
|
591
|
+
/**
|
|
592
|
+
* Specifies the content container `aria-label` attribute
|
|
593
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/accessibility#accessible-names)).
|
|
594
|
+
*
|
|
595
|
+
* @remarks
|
|
596
|
+
* This property is related to accessibility.
|
|
597
|
+
*/
|
|
598
|
+
containerLabel?: string;
|
|
599
|
+
/**
|
|
600
|
+
* Specifies the content container `role` attribute
|
|
601
|
+
* ([more details](https://www.telerik.com/kendo-angular-ui/components/listview/accessibility#wai-aria-support)).
|
|
602
|
+
*
|
|
603
|
+
* @default 'list'
|
|
604
|
+
*
|
|
605
|
+
* @remarks
|
|
606
|
+
* This property is related to accessibility.
|
|
607
|
+
*/
|
|
608
|
+
containerRole: string;
|
|
609
|
+
/**
|
|
610
|
+
* Specifies the list item `role` attribute
|
|
611
|
+
* ([more details](https://www.telerik.com/kendo-angular-ui/components/listview/accessibility#wai-aria-support)).
|
|
612
|
+
*
|
|
613
|
+
* @default 'listitem'
|
|
614
|
+
*
|
|
615
|
+
* @remarks
|
|
616
|
+
* This property is related to accessibility.
|
|
617
|
+
*/
|
|
618
|
+
listItemRole: string;
|
|
619
|
+
/**
|
|
620
|
+
* Specifies whether keyboard navigation is enabled
|
|
621
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/keyboard-navigation)).
|
|
622
|
+
*
|
|
623
|
+
* @default true
|
|
624
|
+
*
|
|
625
|
+
* @remarks
|
|
626
|
+
* This property is related to accessibility.
|
|
627
|
+
*/
|
|
628
|
+
set navigable(navigable: boolean);
|
|
629
|
+
get navigable(): boolean;
|
|
630
|
+
/**
|
|
631
|
+
* Specifies the page size used by the ListView pager
|
|
632
|
+
* ([more details](https://www.telerik.com/kendo-angular-ui/components/listview/paging)).
|
|
633
|
+
*/
|
|
634
|
+
pageSize?: number;
|
|
635
|
+
/**
|
|
636
|
+
* Defines the number of records to be skipped by the pager
|
|
637
|
+
* ([more details](https://www.telerik.com/kendo-angular-ui/components/listview/paging)).
|
|
638
|
+
*/
|
|
639
|
+
set skip(skip: number);
|
|
640
|
+
get skip(): number;
|
|
641
|
+
/**
|
|
642
|
+
* Configures whether the ListView renders a pager
|
|
643
|
+
* ([more details](https://www.telerik.com/kendo-angular-ui/components/listview/paging)).
|
|
644
|
+
* When you provide a boolean value, it renders a pager with the default settings.
|
|
645
|
+
*/
|
|
646
|
+
set pageable(pageable: boolean | PagerSettings);
|
|
647
|
+
get pageable(): boolean | PagerSettings;
|
|
648
|
+
/**
|
|
649
|
+
* Specifies the height (in pixels) of the ListView component.
|
|
650
|
+
* When the content height exceeds the component height, a vertical scrollbar renders.
|
|
651
|
+
*
|
|
652
|
+
* To set the height of the ListView, you can also use `style.height`. The `style.height`
|
|
653
|
+
* option supports units such as `px`, `%`, `em`, `rem`, and others.
|
|
654
|
+
*/
|
|
655
|
+
height?: number;
|
|
656
|
+
/**
|
|
657
|
+
* Fires when you scroll to the last record on the page
|
|
658
|
+
* ([see endless scrolling example](https://www.telerik.com/kendo-angular-ui/components/listview/scroll-modes#endless-scrolling)).
|
|
659
|
+
*/
|
|
660
|
+
scrollBottom: EventEmitter<ScrollBottomEvent>;
|
|
661
|
+
/**
|
|
662
|
+
* Fires when you change the page or the page size of the ListView
|
|
663
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/paging#remote-binding)).
|
|
664
|
+
* You have to handle the event yourself and page the data.
|
|
665
|
+
*/
|
|
666
|
+
pageChange: EventEmitter<PageChangeEvent>;
|
|
667
|
+
/**
|
|
668
|
+
* Fires when you change the page size of the ListView. You can prevent this event (`$event.preventDefault()`).
|
|
669
|
+
* When not prevented, the `pageChange` event fires subsequently.
|
|
670
|
+
*/
|
|
671
|
+
pageSizeChange: EventEmitter<PageSizeChangeEvent>;
|
|
672
|
+
/**
|
|
673
|
+
* Fires when you click the **Edit** command button to edit an item
|
|
674
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms#editing-records)).
|
|
675
|
+
*/
|
|
676
|
+
edit: EventEmitter<EditEvent>;
|
|
677
|
+
/**
|
|
678
|
+
* Fires when you click the **Cancel** command button to close an item
|
|
679
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms#cancelling-editing)).
|
|
680
|
+
*/
|
|
681
|
+
cancel: EventEmitter<CancelEvent>;
|
|
682
|
+
/**
|
|
683
|
+
* Fires when you click the **Save** command button to save changes in an item
|
|
684
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms#saving-records)).
|
|
685
|
+
*/
|
|
686
|
+
save: EventEmitter<SaveEvent>;
|
|
687
|
+
/**
|
|
688
|
+
* Fires when you click the **Remove** command button to remove an item
|
|
689
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms#removing-records)).
|
|
690
|
+
*/
|
|
691
|
+
remove: EventEmitter<RemoveEvent>;
|
|
692
|
+
/**
|
|
693
|
+
* Fires when you click the **Add** command button to add a new item
|
|
694
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms#adding-records)).
|
|
695
|
+
*/
|
|
696
|
+
add: EventEmitter<AddEvent>;
|
|
697
|
+
/**
|
|
698
|
+
* @hidden
|
|
699
|
+
*/
|
|
700
|
+
pagerSettings: PagerSettings;
|
|
701
|
+
/**
|
|
702
|
+
* @hidden
|
|
703
|
+
*
|
|
704
|
+
* Gets the data items passed to the ListView.
|
|
705
|
+
* If a `ListViewDataResult` is passed, the data value is used. If an array is passed - it's directly used.
|
|
706
|
+
*/
|
|
707
|
+
get items(): any[];
|
|
708
|
+
/**
|
|
709
|
+
* @hidden
|
|
710
|
+
*
|
|
711
|
+
* Gets the total number of records passed to the ListView.
|
|
712
|
+
* If a `ListViewDataResult` is passed, the total value is used. If an array is passed - its length is used.
|
|
713
|
+
*/
|
|
714
|
+
get total(): number;
|
|
715
|
+
/**
|
|
716
|
+
* @hidden
|
|
717
|
+
*/
|
|
718
|
+
get containerTabindex(): number;
|
|
719
|
+
/**
|
|
720
|
+
* Gets the current active item index
|
|
721
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/keyboard-navigation#controlling-the-focus)).
|
|
722
|
+
* Returns `null` when keyboard navigation is disabled.
|
|
723
|
+
*/
|
|
724
|
+
get activeIndex(): number;
|
|
725
|
+
private removeNavigationListeners;
|
|
726
|
+
private _skip;
|
|
727
|
+
private _navigable;
|
|
728
|
+
private _pageable;
|
|
729
|
+
private lastScrollTop;
|
|
730
|
+
private _data;
|
|
731
|
+
private editServiceSubscription;
|
|
732
|
+
constructor(ngZone: NgZone, element: ElementRef, renderer: Renderer2, changeDetectorRef: ChangeDetectorRef, editService: EditService, navigationService: NavigationService);
|
|
733
|
+
ngAfterViewInit(): void;
|
|
734
|
+
ngOnChanges(changes: SimpleChanges): void;
|
|
735
|
+
ngOnDestroy(): void;
|
|
736
|
+
/**
|
|
737
|
+
* @hidden
|
|
738
|
+
*/
|
|
739
|
+
templateContext(index: number): any;
|
|
740
|
+
/**
|
|
741
|
+
* @hidden
|
|
742
|
+
*/
|
|
743
|
+
editTemplateContext(index: number): any;
|
|
744
|
+
/**
|
|
745
|
+
* Focuses the item at the specified index ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/keyboard-navigation#controlling-the-focus)):
|
|
746
|
+
* - When you specify no index, the current active index receives focus.
|
|
747
|
+
* - When the passed value is below `0`, the first item receives focus.
|
|
748
|
+
* - When the passed value is above the last available index, the last item receives focus.
|
|
749
|
+
*
|
|
750
|
+
* > The `index` parameter is based on the logical structure of the ListView and does not correspond to the data item index&mdash
|
|
751
|
+
* > the index `0` corresponds to the first rendered list item. Paging is not taken into account.
|
|
752
|
+
* > Also, the `navigable` property must first be set to `true` for the method to work as expected.
|
|
753
|
+
*/
|
|
754
|
+
focus(index?: number): void;
|
|
755
|
+
/**
|
|
756
|
+
* Creates a new item editor ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms#adding-records)).
|
|
757
|
+
*
|
|
758
|
+
* @param {FormGroup} group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes
|
|
759
|
+
* the edit form. When called with a data item, it builds the `FormGroup` from the data item fields.
|
|
760
|
+
*/
|
|
761
|
+
addItem(group: any): void;
|
|
762
|
+
/**
|
|
763
|
+
* Switches the specified item to edit mode ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms#editing-records)).
|
|
764
|
+
*
|
|
765
|
+
* @param index - The item index that switches to edit mode.
|
|
766
|
+
* @param group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi'])
|
|
767
|
+
* that describes the edit form.
|
|
768
|
+
*/
|
|
769
|
+
editItem(index: number, group?: any): void;
|
|
770
|
+
/**
|
|
771
|
+
* Closes the editor for a given item ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing/editing-template-forms#cancelling-editing)).
|
|
772
|
+
*
|
|
773
|
+
* @param {number} index - The item index that switches out of the edit mode. When you provide no index, the editor of the new item will close.
|
|
774
|
+
*/
|
|
775
|
+
closeItem(index?: number): void;
|
|
776
|
+
/**
|
|
777
|
+
* @hidden
|
|
778
|
+
*/
|
|
779
|
+
isEdited(index: number): boolean;
|
|
780
|
+
/**
|
|
781
|
+
* @hidden
|
|
782
|
+
*/
|
|
783
|
+
handlePageChange(event: PageChangeEvent): void;
|
|
784
|
+
/**
|
|
785
|
+
* @hidden
|
|
786
|
+
*/
|
|
787
|
+
handleContentScroll: () => void;
|
|
788
|
+
/**
|
|
789
|
+
* @hidden
|
|
790
|
+
*/
|
|
791
|
+
itemPosInSet(index: number): number;
|
|
792
|
+
private scrollToContainerTop;
|
|
793
|
+
private addNavigationListeners;
|
|
794
|
+
private attachEditHandlers;
|
|
795
|
+
private emitCRUDEvent;
|
|
796
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ListViewComponent, never>;
|
|
797
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ListViewComponent, "kendo-listview", ["kendoListView"], { "bordered": { "alias": "bordered"; "required": false; }; "data": { "alias": "data"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; "containerStyle": { "alias": "containerStyle"; "required": false; }; "itemStyle": { "alias": "itemStyle"; "required": false; }; "containerClass": { "alias": "containerClass"; "required": false; }; "itemClass": { "alias": "itemClass"; "required": false; }; "containerLabel": { "alias": "containerLabel"; "required": false; }; "containerRole": { "alias": "containerRole"; "required": false; }; "listItemRole": { "alias": "listItemRole"; "required": false; }; "navigable": { "alias": "navigable"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; "skip": { "alias": "skip"; "required": false; }; "pageable": { "alias": "pageable"; "required": false; }; "height": { "alias": "height"; "required": false; }; }, { "scrollBottom": "scrollBottom"; "pageChange": "pageChange"; "pageSizeChange": "pageSizeChange"; "edit": "edit"; "cancel": "cancel"; "save": "save"; "remove": "remove"; "add": "add"; }, ["itemTemplate", "headerTemplate", "footerTemplate", "loaderTemplate", "noDataTemplate", "editTemplate"], never, true, never>;
|
|
798
|
+
}
|
|
799
|
+
|
|
800
|
+
/**
|
|
801
|
+
* Encapsulates the in-memory handling of paging for the ListView component
|
|
802
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/paging#binding-directive)).
|
|
803
|
+
*
|
|
804
|
+
* @example
|
|
805
|
+
* ```typescript
|
|
806
|
+
* @Component({
|
|
807
|
+
* selector: 'my-app',
|
|
808
|
+
* template: `
|
|
809
|
+
* <kendo-listview [kendoListViewBinding]="listItems">
|
|
810
|
+
* <ng-template kendoListViewItemTemplate let-dataItem>
|
|
811
|
+
* <div>{{ dataItem.name }}</div>
|
|
812
|
+
* </ng-template>
|
|
813
|
+
* </kendo-listview>
|
|
814
|
+
* `
|
|
815
|
+
* })
|
|
816
|
+
* export class AppComponent {
|
|
817
|
+
* listItems = [{ name: 'Item 1' }, { name: 'Item 2' }];
|
|
818
|
+
* }
|
|
819
|
+
* ```
|
|
820
|
+
* @remarks
|
|
821
|
+
* Applied to: {@link ListViewComponent}.
|
|
822
|
+
*/
|
|
823
|
+
declare class DataBindingDirective {
|
|
824
|
+
private listView;
|
|
825
|
+
/**
|
|
826
|
+
* Specifies the array of data that populates the ListView.
|
|
827
|
+
*/
|
|
828
|
+
set data(data: any[]);
|
|
829
|
+
get data(): any[];
|
|
830
|
+
private _data;
|
|
831
|
+
private subscriptions;
|
|
832
|
+
constructor(listView: ListViewComponent);
|
|
833
|
+
ngOnInit(): void;
|
|
834
|
+
ngOnDestroy(): void;
|
|
835
|
+
private handlePageChange;
|
|
836
|
+
private handlePageSizeChange;
|
|
837
|
+
private updateListViewData;
|
|
838
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<DataBindingDirective, never>;
|
|
839
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<DataBindingDirective, "[kendoListViewBinding]", never, { "data": { "alias": "kendoListViewBinding"; "required": false; }; }, {}, never, never, true, never>;
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* Represents the edit command button directive of the Kendo UI ListView for Angular.
|
|
844
|
+
* Provides the `edit` command of the ListView. You can apply this directive to any `button`
|
|
845
|
+
* element inside a [`EditTemplateDirective`](https://www.telerik.com/kendo-angular-ui/components/listview/api/edittemplatedirective) template.
|
|
846
|
+
* When you click an associated button with the directive, the
|
|
847
|
+
* [`edit`](https://www.telerik.com/kendo-angular-ui/components/listview/api/listviewcomponent#edit) event
|
|
848
|
+
* triggers ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing)).
|
|
849
|
+
*
|
|
850
|
+
* @example
|
|
851
|
+
* ```html
|
|
852
|
+
* <kendo-listview>
|
|
853
|
+
* <ng-template kendoListViewEditTemplate>
|
|
854
|
+
* <button kendoListViewEditCommand class="k-primary">Edit</button>
|
|
855
|
+
* </ng-template>
|
|
856
|
+
* </kendo-listview>
|
|
857
|
+
* ```
|
|
858
|
+
*/
|
|
859
|
+
declare class EditCommandDirective extends Button {
|
|
860
|
+
private editService;
|
|
861
|
+
private elementRef;
|
|
862
|
+
/**
|
|
863
|
+
* @hidden
|
|
864
|
+
*/
|
|
865
|
+
clickHandler(e: any): void;
|
|
866
|
+
constructor(editService: EditService, element: ElementRef, renderer: Renderer2, localization: LocalizationService, ngZone: NgZone);
|
|
867
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<EditCommandDirective, never>;
|
|
868
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<EditCommandDirective, "[kendoListViewEditCommand]", never, {}, {}, never, ["*"], true, never>;
|
|
869
|
+
}
|
|
870
|
+
|
|
871
|
+
/**
|
|
872
|
+
* Represents the add command button directive of the Kendo UI ListView for Angular.
|
|
873
|
+
* Provides the command for adding a new item to the ListView. You can apply this directive to any
|
|
874
|
+
* `button` element inside a [`HeaderTemplate`](https://www.telerik.com/kendo-angular-ui/components/listview/api/headertemplatedirective).
|
|
875
|
+
* When you click an associated button with the directive, the
|
|
876
|
+
* [`add`](https://www.telerik.com/kendo-angular-ui/components/listview/api/listviewcomponent#add) event triggers
|
|
877
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing)).
|
|
878
|
+
*
|
|
879
|
+
* @example
|
|
880
|
+
* ```html
|
|
881
|
+
* <kendo-listview>
|
|
882
|
+
* <ng-template kendoListViewHeaderTemplate>
|
|
883
|
+
* <button kendoListViewAddCommand>Add new</button>
|
|
884
|
+
* </ng-template>
|
|
885
|
+
* </kendo-listview>
|
|
886
|
+
* ```
|
|
887
|
+
*/
|
|
888
|
+
declare class AddCommandDirective extends Button {
|
|
889
|
+
private editService;
|
|
890
|
+
/**
|
|
891
|
+
* @hidden
|
|
892
|
+
*/
|
|
893
|
+
clickHandler(e: any): void;
|
|
894
|
+
constructor(editService: EditService, element: ElementRef, renderer: Renderer2, localization: LocalizationService, ngZone: NgZone);
|
|
895
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<AddCommandDirective, never>;
|
|
896
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<AddCommandDirective, "[kendoListViewAddCommand]", never, {}, {}, never, ["*"], true, never>;
|
|
897
|
+
}
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* Represents the save command button directive of the Kendo UI ListView for Angular.
|
|
901
|
+
* Provides the `save` command of the ListView. You can apply this directive to any `button`
|
|
902
|
+
* element inside a [`EditTemplateDirective`](https://www.telerik.com/kendo-angular-ui/components/listview/api/edittemplatedirective) template.
|
|
903
|
+
* When you click an associated button with the directive, the
|
|
904
|
+
* [`save`](https://www.telerik.com/kendo-angular-ui/components/listview/api/listviewcomponent#save) event
|
|
905
|
+
* triggers ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing)).
|
|
906
|
+
*
|
|
907
|
+
* @example
|
|
908
|
+
* ```html
|
|
909
|
+
* <kendo-listview>
|
|
910
|
+
* <ng-template kendoListViewEditTemplate>
|
|
911
|
+
* <button kendoListViewSaveCommand>Save changes</button>
|
|
912
|
+
* </ng-template>
|
|
913
|
+
* </kendo-listview>
|
|
914
|
+
* ```
|
|
915
|
+
*
|
|
916
|
+
* You can control the content of the button based on the state of the item.
|
|
917
|
+
*
|
|
918
|
+
* @example
|
|
919
|
+
* ```html
|
|
920
|
+
* <kendo-listview>
|
|
921
|
+
* <ng-template kendoListViewEditTemplate let-isNew="isNew">
|
|
922
|
+
* <button kendoListViewSaveCommand>{{isNew ? 'Add' : 'Update'}}</button>
|
|
923
|
+
* </ng-template>
|
|
924
|
+
* </kendo-listview>
|
|
925
|
+
* ```
|
|
926
|
+
*/
|
|
927
|
+
declare class SaveCommandDirective extends Button {
|
|
928
|
+
private editService;
|
|
929
|
+
private elementRef;
|
|
930
|
+
/**
|
|
931
|
+
* @hidden
|
|
932
|
+
*/
|
|
933
|
+
clickHandler(e: any): void;
|
|
934
|
+
constructor(editService: EditService, element: ElementRef, renderer: Renderer2, localization: LocalizationService, ngZone: NgZone);
|
|
935
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SaveCommandDirective, never>;
|
|
936
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SaveCommandDirective, "[kendoListViewSaveCommand]", never, {}, {}, never, ["*"], true, never>;
|
|
937
|
+
}
|
|
938
|
+
|
|
939
|
+
/**
|
|
940
|
+
* Represents the cancel command button directive of the Kendo UI ListView for Angular.
|
|
941
|
+
* Provides the `cancel` command of the ListView. You can apply this directive to any `button`
|
|
942
|
+
* element inside a [`EditTemplateDirective`](https://www.telerik.com/kendo-angular-ui/components/listview/api/edittemplatedirective) template.
|
|
943
|
+
* When you click an associated button with the directive, the
|
|
944
|
+
* [`cancel`](https://www.telerik.com/kendo-angular-ui/components/listview/api/listviewcomponent#cancel) event
|
|
945
|
+
* triggers ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing)).
|
|
946
|
+
*
|
|
947
|
+
* @example
|
|
948
|
+
* ```html
|
|
949
|
+
* <kendo-listview>
|
|
950
|
+
* <ng-template kendoListViewEditTemplate>
|
|
951
|
+
* <button kendoListViewCancelCommand>Cancel changes</button>
|
|
952
|
+
* </ng-template>
|
|
953
|
+
* </kendo-listview>
|
|
954
|
+
* ```
|
|
955
|
+
*
|
|
956
|
+
* You can control the content of the button based on the state of the item.
|
|
957
|
+
*
|
|
958
|
+
* @example
|
|
959
|
+
* ```html
|
|
960
|
+
* <kendo-listview>
|
|
961
|
+
* <ng-template kendoListViewEditTemplate let-isNew="isNew">
|
|
962
|
+
* <button kendoListViewCancelCommand>{{isNew ? 'Discard' : 'Cancel changes'}}</button>
|
|
963
|
+
* </ng-template>
|
|
964
|
+
* </kendo-listview>
|
|
965
|
+
* ```
|
|
966
|
+
*/
|
|
967
|
+
declare class CancelCommandDirective extends Button {
|
|
968
|
+
private editService;
|
|
969
|
+
private elementRef;
|
|
970
|
+
/**
|
|
971
|
+
* @hidden
|
|
972
|
+
*/
|
|
973
|
+
clickHandler(e: any): void;
|
|
974
|
+
constructor(editService: EditService, element: ElementRef, renderer: Renderer2, localization: LocalizationService, ngZone: NgZone);
|
|
975
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<CancelCommandDirective, never>;
|
|
976
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<CancelCommandDirective, "[kendoListViewCancelCommand]", never, {}, {}, never, ["*"], true, never>;
|
|
977
|
+
}
|
|
978
|
+
|
|
979
|
+
/**
|
|
980
|
+
* Represents the remove command button directive of the Kendo UI ListView for Angular.
|
|
981
|
+
* Provides the `remove` command of the ListView. You can apply this directive to any `button` element
|
|
982
|
+
* inside a [`EditTemplateDirective`](https://www.telerik.com/kendo-angular-ui/components/listview/api/edittemplatedirective) template.
|
|
983
|
+
* When you click an associated button with the directive, the
|
|
984
|
+
* [`remove`](https://www.telerik.com/kendo-angular-ui/components/listview/api/listviewcomponent#remove) event
|
|
985
|
+
* triggers ([see example](https://www.telerik.com/kendo-angular-ui/components/listview/editing)).
|
|
986
|
+
*
|
|
987
|
+
* @example
|
|
988
|
+
* ```html
|
|
989
|
+
* <kendo-listview>
|
|
990
|
+
* <ng-template kendoListViewEditTemplate>
|
|
991
|
+
* <button kendoListViewRemoveCommand>Remove item</button>
|
|
992
|
+
* </ng-template>
|
|
993
|
+
* </kendo-listview>
|
|
994
|
+
* ```
|
|
995
|
+
*/
|
|
996
|
+
declare class RemoveCommandDirective extends Button {
|
|
997
|
+
private editService;
|
|
998
|
+
private elementRef;
|
|
999
|
+
/**
|
|
1000
|
+
* @hidden
|
|
1001
|
+
*/
|
|
1002
|
+
clickHandler(e: any): void;
|
|
1003
|
+
constructor(editService: EditService, element: ElementRef, renderer: Renderer2, localization: LocalizationService, ngZone: NgZone);
|
|
1004
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<RemoveCommandDirective, never>;
|
|
1005
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<RemoveCommandDirective, "[kendoListViewRemoveCommand]", never, {}, {}, never, ["*"], true, never>;
|
|
1006
|
+
}
|
|
1007
|
+
|
|
1008
|
+
/**
|
|
1009
|
+
* Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
|
|
1010
|
+
* definition for the ListView component.
|
|
1011
|
+
* @example
|
|
1012
|
+
*
|
|
1013
|
+
* ```ts
|
|
1014
|
+
* import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
|
|
1015
|
+
* import { BrowserModule } from '@angular/platform-browser';
|
|
1016
|
+
* import { NgModule } from '@angular/core';
|
|
1017
|
+
* import { ListViewModule } from '@progress/kendo-angular-listview';
|
|
1018
|
+
* import { AppComponent } from './app.component';
|
|
1019
|
+
*
|
|
1020
|
+
* @NgModule({
|
|
1021
|
+
* declarations: [AppComponent],
|
|
1022
|
+
* imports: [BrowserModule, BrowserAnimationsModule, ListViewModule],
|
|
1023
|
+
* bootstrap: [AppComponent]
|
|
1024
|
+
* })
|
|
1025
|
+
* export class AppModule {}
|
|
1026
|
+
*```
|
|
1027
|
+
*/
|
|
1028
|
+
declare class ListViewModule {
|
|
1029
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ListViewModule, never>;
|
|
1030
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<ListViewModule, never, [typeof ListViewComponent, typeof ItemTemplateDirective, typeof HeaderTemplateDirective, typeof FooterTemplateDirective, typeof LoaderTemplateDirective, typeof NoDataTemplateDirective, typeof DataBindingDirective, typeof EditTemplateDirective, typeof EditCommandDirective, typeof CancelCommandDirective, typeof SaveCommandDirective, typeof RemoveCommandDirective, typeof AddCommandDirective], [typeof ListViewComponent, typeof ItemTemplateDirective, typeof HeaderTemplateDirective, typeof FooterTemplateDirective, typeof LoaderTemplateDirective, typeof NoDataTemplateDirective, typeof DataBindingDirective, typeof EditTemplateDirective, typeof EditCommandDirective, typeof CancelCommandDirective, typeof SaveCommandDirective, typeof RemoveCommandDirective, typeof AddCommandDirective]>;
|
|
1031
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<ListViewModule>;
|
|
1032
|
+
}
|
|
1033
|
+
|
|
1034
|
+
/**
|
|
1035
|
+
* Utility array that contains all `@progress/kendo-angular-listview` related components and directives
|
|
1036
|
+
*/
|
|
1037
|
+
declare const KENDO_LISTVIEW: readonly [typeof ListViewComponent, typeof ItemTemplateDirective, typeof HeaderTemplateDirective, typeof FooterTemplateDirective, typeof LoaderTemplateDirective, typeof NoDataTemplateDirective, typeof DataBindingDirective, typeof EditTemplateDirective, typeof EditCommandDirective, typeof CancelCommandDirective, typeof SaveCommandDirective, typeof RemoveCommandDirective, typeof AddCommandDirective];
|
|
1038
|
+
|
|
1039
|
+
export { AddCommandDirective, CancelCommandDirective, DataBindingDirective, EditCommandDirective, EditTemplateDirective, FooterTemplateDirective, HeaderTemplateDirective, ItemTemplateDirective, KENDO_LISTVIEW, ListViewComponent, ListViewModule, LoaderTemplateDirective, NoDataTemplateDirective, PageSizeChangeEvent, RemoveCommandDirective, SaveCommandDirective };
|
|
1040
|
+
export type { AddEvent, CancelEvent, EditEvent, ListViewDataResult, PageChangeEvent, PageSizeItem, PagerPosition, PagerSettings, PagerType, RemoveEvent, SaveEvent };
|