@progress/kendo-angular-listview 19.1.2-develop.2 → 19.1.2-develop.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/data-binding/data-binding.directive.d.ts +19 -2
  2. package/editing/commands/add-command.directive.d.ts +5 -4
  3. package/editing/commands/cancel-command.directive.d.ts +6 -5
  4. package/editing/commands/edit-command.directive.d.ts +5 -5
  5. package/editing/commands/remove-command.directive.d.ts +6 -5
  6. package/editing/commands/save-command.directive.d.ts +6 -5
  7. package/editing/edit-template.directive.d.ts +23 -5
  8. package/editing/events/add-event-args.interface.d.ts +2 -1
  9. package/editing/events/cancel-event-args.interface.d.ts +2 -1
  10. package/editing/events/edit-event-args.interface.d.ts +6 -5
  11. package/editing/events/remove-event-args.interface.d.ts +2 -1
  12. package/editing/events/save-event-args.interface.d.ts +3 -2
  13. package/esm2022/data-binding/data-binding.directive.mjs +19 -2
  14. package/esm2022/editing/commands/add-command.directive.mjs +5 -4
  15. package/esm2022/editing/commands/cancel-command.directive.mjs +6 -5
  16. package/esm2022/editing/commands/edit-command.directive.mjs +5 -5
  17. package/esm2022/editing/commands/remove-command.directive.mjs +6 -5
  18. package/esm2022/editing/commands/save-command.directive.mjs +6 -5
  19. package/esm2022/editing/edit-template.directive.mjs +23 -5
  20. package/esm2022/listview.component.mjs +74 -41
  21. package/esm2022/models/page-size-change-event.mjs +2 -2
  22. package/esm2022/package-metadata.mjs +2 -2
  23. package/esm2022/templates/footer-template.directive.mjs +18 -2
  24. package/esm2022/templates/header-template.directive.mjs +19 -2
  25. package/esm2022/templates/item-template.directive.mjs +23 -6
  26. package/esm2022/templates/loader-template.directive.mjs +18 -1
  27. package/fesm2022/progress-kendo-angular-listview.mjs +226 -87
  28. package/listview.component.d.ts +74 -41
  29. package/models/listview-data-result.d.ts +3 -3
  30. package/models/page-change-event.d.ts +3 -2
  31. package/models/page-size-change-event.d.ts +2 -2
  32. package/models/page-size-item.d.ts +2 -2
  33. package/models/pager-position.d.ts +4 -2
  34. package/models/pager-settings.d.ts +4 -9
  35. package/models/pager-type.d.ts +2 -5
  36. package/models/scroll-bottom-event.d.ts +2 -2
  37. package/package.json +8 -8
  38. package/schematics/ngAdd/index.js +6 -6
  39. package/templates/footer-template.directive.d.ts +18 -2
  40. package/templates/header-template.directive.d.ts +19 -2
  41. package/templates/item-template.directive.d.ts +23 -6
  42. package/templates/loader-template.directive.d.ts +18 -1
@@ -25,8 +25,8 @@ const packageMetadata = {
25
25
  productName: 'Kendo UI for Angular',
26
26
  productCode: 'KENDOUIANGULAR',
27
27
  productCodes: ['KENDOUIANGULAR'],
28
- publishDate: 1749820766,
29
- version: '19.1.2-develop.2',
28
+ publishDate: 1750152834,
29
+ version: '19.1.2-develop.3',
30
30
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
31
31
  };
32
32
 
@@ -348,15 +348,32 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
348
348
  }] } });
349
349
 
