@progress/kendo-angular-pager 19.1.1 → 19.1.2-develop.2

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 (30) hide show
  1. package/esm2022/package-metadata.mjs +2 -2
  2. package/esm2022/pager/focusable.directive.mjs +10 -1
  3. package/esm2022/pager/localization/custom-messages.component.mjs +12 -1
  4. package/esm2022/pager/pager-info.component.mjs +10 -1
  5. package/esm2022/pager/pager-input.component.mjs +14 -9
  6. package/esm2022/pager/pager-next-buttons.component.mjs +12 -7
  7. package/esm2022/pager/pager-numeric-buttons.component.mjs +12 -7
  8. package/esm2022/pager/pager-page-sizes.component.mjs +20 -121
  9. package/esm2022/pager/pager-prev-buttons.component.mjs +12 -7
  10. package/esm2022/pager/pager-template.directive.mjs +10 -30
  11. package/esm2022/pager/pager.component.mjs +52 -22
  12. package/esm2022/pager/pagesizechange-event.mjs +3 -3
  13. package/esm2022/pager/spacer.component.mjs +25 -4
  14. package/fesm2022/progress-kendo-angular-pager.mjs +194 -215
  15. package/package.json +8 -8
  16. package/pager/common/pager-type.d.ts +5 -7
  17. package/pager/focusable.directive.d.ts +10 -1
  18. package/pager/localization/custom-messages.component.d.ts +12 -1
  19. package/pager/pager-info.component.d.ts +10 -1
  20. package/pager/pager-input.component.d.ts +12 -7
  21. package/pager/pager-next-buttons.component.d.ts +12 -7
  22. package/pager/pager-numeric-buttons.component.d.ts +12 -7
  23. package/pager/pager-page-sizes.component.d.ts +20 -121
  24. package/pager/pager-prev-buttons.component.d.ts +12 -7
  25. package/pager/pager-template.directive.d.ts +10 -30
  26. package/pager/pager.component.d.ts +24 -22
  27. package/pager/pagesize-item.interface.d.ts +3 -3
  28. package/pager/pagesizechange-event.d.ts +3 -3
  29. package/pager/spacer.component.d.ts +25 -4
  30. package/schematics/ngAdd/index.js +6 -6