350
350
  /**
351
- * Renders the list item content. To define an item template, nest an `<ng-template>` tag
351
+ * Allows customizing the list item content. To define an item template, nest an `<ng-template>` tag
352
352
  * with the `kendoListViewItemTemplate` directive inside the `<kendo-listview>` tag
353
- * [see example]({% slug templates_listview %}#toc-item-template).
353
+ * ([see example]({% slug templates_listview %}#toc-item-template)).
354
354
  *
355
355
  * The following values are available as context variables:
356
- * - `let-dataItem="dataItem"` (`any`) - The current data item. Also available as implicit context variable.
357
- * - `let-index="index"` (`number`) - The current item index.
358
- * - `let-isFirst="isFirst"` (`boolean`) - Indicates whether the current data item will be rendered as the first item on the list.
359
- * - `let-isLast="isLast"` (`boolean`)- Indicates whether the current data item will be rendered as the last item on the list.
356
+ * - `let-dataItem="dataItem"` (`any`)&mdashThe current data item. Also available as implicit context variable.
357
+ * - `let-index="index"` (`number`)&mdashThe current item index.
358
+ * - `let-isFirst="isFirst"` (`boolean`)&mdashIndicates whether the current data item renders as the first item on the list.
359
+ * - `let-isLast="isLast"` (`boolean`)&mdashIndicates whether the current data item renders as the last item on the list.
360
+ *
361
+ * @example
362
+ * ```typescript
363
+ * @Component({
364
+ * template: `
365
+ * <kendo-listview [data]="items">
366
+ * <ng-template kendoListViewItemTemplate let-dataItem let-index="index">
367
+ * <div class="item-wrapper">
368
+ * <h4>{{ dataItem.name }}</h4>
369
+ * <p>Item #{{ index + 1 }}: {{ dataItem.description }}</p>
370
+ * </div>
371
+ * </ng-template>
372
+ * </kendo-listview>
373
+ * `
374
+ * })
375
+ * export class AppComponent { }
376
+ * ```
360
377
  */
361
378
  class ItemTemplateDirective {
362
379
  templateRef;
@@ -375,9 +392,26 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
375
392
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
376
393
 
377
394
  /**
378
- * Renders the header content of the ListView. To define a header template, nest an `<ng-template>` tag
395
+ * Allows customizing the header content of the ListView. To define a header template, nest an `<ng-template>` tag
379
396
  * with the `kendoListViewHeaderTemplate` directive inside the `<kendo-listview>` tag
380
- * [see example]({% slug templates_listview %}#toc-header-template).
397
+ * ([see example]({% slug templates_listview %}#toc-header-template)).
398
+ *
399
+ * @example
400
+ * ```typescript
401
+ * @Component({
402
+ * template: `
403
+ * <kendo-listview [data]="items">
404
+ * <ng-template kendoListViewHeaderTemplate>
405
+ * <div class="header-content">
406
+ * <h3>Product List</h3>
407
+ * <button kendoListViewAddCommand>Add New Item</button>
408
+ * </div>
409
+ * </ng-template>
410
+ * </kendo-listview>
411
+ * `
412
+ * })
413
+ * export class AppComponent { }
414
+ * ```
381
415
  */
382
416
  class HeaderTemplateDirective {
383
417
  templateRef;
@@ -396,9 +430,25 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
396
430
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
397
431
 
398
432
  /**
399
- * Renders the footer content of the ListView. To define a footer template, nest an `<ng-template>` tag
433
+ * Allows customizing the footer content of the ListView. To define a footer template, nest an `<ng-template>` tag
400
434
  * with the `kendoListViewFooterTemplate` directive inside the `<kendo-listview>` tag
401
- * [see example]({% slug templates_listview %}#toc-footer-template).
435
+ * ([see example]({% slug templates_listview %}#toc-footer-template)).
436
+ *
437
+ * @example
438
+ * ```typescript
439
+ * @Component({
440
+ * template: `
441
+ * <kendo-listview [data]="items">
442
+ * <ng-template kendoListViewFooterTemplate>
443
+ * <div class="footer-content">
444
+ * <p>Total items: {{ items.length }}</p>
445
+ * </div>
446
+ * </ng-template>
447
+ * </kendo-listview>
448
+ * `
449
+ * })
450
+ * export class AppComponent { }
451
+ * ```
402
452
  */
403
453
  class FooterTemplateDirective {
404
454
  templateRef;
@@ -419,7 +469,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
419
469
  /**
420
470
  * Overrides the default loader content of the ListView. To define a loader template, nest an `<ng-template>` tag
421
471
  * with the `kendoListViewLoaderTemplate` directive inside the `<kendo-listview>` tag
422
- * [see example]({% slug templates_listview %}#toc-loader-template).
472
+ * ([see example]({% slug templates_listview %}#toc-loader-template)).
473
+ *
474
+ * @example
475
+ * ```typescript
476
+ * @Component({
477
+ * template: `
478
+ * <kendo-listview [data]="items" [loading]="isLoading">
479
+ * <ng-template kendoListViewLoaderTemplate>
480
+ * <div class="custom-loader">
481
+ * <kendo-loader></kendo-loader>
482
+ * <p>Loading data, please wait...</p>
483
+ * </div>
484
+ * </ng-template>
485
+ * </kendo-listview>
486
+ * `
487
+ * })
488
+ * export class AppComponent { }
489
+ * ```
423
490
  */
424
491
  class LoaderTemplateDirective {
425
492
  templateRef;
@@ -438,16 +505,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
438
505
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
439
506
 
440
507
  /**
441
- * Represents the edit template of the ListView ([see example]({% slug editing_template_forms_listview %})).
442
- * Helps to customize the content of the edited items. To define the template, nest an `<ng-template>`
508
+ * Defines the edit template of the ListView ([see example]({% slug editing_template_forms_listview %})).
509
+ * Helps you customize the content of the edited items. To define the template, nest an `<ng-template>`
443
510
  * tag with the `kendoListViewEditTemplate` directive inside a `<kendo-listview>` tag.
444
511
  *
445
512
  * The template context contains the following fields:
446
- * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']).
447
- * If you use the ListView inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
448
- * - `itemIndex`&mdash;The current item index. If inside a new item, `itemIndex` is `-1`.
513
+ * - `formGroup`&mdash;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`.
514
+ * - `itemIndex`&mdash;The current item index. When inside a new item, `itemIndex` is `-1`.
449
515
  * - `dataItem`&mdash;The current data item.
450
516
  * - `isNew`&mdash;The state of the current item.
517
+ *
518
+ *
519
+ * @example
520
+ * ```typescript
521
+ * @Component({
522
+ * template: `
523
+ * <kendo-listview [data]="items">
524
+ * <ng-template kendoListViewEditTemplate let-dataItem let-formGroup="formGroup">
525
+ * <div class="edit-form">
526
+ * <input [(ngModel)]="dataItem.name" [formControl]="formGroup.get('name')" />
527
+ * <button kendoListViewSaveCommand>Save</button>
528
+ * <button kendoListViewCancelCommand>Cancel</button>
529
+ * </div>
530
+ * </ng-template>
531
+ * </kendo-listview>
532
+ * `
533
+ * })
534
+ * export class AppComponent { }
535
+ * ```
451
536
  */
452
537
  class EditTemplateDirective {
453
538
  templateRef;
@@ -591,6 +676,34 @@ const createControl = (source) => (acc, key) => {
591
676
  };
592
677
  /**
593
678
  * Represents the Kendo UI ListView component for Angular.
679
+ * Displays a list of data items and supports paging, editing, and custom templates
680
+ * ([see overview]({% slug overview_listview %})).
681
+ *
682
+ * @example
683
+ * ```typescript
684
+ * @Component({
685
+ * selector: 'my-app',
686
+ * template: `
687
+ * <kendo-listview
688
+ * [data]="items"
689
+ * [pageable]="true"
690
+ * [pageSize]="5">
691
+ * <ng-template kendoListViewItemTemplate let-dataItem>
692
+ * <div class="item">
693
+ * <h3>{{ dataItem.name }}</h3>
694
+ * <p>{{ dataItem.description }}</p>
695
+ * </div>
696
+ * </ng-template>
697
+ * </kendo-listview>
698
+ * `
699
+ * })
700
+ * export class AppComponent {
701
+ * items = [
702
+ * { name: 'Item 1', description: 'First item' },
703
+ * { name: 'Item 2', description: 'Second item' }
704
+ * ];
705
+ * }
706
+ * ```
594
707
  */
595
708
  class ListViewComponent {
596
709
  ngZone;
@@ -638,7 +751,7 @@ class ListViewComponent {
638
751
  */
639
752
  bordered = false;
640
753
  /**
641
- * The data collection that will be used to populate the ListView
754
+ * Specifies the data collection that populates the ListView
642
755
  * ([see data binding examples]({% slug paging_listview %})).
643
756
  */
644
757
  set data(value) {
@@ -649,28 +762,30 @@ class ListViewComponent {
649
762
  return this._data;
650
763
  }
651
764
  /**
652
- * Specifies if the loading indicator of the ListView will be displayed
765
+ * Specifies whether the loading indicator of the ListView displays
653
766
  * ([see example]({% slug paging_listview %}#toc-remote-binding)).
767
+ *
768
+ * @default false
654
769
  */
655
770
  loading = false;
656
771
  /**
657
- * The CSS styles that will be rendered on the content container element of the ListView.
658
- * Supports the type of values that are supported by [`ngStyle`](link:site.data.urls.angular['ngstyleapi']).
772
+ * Specifies the CSS styles that render on the content container element of the ListView.
773
+ * Supports the type of values that [`ngStyle`](link:site.data.urls.angular['ngstyleapi']) supports.
659
774
  */
660
775
  containerStyle;
661
776
  /**
662
- * The CSS styles that will be rendered on each item element wrapper of the ListView.
663
- * Supports the type of values that are supported by [`ngStyle`](link:site.data.urls.angular['ngstyleapi']).
777
+ * Specifies the CSS styles that render on each item element wrapper of the ListView.
778
+ * Supports the type of values that [`ngStyle`](link:site.data.urls.angular['ngstyleapi']) supports.
664
779
  */
665
780
  itemStyle;
666
781
  /**
667
- * The CSS class that will be rendered on the content container element of the ListView.
668
- * Supports the type of values that are supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
782
+ * Specifies the CSS class that renders on the content container element of the ListView.
783
+ * Supports the type of values that [`ngClass`](link:site.data.urls.angular['ngclassapi']) supports.
669
784
  */
670
785
  containerClass;
671
786
  /**
672
- * The CSS class that will be rendered on each item element wrapper of the ListView.
673
- * Supports the type of values that are supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
787
+ * Specifies the CSS class that renders on each item element wrapper of the ListView.
788
+ * Supports the type of values that [`ngClass`](link:site.data.urls.angular['ngclassapi']) supports.
674
789
  */
675
790
  itemClass;
676
791
  /**
@@ -681,19 +796,22 @@ class ListViewComponent {
681
796
  /**
682
797
  * Specifies the content container `role` attribute
683
798
  * ([more details]({% slug accessibility_listview %}#toc-wai-aria-support)).
684
- * By default, the container `role` is set to `list`.
799
+ *
800
+ * @default 'list'
685
801
  */
686
802
  containerRole = 'list';
687
803
  /**
688
804
  * Specifies the list item `role` attribute
689
805
  * ([more details]({% slug accessibility_listview %}#toc-wai-aria-support)).
690
- * By default, the list item `role` is set to `listitem`.
806
+ *
807
+ * @default 'listitem'
691
808
  */
692
809
  listItemRole = 'listitem';
693
810
  /**
694
- * Specifies whether the keyboard navigation is enabled
811
+ * Specifies whether keyboard navigation is enabled
695
812
  * ([see example]({% slug keyboard_navigation_listview %})).
696
- * By default, the navigation is enabled.
813
+ *
814
+ * @default true
697
815
  */
698
816
  set navigable(navigable) {
699
817
  if (!navigable && isPresent(this.removeNavigationListeners)) {
@@ -711,7 +829,7 @@ class ListViewComponent {
711
829
  return this._navigable;
712
830
  }
713
831
  /**
714
- * Defines the page size used by the ListView pager
832
+ * Specifies the page size used by the ListView pager
715
833
  * ([more details]({% slug paging_listview %})).
716
834
  */
717
835
  pageSize;
@@ -728,9 +846,9 @@ class ListViewComponent {
728
846
  return this._skip;
729
847
  }
730
848
  /**
731
- * Configures whether the ListView will render a pager
849
+ * Configures whether the ListView renders a pager
732
850
  * ([more details]({% slug paging_listview %})).
733
- * Providing a boolean value will render a pager with the default settings.
851
+ * When you provide a boolean value, it renders a pager with the default settings.
734
852
  */
735
853
  set pageable(pageable) {
736
854
  this._pageable = pageable;
@@ -740,50 +858,51 @@ class ListViewComponent {
740
858
  return this._pageable;
741
859
  }
742
860
  /**
743
- * Defines the height (in pixels) of the ListView component.
744
- * If the content height exceeds the component height, a vertical scrollbar will be rendered.
861
+ * Specifies the height (in pixels) of the ListView component.
862
+ * When the content height exceeds the component height, a vertical scrollbar renders.
863
+ *
745
864
  * To set the height of the ListView, you can also use `style.height`. The `style.height`
746
865
  * option supports units such as `px`, `%`, `em`, `rem`, and others.
747
866
  */
748
867
  height;
749
868
  /**
750
- * Fires when the user scrolls to the last record on the page
869
+ * Fires when you scroll to the last record on the page
751
870
  * ([see endless scrolling example]({% slug scrollmodes_listview %}#toc-endless-scrolling)).
752
871
  */
753
872
  scrollBottom = new EventEmitter();
754
873
  /**
755
- * Fires when the page or the page size of the ListView is changed
874
+ * Fires when you change the page or the page size of the ListView
756
875
  * ([see example]({% slug paging_listview %}#toc-remote-binding)).
757
876
  * You have to handle the event yourself and page the data.
758
877
  */
759
878
  pageChange = new EventEmitter();
760
879
  /**
761
- * Fires when the page size of the ListView is changed. This event can be prevented (`$event.preventDefault()`).
762
- * If not prevented, the `pageChange` event will be fired subsequently.
880
+ * Fires when you change the page size of the ListView. You can prevent this event (`$event.preventDefault()`).
881
+ * When not prevented, the `pageChange` event fires subsequently.
763
882
  */
764
883
  pageSizeChange = new EventEmitter();
765
884
  /**
766
- * Fires when the user clicks the **Edit** command button to edit an item
885
+ * Fires when you click the **Edit** command button to edit an item
767
886
  * ([see example]({% slug editing_template_forms_listview %}#toc-editing-records)).
768
887
  */
769
888
  edit = new EventEmitter();
770
889
  /**
771
- * Fires when the user clicks the **Cancel** command button to close an item
890
+ * Fires when you click the **Cancel** command button to close an item
772
891
  * ([see example]({% slug editing_template_forms_listview %}#toc-cancelling-editing)).
773
892
  */
774
893
  cancel = new EventEmitter();
775
894
  /**
776
- * Fires when the user clicks the **Save** command button to save changes in an item
895
+ * Fires when you click the **Save** command button to save changes in an item
777
896
  * ([see example]({% slug editing_template_forms_listview %}#toc-saving-records)).
778
897
  */
779
898
  save = new EventEmitter();
780
899
  /**
781
- * Fires when the user clicks the **Remove** command button to remove an item
900
+ * Fires when you click the **Remove** command button to remove an item
782
901
  * ([see example]({% slug editing_template_forms_listview %}#toc-removing-records)).
783
902
  */
784
903
  remove = new EventEmitter();
785
904
  /**
786
- * Fires when the user clicks the **Add** command button to add a new item
905
+ * Fires when you click the **Add** command button to add a new item
787
906
  * ([see example]({% slug editing_template_forms_listview %}#toc-adding-records)).
788
907
  */
789
908
  add = new EventEmitter();
@@ -795,7 +914,7 @@ class ListViewComponent {
795
914
  * @hidden
796
915
  *
797
916
  * Gets the data items passed to the ListView.
798
- * If a ListViewDataResult is passed, the data value is used. If an array is passed - it's directly used.
917
+ * If a `ListViewDataResult` is passed, the data value is used. If an array is passed - it's directly used.
799
918
  */
800
919
  get items() {
801
920
  if (!isPresent(this.data)) {
@@ -807,7 +926,7 @@ class ListViewComponent {
807
926
  * @hidden
808
927
  *
809
928
  * Gets the total number of records passed to the ListView.
810
- * If a ListViewDataResult is passed, the total value is used. If an array is passed - its length is used.
929
+ * If a `ListViewDataResult` is passed, the total value is used. If an array is passed - its length is used.
811
930
  */
812
931
  get total() {
813
932
  if (!this.pageable) {
@@ -829,7 +948,7 @@ class ListViewComponent {
829
948
  /**
830
949
  * Gets the current active item index
831
950
  * ([see example]({% slug keyboard_navigation_listview %}#toc-controlling-the-focus)).
832
- * Returns `null` when the keyboard navigation is disabled.
951
+ * Returns `null` when keyboard navigation is disabled.
833
952
  */
834
953
  get activeIndex() {
835
954
  return this.navigationService.activeIndex;
@@ -892,13 +1011,13 @@ class ListViewComponent {
892
1011
  }
893
1012
  /**
894
1013
  * Focuses the item at the specified index ([see example]({% slug keyboard_navigation_listview %}#toc-controlling-the-focus)):
895
- * - If no index is specified, the current active index will be focused.
896
- * - If the passed value is below `0`, the first item receives focus.
897
- * - If the passed value is above the last available index, the last item receives focus.
1014
+ * - When you specify no index, the current active index receives focus.
1015
+ * - When the passed value is below `0`, the first item receives focus.
1016
+ * - When the passed value is above the last available index, the last item receives focus.
898
1017
  *
899
- * > The index param is based on the logical structure of the ListView and does not correspond to the data item index -
900
- * > i.e. the index `0` corresponds to the first rendered list item. Paging is not taken into account.
901
- * > Also, for the focusing to work, the `navigable` prop must first be set to `true`.
1018
+ * > The `index` parameter is based on the logical structure of the ListView and does not correspond to the data item index&mdash
1019
+ * > the index `0` corresponds to the first rendered list item. Paging is not taken into account.
1020
+ * > Also, the `navigable` property must first be set to `true` for the method to work as expected.
902
1021
  */
903
1022
  focus(index) {
904
1023
  const totalRenderedItems = this.listViewItems.length;
@@ -908,7 +1027,7 @@ class ListViewComponent {
908
1027
  * Creates a new item editor ([see example]({% slug editing_template_forms_listview %}#toc-adding-records)).
909
1028
  *
910
1029
  * @param {FormGroup} group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes
911
- * the edit form. If called with a data item, it will build the `FormGroup` from the data item fields.
1030
+ * the edit form. When called with a data item, it builds the `FormGroup` from the data item fields.
912
1031
  */
913
1032
  addItem(group) {
914
1033
  const isFormGroup = group instanceof FormGroup;
@@ -921,7 +1040,7 @@ class ListViewComponent {
921
1040
  /**
922
1041
  * Switches the specified item to edit mode ([see example]({% slug editing_template_forms_listview %}#toc-editing-records)).
923
1042
  *
924
- * @param index - The item index that will be switched to edit mode.
1043
+ * @param index - The item index that switches to edit mode.
925
1044
  * @param group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi'])
926
1045
  * that describes the edit form.
927
1046
  */
@@ -932,8 +1051,7 @@ class ListViewComponent {
932
1051
  /**
933
1052
  * Closes the editor for a given item ([see example]({% slug editing_template_forms_listview %}#toc-cancelling-editing)).
934
1053
  *
935
- * @param {number} index - The item index that will be switched out of the edit mode. If no index is provided, it is assumed
936
- * that the new item editor will be closed.
1054
+ * @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.
937
1055
  */
938
1056
  closeItem(index) {
939
1057
  this.editService.close(index);
@@ -1382,13 +1500,30 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1382
1500
  }] } });
1383
1501
 
1384
1502
  /**
1385
- * A directive that encapsulates the in-memory handling of paging
1503
+ * Encapsulates the in-memory handling of paging for the ListView component
1386
1504
  * ([see example]({% slug paging_listview %}#toc-binding-directive)).
1505
+ *
1506
+ * @example
1507
+ * ```typescript
1508
+ * @Component({
1509
+ * selector: 'my-app',
1510
+ * template: `
1511
+ * <kendo-listview [kendoListViewBinding]="listItems">
1512
+ * <ng-template kendoListViewItemTemplate let-dataItem>
1513
+ * <div>{{ dataItem.name }}</div>
1514
+ * </ng-template>
1515
+ * </kendo-listview>
1516
+ * `
1517
+ * })
1518
+ * export class AppComponent {
1519
+ * listItems = [{ name: 'Item 1' }, { name: 'Item 2' }];
1520
+ * }
1521
+ * ```
1387
1522
  */
1388
1523
  class DataBindingDirective {
1389
1524
  listView;
1390
1525
  /**
1391
- * The array of data which will be used to populate the ListView.
1526
+ * Specifies the array of data that populates the ListView.
1392
1527
  */
1393
1528
  set data(data) {
1394
1529
  this._data = data || [];
@@ -1441,28 +1576,28 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1441
1576
  }] } });
1442
1577
 
1443
1578
  /**
1444
- * The arguments of the [`pageSizeChange`]({% slug api_listview_listviewcomponent %}#toc-pagesizechange) event of the ListView
1445
- * ([more details]({% slug paging_listview %}).
1579
+ * Defines the arguments of the [`pageSizeChange`]({% slug api_listview_listviewcomponent %}#toc-pagesizechange) event of the ListView
1580
+ * ([more details]({% slug paging_listview %})).
1446
1581
  */
1447
1582
  class PageSizeChangeEvent extends PageSizeChangeEvent$1 {
1448
1583
  }
1449
1584
 
1450
1585
  /**
1451
- * Represents the `edit` command of the ListView. You can apply this directive to any `button`
1586
+ * Represents the edit command button directive of the Kendo UI ListView for Angular.
1587
+ * Provides the `edit` command of the ListView. You can apply this directive to any `button`
1452
1588
  * element inside a [`EditTemplateDirective`]({% slug api_listview_edittemplatedirective %}) template.
1453
- * When an associated button with the directive is clicked, the
1589
+ * When you click an associated button with the directive, the
1454
1590
  * [`edit`]({% slug api_listview_listviewcomponent %}#toc-edit) event
1455
- * is triggered ([see example]({% slug editing_listview %})).
1591
+ * triggers ([see example]({% slug editing_listview %})).
1456
1592
  *
1457
1593
  * @example
1458
- * ```html-no-run
1594
+ * ```html
1459
1595
  * <kendo-listview>
1460
1596
  * <ng-template kendoListViewEditTemplate>
1461
1597
  * <button kendoListViewEditCommand class="k-primary">Edit</button>
1462
1598
  * </ng-template>
1463
1599
  * </kendo-listview>
1464
1600
  * ```
1465
- *
1466
1601
  */
1467
1602
  class EditCommandDirective extends Button {
1468
1603
  editService;
@@ -1519,14 +1654,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1519
1654
  }] } });
1520
1655
 
1521
1656
  /**
1522
- * Represents the command for adding a new item to the ListView. You can apply this directive to any
1657
+ * Represents the add command button directive of the Kendo UI ListView for Angular.
1658
+ * Provides the command for adding a new item to the ListView. You can apply this directive to any
1523
1659
  * `button` element inside a [`HeaderTemplate`]({% slug api_listview_headertemplatedirective %}).
1524
- * When an associated button with the directive is clicked, the
1525
- * [`add`]({% slug api_listview_listviewcomponent %}#toc-add) event is triggered
1660
+ * When you click an associated button with the directive, the
1661
+ * [`add`]({% slug api_listview_listviewcomponent %}#toc-add) event triggers
1526
1662
  * ([see example]({% slug editing_listview %})).
1527
1663
  *
1528
1664
  * @example
1529
- * ```html-no-run
1665
+ * ```html
1530
1666
  * <kendo-listview>
1531
1667
  * <ng-template kendoListViewHeaderTemplate>
1532
1668
  * <button kendoListViewAddCommand>Add new</button>
@@ -1586,14 +1722,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1586
1722
  }] } });
1587
1723
 
1588
1724
  /**
1589
- * Represents the `save` command of the ListView. You can apply this directive to any `button`
1725
+ * Represents the save command button directive of the Kendo UI ListView for Angular.
1726
+ * Provides the `save` command of the ListView. You can apply this directive to any `button`
1590
1727
  * element inside a [`EditTemplateDirective`]({% slug api_listview_edittemplatedirective %}) template.
1591
- * When an associated button with the directive is clicked, the
1728
+ * When you click an associated button with the directive, the
1592
1729
  * [`save`]({% slug api_listview_listviewcomponent %}#toc-save) event
1593
- * is triggered ([see example]({% slug editing_listview %})).
1730
+ * triggers ([see example]({% slug editing_listview %})).
1594
1731
  *
1595
1732
  * @example
1596
- * ```html-no-run
1733
+ * ```html
1597
1734
  * <kendo-listview>
1598
1735
  * <ng-template kendoListViewEditTemplate>
1599
1736
  * <button kendoListViewSaveCommand>Save changes</button>
@@ -1604,7 +1741,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1604
1741
  * You can control the content of the button based on the state of the item.
1605
1742
  *
1606
1743
  * @example
1607
- * ```html-no-run
1744
+ * ```html
1608
1745
  * <kendo-listview>
1609
1746
  * <ng-template kendoListViewEditTemplate let-isNew="isNew">
1610
1747
  * <button kendoListViewSaveCommand>{{isNew ? 'Add' : 'Update'}}</button>
@@ -1669,14 +1806,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1669
1806
  }] } });
1670
1807
 
1671
1808
  /**
1672
- * Represents the `cancel` command of the ListView. You can apply this directive to any `button`
1809
+ * Represents the cancel command button directive of the Kendo UI ListView for Angular.
1810
+ * Provides the `cancel` command of the ListView. You can apply this directive to any `button`
1673
1811
  * element inside a [`EditTemplateDirective`]({% slug api_listview_edittemplatedirective %}) template.
1674
- * When an associated button with the directive is clicked, the
1812
+ * When you click an associated button with the directive, the
1675
1813
  * [`cancel`]({% slug api_listview_listviewcomponent %}#toc-cancel) event
1676
- * is triggered ([see example]({% slug editing_listview %})).
1814
+ * triggers ([see example]({% slug editing_listview %})).
1677
1815
  *
1678
1816
  * @example
1679
- * ```html-no-run
1817
+ * ```html
1680
1818
  * <kendo-listview>
1681
1819
  * <ng-template kendoListViewEditTemplate>
1682
1820
  * <button kendoListViewCancelCommand>Cancel changes</button>
@@ -1687,7 +1825,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1687
1825
  * You can control the content of the button based on the state of the item.
1688
1826
  *
1689
1827
  * @example
1690
- * ```html-no-run
1828
+ * ```html
1691
1829
  * <kendo-listview>
1692
1830
  * <ng-template kendoListViewEditTemplate let-isNew="isNew">
1693
1831
  * <button kendoListViewCancelCommand>{{isNew ? 'Discard' : 'Cancel changes'}}</button>
@@ -1752,14 +1890,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1752
1890
  }] } });
1753
1891
 
1754
1892
  /**
1755
- * Represents the `remove` command of the ListView. You can apply this directive to any `button` element
1893
+ * Represents the remove command button directive of the Kendo UI ListView for Angular.
1894
+ * Provides the `remove` command of the ListView. You can apply this directive to any `button` element
1756
1895
  * inside a [`EditTemplateDirective`]({% slug api_listview_edittemplatedirective %}) template.
1757
- * When an associated button with the directive is clicked, the
1758
- * [`remove` event]({% slug api_listview_listviewcomponent %}#toc-remove)
1759
- * is triggered ([see example]({% slug editing_listview %})).
1896
+ * When you click an associated button with the directive, the
1897
+ * [`remove`]({% slug api_listview_listviewcomponent %}#toc-remove) event
1898
+ * triggers ([see example]({% slug editing_listview %})).
1760
1899
  *
1761
1900
  * @example
1762
- * ```html-no-run
1901
+ * ```html
1763
1902
  * <kendo-listview>
1764
1903
  * <ng-template kendoListViewEditTemplate>
1765
1904
  * <button kendoListViewRemoveCommand>Remove item</button>