@@ -11,7 +11,7 @@ import { caretAltLeftIcon, caretAltToLeftIcon, caretAltRightIcon, caretAltToRigh
11
11
  import { isDocumentAvailable, isFocusable, Keys, EventsOutsideAngularDirective, anyChanged, isChanged, ResizeSensorComponent, isPresent, ResizeBatchService } from '@progress/kendo-angular-common';
12
12
  import { ButtonComponent } from '@progress/kendo-angular-buttons';
13
13
  import { DropDownListComponent } from '@progress/kendo-angular-dropdowns';
14
- import { NgIf, NgFor, NgClass, NgTemplateOutlet, NgStyle } from '@angular/common';
14
+ import { NgIf, NgFor, NgTemplateOutlet, NgStyle } from '@angular/common';
15
15
  import { NumericTextBoxComponent } from '@progress/kendo-angular-inputs';
16
16
  import { validatePackage } from '@progress/kendo-licensing';
17
17
  import { take } from 'rxjs/operators';
@@ -41,12 +41,12 @@ class PreventableEvent {
41
41
  }
42
42
 
43
43
  /**
44
- * Arguments for the `pageSizeChange` event. The `pageSizeChange` event fires when the page size
45
- * is changed from the UI. If you cancel the event, the change is prevented.
44
+ * Represents the arguments for the `pageSizeChange` event. The `pageSizeChange` event fires when you change the page size
45
+ * from the UI. If you cancel the event, the change does not occur.
46
46
  */
47
47
  class PageSizeChangeEvent extends PreventableEvent {
48
48
  /**
49
- * The newly selected page size.
49
+ * Gets the newly selected page size.
50
50
  */
51
51
  newPageSize;
52
52
  /**
@@ -155,8 +155,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
155
155
  }] } });
156
156
 
157
157
  /**
158
- * Custom component messages override default component messages
158
+ * Represents the Kendo UI Pager custom messages component for Angular. Use this component to override default component messages
159
159
  * ([see example]({% slug pager_globalization %}#toc-messages)).
160
+ *
161
+ * @example
162
+ * ```html
163
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
164
+ * <kendo-pager-messages
165
+ * previousNext="Previous/Next"
166
+ * page="Page"
167
+ * of="of">
168
+ * </kendo-pager-messages>
169
+ * </kendo-pager>
170
+ * ```
160
171
  */
161
172
  class CustomMessagesComponent extends Messages {
162
173
  service;
@@ -512,7 +523,16 @@ class PagerNavigationService {
512
523
  }
513
524
 
514
525
  /**
515
- * Place the directive on custom focusable elements in the [`kendoPagerTemplate`]({% slug api_pager_pagertemplatedirective %}) to include them in the built-in Pager keyboard navigation.
526
+ * Represents the Kendo UI Pager focusable directive for Angular. Apply this directive to custom focusable elements in the [`kendoPagerTemplate`]({% slug api_pager_pagertemplatedirective %}) to include them in the built-in Pager keyboard navigation.
527
+ *
528
+ * @example
529
+ * ```html
530
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
531
+ * <ng-template kendoPagerTemplate>
532
+ * <button kendoPagerFocusable type="button">Custom Button</button>
533
+ * </ng-template>
534
+ * </kendo-pager>
535
+ * ```
516
536
  */
517
537
  class PagerFocusableDirective {
518
538
  navigationService;
@@ -563,20 +583,25 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
563
583
 
564
584
  // eslint-disable no-access-missing-member
565
585
  /**
566
- * Displays buttons for navigating to the first and to the previous page ([see example]({% slug pager_settings %})).
586
+ * Represents the Kendo UI Pager Previous Buttons component for Angular. Displays buttons for navigating to the first and to the previous page ([see example]({% slug pager_settings %})).
587
+ *
588
+ * @example
589
+ * ```html
590
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
591
+ * <ng-template kendoPagerTemplate>
592
+ * <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
593
+ * </ng-template>
594
+ * </kendo-pager>
595
+ * ```
567
596
  */
568
597
  class PagerPrevButtonsComponent extends PagerElementComponent {
569
598
  constructor(localization, pagerContext, cd) {
570
599
  super(localization, pagerContext, cd);
571
600
  }
572
601
  /**
573
- * Specifies the padding of the buttons.
602
+ * Specifies the padding of the navigation buttons.
574
603
  *
575
- * The possible values are:
576
- * * `small`
577
- * * `medium` (default)
578
- * * `large`
579
- * * `none`
604
+ * @default 'medium'
580
605
  */
581
606
  size = DEFAULT_SIZE;
582
607
  /**
@@ -684,7 +709,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
684
709
  }] } });
685
710
 
686
711
  /**
687
- * Displays a drop-down list for the page size selection ([see example]({% slug pager_settings %})).
712
+ * Represents the Kendo UI Pager Page Sizes component for Angular. Displays a drop-down list for the page size selection ([see example]({% slug pager_settings %})).
713
+ *
714
+ * @example
715
+ * ```html
716
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
717
+ * <ng-template kendoPagerTemplate>
718
+ * <kendo-pager-page-sizes [pageSizes]="[10, 20, 50]"></kendo-pager-page-sizes>
719
+ * </ng-template>
720
+ * </kendo-pager>
721
+ * ```
688
722
  */
689
723
  class PagerPageSizesComponent extends PagerElementComponent {
690
724
  pagerContext;
@@ -704,122 +738,16 @@ class PagerPageSizesComponent extends PagerElementComponent {
704
738
  this.cd.markForCheck();
705
739
  }
706
740
  /**
707
- * The page sizes collection. Can contain numbers and [PageSizeItem]({% slug api_pager_pagesizeitem %}) objects.
741
+ * Specifies the page sizes collection. You can include numbers and [`PageSizeItem`]({% slug api_pager_pagesizeitem %}) objects.
708
742
  *
709
743
  * @example
710
- *
711
- * ```ts-preview
712
- * _@Component({
713
- * selector: 'my-app',
714
- * template: `
715
- * <div *ngFor="let item of pagedData" style="border: 1px solid black; padding: 10px;">
716
- * <span>{{item.ProductID}}. </span>
717
- * <span>{{item.ProductName}}</span>
718
- * </div>
719
- * <kendo-pager
720
- * [skip]="skip"
721
- * [pageSize]="pageSize"
722
- * [total]="total"
723
- * (pageChange)="onPageChange($event)">
724
- * <ng-template kendoPagerTemplate>
725
- * <kendo-pager-page-sizes [pageSizes]="pagesizes"></kendo-pager-page-sizes>
726
- * </ng-template>
727
- * </kendo-pager>
728
- * `
729
- * })
730
- * class AppComponent {
731
- * public data: any[] = products;
732
- * public pagedData = [];
733
- * public skip = 0;
734
- * public pageSize = 2;
735
- * public total = products.length;
736
- * public pagesizes = [{text: 'One', value: 1}, {text: 'Two', value: 2}, {text: 'All', value : 'all'}];
737
- *
738
- * public ngOnInit() {
739
- * this.pageData();
740
- * }
741
- *
742
- * public onPageChange(e) {
743
- * this.skip = e.skip;
744
- * this.pageSize = e.take;
745
- * this.pageData();
746
- * }
747
- *
748
- * private pageData() {
749
- * this.pagedData = this.data.slice(this.skip, this.skip + this.pageSize);
750
- * }
751
- * }
752
- *
753
- * const products = [{
754
- * 'ProductID' : 1,
755
- * 'ProductName' : "Chai",
756
- * 'SupplierID' : 1,
757
- * 'CategoryID' : 1,
758
- * 'QuantityPerUnit' : "10 boxes x 20 bags",
759
- * 'UnitPrice' : 18.0000,
760
- * 'UnitsInStock' : 39,
761
- * 'UnitsOnOrder' : 0,
762
- * 'ReorderLevel' : 10,
763
- * 'Discontinued' : false
764
- *
765
- * }, {
766
- * 'ProductID' : 2,
767
- * 'ProductName' : "Chang",
768
- * 'SupplierID' : 1,
769
- * 'CategoryID' : 1,
770
- * 'QuantityPerUnit' : "24 - 12 oz bottles",
771
- * 'UnitPrice' : 19.0000,
772
- * 'UnitsInStock' : 17,
773
- * 'UnitsOnOrder' : 40,
774
- * 'ReorderLevel' : 25,
775
- * 'Discontinued' : false
776
- * }, {
777
- * 'ProductID' : 3,
778
- * 'ProductName' : "Aniseed Syrup",
779
- * 'SupplierID' : 1,
780
- * 'CategoryID' : 2,
781
- * 'QuantityPerUnit' : "12 - 550 ml bottles",
782
- * 'UnitPrice' : 10.0000,
783
- * 'UnitsInStock' : 13,
784
- * 'UnitsOnOrder' : 70,
785
- * 'ReorderLevel' : 25,
786
- * 'Discontinued' : false
787
- * }, {
788
- * 'ProductID' : 4,
789
- * 'ProductName' : "Chef Anton\'s Cajun Seasoning",
790
- * 'SupplierID' : 2,
791
- * 'CategoryID' : 2,
792
- * 'QuantityPerUnit' : "48 - 6 oz jars",
793
- * 'UnitPrice' : 22.0000,
794
- * 'UnitsInStock' : 53,
795
- * 'UnitsOnOrder' : 0,
796
- * 'ReorderLevel' : 0,
797
- * 'Discontinued' : false
798
- * }, {
799
- * 'ProductID' : 5,
800
- * 'ProductName' : "Chef Anton\'s Gumbo Mix",
801
- * 'SupplierID' : 2,
802
- * 'CategoryID' : 2,
803
- * 'QuantityPerUnit' : "36 boxes",
804
- * 'UnitPrice' : 21.3500,
805
- * 'UnitsInStock' : 0,
806
- * 'UnitsOnOrder' : 0,
807
- * 'ReorderLevel' : 0,
808
- * 'Discontinued' : true
809
- * }, {
810
- * 'ProductID' : 6,
811
- * 'ProductName' : "Grandma\'s Boysenberry Spread",
812
- * 'SupplierID' : 3,
813
- * 'CategoryID' : 2,
814
- * 'QuantityPerUnit' : "12 - 8 oz jars",
815
- * 'UnitPrice' : 25.0000,
816
- * 'UnitsInStock' : 120,
817
- * 'UnitsOnOrder' : 0,
818
- * 'ReorderLevel' : 25,
819
- * 'Discontinued' : false
820
- * }];
744
+ * ```html
745
+ * <kendo-pager [skip]="0" [pageSize]="10" [total]="100">
746
+ * <ng-template kendoPagerTemplate>
747
+ * <kendo-pager-page-sizes [pageSizes]="[5, 10, 20, { text: 'All', value: 'all' }]"></kendo-pager-page-sizes>
748
+ * </ng-template>
749
+ * </kendo-pager>
821
750
  * ```
822
- *
823
751
  */
824
752
  set pageSizes(pageSizes) {
825
753
  let normalizedItems = [];
@@ -845,17 +773,13 @@ class PagerPageSizesComponent extends PagerElementComponent {
845
773
  this._pageSizes = normalizedItems;
846
774
  }
847
775
  /**
848
- * Specifies the padding of the dropdown.
776
+ * Specifies the padding of the DropDownList component.
849
777
  *
850
- * The possible values are:
851
- * * `small`
852
- * * `medium` (default)
853
- * * `large`
854
- * * `none`
778
+ * @default 'medium'
855
779
  */
856
780
  size = DEFAULT_SIZE;
857
781
  /**
858
- * Toggles the adaptiveness of the internal DropDownList.
782
+ * Specifies the adaptive mode of the internal `DropDownList` component.
859
783
  *
860
784
  * @default 'auto'
861
785
  */
@@ -960,10 +884,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
960
884
  }] } });
961
885
 
962
886
  /**
963
- * Represents the pager template which helps to customize the pager appearance. To define a pager
964
- * template, nest an `<ng-template>` tag with the `kendoPagerTemplate` directive inside `<kendo-pager>`.
887
+ * Represents the Kendo UI Pager template directive for Angular.
888
+ * Use this directive to customize the Pager appearance. To define a Pager template, nest an `<ng-template>` tag with the `kendoPagerTemplate` directive inside `<kendo-pager>`.
965
889
  *
966
890
  * The template context provides the following fields:
891
+ *
967
892
  * * `currentPage`&mdash;The index of the displayed page.
968
893
  * * `pageSize`&mdash;The value of the current `pageSize`.
969
894
  * * `skip`&mdash;The current skip value.
@@ -971,34 +896,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
971
896
  * * `totalPages`&mdash;The total number of available pages.
972
897
  *
973
898
  * @example
974
- * ```ts-preview
975
- *
976
- * _@Component({
977
- * selector: 'my-app',
978
- * template: `
979
- * <kendo-pager [total]="total" [pageSize]="pageSize" [skip]="skip" (pageChange)="onPageChange($event)">
980
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
981
- * <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
982
- * <kendo-pager-numeric-buttons [buttonCount]="10"></kendo-pager-numeric-buttons>
983
- * <kendo-pager-next-buttons></kendo-pager-next-buttons>
984
- * <kendo-pager-info></kendo-pager-info>
985
- * Current page: {{currentPage}}
986
- * </ng-template>
987
- * </kendo-pager>
988
- * `
989
- * })
990
- *
991
- * class AppComponent {
992
- * public skip = 0;
993
- * public pageSize = 10;
994
- * public total = 100;
995
- *
996
- * public onPageChange(e: any): void {
997
- * this.skip = e.skip;
998
- * this.pageSize = e.take;
999
- * }
1000
- * }
1001
- *
899
+ * ```html
900
+ * <kendo-pager [skip]="0" [pageSize]="10" [total]="100">
901
+ * <ng-template kendoPagerTemplate let-currentPage="currentPage" let-pageSize="pageSize" let-skip="skip" let-total="total" let-totalPages="totalPages">
902
+ * <span>Page {{currentPage}} of {{totalPages}}</span>
903
+ * <span>Items per page: {{pageSize}}</span>
904
+ * </ng-template>
905
+ * </kendo-pager>
1002
906
  * ```
1003
907
  */
1004
908
  class PagerTemplateDirective {
@@ -1020,7 +924,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1020
924
  }] }]; } });
1021
925
 
1022
926
  /**
1023
- * Displays numeric buttons to enable navigation between the pages.
927
+ * Represents the Kendo UI Pager Numeric Buttons component for Angular. Displays numeric buttons to enable navigation between the pages.
928
+ *
929
+ * @example
930
+ * ```html
931
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
932
+ * <ng-template kendoPagerTemplate>
933
+ * <kendo-pager-numeric-buttons [buttonCount]="5"></kendo-pager-numeric-buttons>
934
+ * </ng-template>
935
+ * </kendo-pager>
936
+ * ```
1024
937
  */
1025
938
  class PagerNumericButtonsComponent extends PagerElementComponent {
1026
939
  pagerContext;
@@ -1028,7 +941,7 @@ class PagerNumericButtonsComponent extends PagerElementComponent {
1028
941
  selectElement;
1029
942
  numbersElement;
1030
943
  /**
1031
- * The count of the displayed buttons.
944
+ * Specifies the count of the displayed buttons.
1032
945
  *
1033
946
  * @type {number}
1034
947
  * @memberOf PagerNumericButtonsComponent
@@ -1037,11 +950,7 @@ class PagerNumericButtonsComponent extends PagerElementComponent {
1037
950
  /**
1038
951
  * Specifies the padding of the numeric buttons.
1039
952
  *
1040
- * The possible values are:
1041
- * * `small`
1042
- * * `medium` (default)
1043
- * * `large`
1044
- * * `none`
953
+ * @default 'medium'
1045
954
  */
1046
955
  set size(size) {
1047
956
  const newSize = size ? size : DEFAULT_SIZE;
@@ -1248,7 +1157,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1248
1157
 
1249
1158
  // eslint-disable no-access-missing-member
1250
1159
  /**
1251
- * Displays buttons for navigating to the next and to the last page ([see example]({% slug pager_settings %})).
1160
+ * Represents the Kendo UI Pager Next Buttons component for Angular. Displays buttons for navigating to the next and to the last page ([see example]({% slug pager_settings %})).
1161
+ *
1162
+ * @example
1163
+ * ```html
1164
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
1165
+ * <ng-template kendoPagerTemplate>
1166
+ * <kendo-pager-next-buttons></kendo-pager-next-buttons>
1167
+ * </ng-template>
1168
+ * </kendo-pager>
1169
+ * ```
1252
1170
  */
1253
1171
  class PagerNextButtonsComponent extends PagerElementComponent {
1254
1172
  /**
@@ -1262,13 +1180,9 @@ class PagerNextButtonsComponent extends PagerElementComponent {
1262
1180
  return this.currentPage === this.totalPages || !this.total;
1263
1181
  }
1264
1182
  /**
1265
- * Specifies the padding of the buttons.
1183
+ * Specifies the padding of the navigation buttons.
1266
1184
  *
1267
- * The possible values are:
1268
- * * `small`
1269
- * * `medium` (default)
1270
- * * `large`
1271
- * * `none`
1185
+ * @default 'medium'
1272
1186
  */
1273
1187
  size = DEFAULT_SIZE;
1274
1188
  constructor(localization, pagerContext, cd) {
@@ -1365,7 +1279,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1365
1279
  }] } });
1366
1280
 
1367
1281
  /**
1368
- * Displays an input element which allows the typing and rendering of page numbers.
1282
+ * Represents the Kendo UI Pager Input component for Angular. Displays an input element which allows you to type and render page numbers.
1283
+ *
1284
+ * @example
1285
+ * ```html
1286
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
1287
+ * <ng-template kendoPagerTemplate>
1288
+ * <kendo-pager-input></kendo-pager-input>
1289
+ * </ng-template>
1290
+ * </kendo-pager>
1291
+ * ```
1369
1292
  */
1370
1293
  class PagerInputComponent extends PagerElementComponent {
1371
1294
  pagerContext;
@@ -1378,13 +1301,9 @@ class PagerInputComponent extends PagerElementComponent {
1378
1301
  */
1379
1302
  showPageText = true;
1380
1303
  /**
1381
- * Specifies the padding of the internal numeric input element.
1304
+ * Specifies the padding of the internal `NumericTextBox` component.
1382
1305
  *
1383
- * The possible values are:
1384
- * * `small`
1385
- * * `medium` (default)
1386
- * * `large`
1387
- * * `none`
1306
+ * @default 'medium'
1388
1307
  */
1389
1308
  size = DEFAULT_SIZE;
1390
1309
  constructor(localization, pagerContext, zone, cd, renderer) {
@@ -1506,7 +1425,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1506
1425
  </span>
1507
1426
  `,
1508
1427
  standalone: true,
1509
- imports: [NgClass, NgIf, NumericTextBoxComponent, PagerFocusableDirective, EventsOutsideAngularDirective]
1428
+ imports: [NgIf, NumericTextBoxComponent, PagerFocusableDirective, EventsOutsideAngularDirective]
1510
1429
  }]
1511
1430
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: PagerContextService }, { type: i0.NgZone }, { type: i0.ChangeDetectorRef }, { type: i0.Renderer2 }]; }, propDecorators: { numericInput: [{
1512
1431
  type: ViewChild,
@@ -1519,7 +1438,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1519
1438
 
1520
1439
  // eslint-disable no-access-missing-member
1521
1440
  /**
1522
- * Displays information about the current page and the total number of records ([see example]({% slug pager_settings %})).
1441
+ * Represents the Kendo UI Pager Info component for Angular. Displays information about the current page and the total number of records ([see example]({% slug pager_settings %})).
1442
+ *
1443
+ * @example
1444
+ * ```html
1445
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
1446
+ * <ng-template kendoPagerTemplate>
1447
+ * <kendo-pager-info></kendo-pager-info>
1448
+ * </ng-template>
1449
+ * </kendo-pager>
1450
+ * ```
1523
1451
  */
1524
1452
  class PagerInfoComponent extends PagerElementComponent {
1525
1453
  /**
@@ -1585,11 +1513,39 @@ const packageMetadata = {
1585
1513
  productName: 'Kendo UI for Angular',
1586
1514
  productCode: 'KENDOUIANGULAR',
1587
1515
  productCodes: ['KENDOUIANGULAR'],
1588
- publishDate: 1749540168,
1589
- version: '19.1.1',
1516
+ publishDate: 1749820512,
1517
+ version: '19.1.2-develop.2',
1590
1518
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
1591
1519
  };
1592
1520
 
1521
+ /**
1522
+ * Represents the Kendo UI Pager component for Angular.
1523
+ * Enables you to split a set of data into pages, providing a flexible and intuitive UI.
1524
+ *
1525
+ * @example
1526
+ * ```ts
1527
+ * @Component({
1528
+ * selector: 'my-app',
1529
+ * template: `
1530
+ * <kendo-pager
1531
+ * [total]="total"
1532
+ * [skip]="skip"
1533
+ * [pageSize]="pageSize"
1534
+ * (pageChange)="onPageChange($event)">
1535
+ * </kendo-pager>
1536
+ * `
1537
+ * })
1538
+ * export class AppComponent {
1539
+ * public total = 200;
1540
+ * public skip = 0;
1541
+ * public pageSize = 10;
1542
+ *
1543
+ * public onPageChange(event: PageChangeEvent) {
1544
+ * this.skip = event.skip;
1545
+ * }
1546
+ * }
1547
+ * ```
1548
+ */
1593
1549
  class PagerComponent {
1594
1550
  pagerContext;
1595
1551
  element;
@@ -1598,6 +1554,9 @@ class PagerComponent {
1598
1554
  ngZone;
1599
1555
  cdr;
1600
1556
  navigationService;
1557
+ /**
1558
+ * Represents the collection of pager template directives.
1559
+ */
1601
1560
  template;
1602
1561
  set numericButtons(buttons) {
1603
1562
  const newWidth = buttons ? buttons.nativeElement?.offsetWidth : 0;
@@ -1624,42 +1583,42 @@ class PagerComponent {
1624
1583
  */
1625
1584
  externalTemplate;
1626
1585
  /**
1627
- * Represents the total number of data items in the collection.
1586
+ * Specifies the total number of data items in the collection.
1628
1587
  *
1629
1588
  * @default 0
1630
1589
  */
1631
1590
  total = 0;
1632
1591
  /**
1633
- * Defines the number of data items to be skipped.
1592
+ * Specifies the number of data items to skip.
1634
1593
  *
1635
1594
  * @default 0
1636
1595
  */
1637
1596
  skip = 0;
1638
1597
  /**
1639
- * Defines the number of data items per page.
1598
+ * Specifies the number of data items per page.
1640
1599
  */
1641
1600
  pageSize;
1642
1601
  /**
1643
- * Sets the maximum numeric buttons count before the buttons are collapsed.
1602
+ * Specifies the maximum number of numeric buttons before the buttons are collapsed.
1644
1603
  *
1645
1604
  * @default 10
1646
1605
  */
1647
1606
  buttonCount = 10;
1648
1607
  /**
1649
- * Toggles the information about the current page and the total number of records.
1608
+ * Determines whether to display information about the current page and the total number of records.
1650
1609
  *
1651
1610
  * @default true
1652
1611
  */
1653
1612
  info = true;
1654
1613
  /**
1655
- * Defines the type of the pager.
1614
+ * Specifies the type of the Pager.
1656
1615
  *
1657
1616
  * @default 'numeric'
1658
1617
  */
1659
1618
  type = 'numeric';
1660
1619
  /**
1661
- * Shows a dropdown for selecting the page size.
1662
- * When set to `true`, the dropdown will contain the default list of options - 5, 10, 20.
1620
+ * Displays a dropdown for selecting the page size.
1621
+ * When set to `true`, the dropdown contains the default list of options - 5, 10, 20.
1663
1622
  * To customize the list of options, set `pageSizeValues` to an array of the desired values.
1664
1623
  * The array can contain numbers and [PageSizeItem]({% slug api_pager_pagesizeitem %}) objects.
1665
1624
  */
@@ -1675,13 +1634,13 @@ class PagerComponent {
1675
1634
  return this._pageSizeValues;
1676
1635
  }
1677
1636
  /**
1678
- * Toggles the **Previous** and **Next** buttons.
1637
+ * Determines whether to display the **Previous** and **Next** buttons.
1679
1638
  *
1680
1639
  * @default true
1681
1640
  */
1682
1641
  previousNext = true;
1683
1642
  /**
1684
- * If set to `true`, the user can use dedicated shortcuts to interact with the Pager ([see example]({% slug keyboard_navigation_pager %})).
1643
+ * Determines whether users can use dedicated shortcuts to interact with the Pager ([see example]({% slug keyboard_navigation_pager %})).
1685
1644
  * By default, navigation is enabled. To disable it and make the Pager content accessible in the normal tab sequence, set the property to `false`.
1686
1645
  * @default true
1687
1646
  */
@@ -1695,11 +1654,7 @@ class PagerComponent {
1695
1654
  /**
1696
1655
  * Specifies the padding of all Pager elements.
1697
1656
  *
1698
- * The possible values are:
1699
- * * `small`
1700
- * * `medium` (default)
1701
- * * `large`
1702
- * * `none`
1657
+ * @default 'medium'
1703
1658
  */
1704
1659
  set size(size) {
1705
1660
  const newSize = size ? size : DEFAULT_SIZE;
@@ -1710,26 +1665,26 @@ class PagerComponent {
1710
1665
  return this._size;
1711
1666
  }
1712
1667
  /**
1713
- * Toggles the Pager responsive functionality ([see example](slug:responsive_pager)).
1668
+ * Determines whether the Pager responsive functionality is enabled ([see example](slug:responsive_pager)).
1714
1669
  *
1715
1670
  * @default true
1716
1671
  */
1717
1672
  responsive = true;
1718
1673
  /**
1719
- * Toggles the Pager adaptiveness functionality ([see example](slug:adaptive_mode_pager)).
1674
+ * Determines whether the Pager adaptiveness functionality is enabled ([see example](slug:adaptive_mode_pager)).
1720
1675
  *
1721
1676
  * @default 'auto'
1722
1677
  */
1723
1678
  adaptiveMode = 'auto';
1724
1679
  /**
1725
- * Fires when the current page of the Pager is changed ([see example](slug:overview_pager)).
1726
- * You have to handle the event yourself and page the data.
1680
+ * Fires when the current page of the Pager changes ([see example](slug:overview_pager)).
1681
+ * You have to handle the event and page the data.
1727
1682
  */
1728
1683
  pageChange = new EventEmitter();
1729
1684
  /**
1730
- * Fires when the page size of the Pager is changed.
1731
- * You have to handle the event yourself and page the data.
1732
- * If the event is prevented, the page size will remain unchanged ([see example]({% slug pager_events %})).
1685
+ * Fires when the page size of the Pager changes.
1686
+ * You have to handle the event and page the data.
1687
+ * If the event is prevented, the page size remains unchanged ([see example]({% slug pager_events %})).
1733
1688
  */
1734
1689
  pageSizeChange = new EventEmitter();
1735
1690
  /**
@@ -1876,6 +1831,9 @@ class PagerComponent {
1876
1831
  });
1877
1832
  }
1878
1833
  }
1834
+ /**
1835
+ * Gets the maximum number of items displayed on the current page.
1836
+ */
1879
1837
  get maxItems() {
1880
1838
  return Math.min(this.currentPage * this.pageSize, this.total);
1881
1839
  }
@@ -2515,23 +2473,44 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2515
2473
  }] } });
2516
2474
 
2517
2475
  /**
2518
- * Represents the Kendo UI PagerSpacer component for Angular.
2519
- * Used to give additional white space between the Pager inner elements,
2476
+ * Represents the Kendo UI Pager Spacer component for Angular.
2477
+ * Gives you additional white space between the Pager inner elements,
2520
2478
  * and provides a way for customizing the spacer width.
2479
+ *
2480
+ * @example
2481
+ * ```html
2482
+ * <kendo-pager [skip]="skip" [pageSize]="pageSize" [total]="total">
2483
+ * <ng-template kendoPagerTemplate>
2484
+ * <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
2485
+ * <kendo-pager-info></kendo-pager-info>
2486
+ * <kendo-pager-spacer></kendo-pager-spacer>
2487
+ * <kendo-pager-next-buttons></kendo-pager-next-buttons>
2488
+ * </ng-template>
2489
+ * </kendo-pager>
2490
+ * ```
2521
2491
  */
2522
2492
  class PagerSpacerComponent {
2493
+ /**
2494
+ * Gets the CSS class for the spacer.
2495
+ */
2523
2496
  hostClass = true;
2497
+ /**
2498
+ * Gets the CSS class for sized spacers.
2499
+ */
2524
2500
  get sizedClass() {
2525
2501
  return isPresent(this.width);
2526
2502
  }
2503
+ /**
2504
+ * Gets the flex-basis style for the spacer width.
2505
+ */
2527
2506
  get flexBasisStyle() {
2528
2507
  return this.width;
2529
2508
  }
2530
2509
  /**
2531
- * Specifies the width of the PagerSpacer.
2510
+ * Specifies the width of the `PagerSpacer` component.
2532
2511
  * Accepts the [string values of the CSS `flex-basis` property](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis).
2533
2512
  *
2534
- * If not set, the PagerSpacer will take all the available space.
2513
+ * If you do not set this property, the `PagerSpacer` takes all the available space.
2535
2514
  */
2536
2515
  width;
2537
2516
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: PagerSpacerComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });