@progress/kendo-angular-layout 19.1.2-develop.3 → 19.1.2-develop.5

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 (197) hide show
  1. package/avatar/avatar.component.d.ts +43 -47
  2. package/avatar/l10n/custom-messages.component.d.ts +9 -1
  3. package/avatar/l10n/messages.d.ts +1 -1
  4. package/avatar/models/fill.d.ts +1 -1
  5. package/avatar/models/rounded.d.ts +1 -1
  6. package/avatar/models/size.d.ts +1 -1
  7. package/avatar/models/theme-color.d.ts +1 -1
  8. package/avatar.module.d.ts +14 -2
  9. package/card/card-actions.component.d.ts +16 -15
  10. package/card/card-body.component.d.ts +9 -1
  11. package/card/card-footer.component.d.ts +9 -1
  12. package/card/card-header.component.d.ts +10 -1
  13. package/card/card.component.d.ts +19 -6
  14. package/card/directives/card-media.directive.d.ts +10 -1
  15. package/card/directives/card-separator.directive.d.ts +10 -4
  16. package/card/directives/card-subtitle.directive.d.ts +8 -1
  17. package/card/directives/card-title.directive.d.ts +8 -1
  18. package/card/models/actions-layout.d.ts +1 -8
  19. package/card/models/card-action.d.ts +4 -4
  20. package/card.module.d.ts +14 -2
  21. package/codemods/utils.js +0 -3
  22. package/common/orientation.d.ts +1 -1
  23. package/common/preventable-event.d.ts +3 -6
  24. package/directives.d.ts +13 -13
  25. package/drawer/drawer-container.component.d.ts +13 -1
  26. package/drawer/drawer-content.component.d.ts +9 -1
  27. package/drawer/drawer.component.d.ts +48 -47
  28. package/drawer/events/select-event.d.ts +5 -5
  29. package/drawer/models/drawer-animation.interface.d.ts +1 -2
  30. package/drawer/models/drawer-item-expand.interface.d.ts +1 -1
  31. package/drawer/models/drawer-item.interface.d.ts +15 -17
  32. package/drawer/models/mode.d.ts +4 -3
  33. package/drawer/models/position.d.ts +1 -6
  34. package/drawer/template-directives/drawer-template.directive.d.ts +18 -5
  35. package/drawer/template-directives/footer-template.directive.d.ts +11 -3
  36. package/drawer/template-directives/header-template.directive.d.ts +11 -3
  37. package/drawer/template-directives/item-template.directive.d.ts +19 -3
  38. package/drawer.module.d.ts +14 -2
  39. package/esm2022/avatar/avatar.component.mjs +43 -47
  40. package/esm2022/avatar/l10n/custom-messages.component.mjs +9 -1
  41. package/esm2022/avatar/l10n/messages.mjs +1 -1
  42. package/esm2022/avatar.module.mjs +14 -2
  43. package/esm2022/card/card-actions.component.mjs +16 -15
  44. package/esm2022/card/card-body.component.mjs +9 -1
  45. package/esm2022/card/card-footer.component.mjs +9 -1
  46. package/esm2022/card/card-header.component.mjs +10 -1
  47. package/esm2022/card/card.component.mjs +19 -6
  48. package/esm2022/card/directives/card-media.directive.mjs +10 -1
  49. package/esm2022/card/directives/card-separator.directive.mjs +10 -4
  50. package/esm2022/card/directives/card-subtitle.directive.mjs +8 -1
  51. package/esm2022/card/directives/card-title.directive.mjs +8 -1
  52. package/esm2022/card/models/card-action.mjs +4 -4
  53. package/esm2022/card.module.mjs +14 -2
  54. package/esm2022/common/preventable-event.mjs +3 -6
  55. package/esm2022/directives.mjs +13 -13
  56. package/esm2022/drawer/drawer-container.component.mjs +13 -1
  57. package/esm2022/drawer/drawer-content.component.mjs +9 -1
  58. package/esm2022/drawer/drawer.component.mjs +48 -47
  59. package/esm2022/drawer/events/select-event.mjs +5 -5
  60. package/esm2022/drawer/template-directives/drawer-template.directive.mjs +18 -5
  61. package/esm2022/drawer/template-directives/footer-template.directive.mjs +11 -3
  62. package/esm2022/drawer/template-directives/header-template.directive.mjs +11 -3
  63. package/esm2022/drawer/template-directives/item-template.directive.mjs +19 -3
  64. package/esm2022/drawer.module.mjs +14 -2
  65. package/esm2022/expansionpanel/events/action-event.mjs +2 -2
  66. package/esm2022/expansionpanel/expansionpanel-title.directive.mjs +12 -3
  67. package/esm2022/expansionpanel/expansionpanel.component.mjs +20 -27
  68. package/esm2022/expansionpanel.module.mjs +14 -2
  69. package/esm2022/gridlayout.module.mjs +14 -2
  70. package/esm2022/layout.module.mjs +10 -21
  71. package/esm2022/layouts/grid-layout.component.mjs +24 -17
  72. package/esm2022/layouts/gridlayout-item.component.mjs +16 -4
  73. package/esm2022/layouts/stack-layout.component.mjs +15 -6
  74. package/esm2022/package-metadata.mjs +2 -2
  75. package/esm2022/panelbar/events/collapse-event.mjs +2 -2
  76. package/esm2022/panelbar/events/expand-event.mjs +2 -2
  77. package/esm2022/panelbar/events/item-click-event.mjs +3 -3
  78. package/esm2022/panelbar/events/select-event.mjs +2 -2
  79. package/esm2022/panelbar/events/state-change-event.mjs +2 -2
  80. package/esm2022/panelbar/panelbar-content.directive.mjs +12 -1
  81. package/esm2022/panelbar/panelbar-expand-mode.mjs +3 -4
  82. package/esm2022/panelbar/panelbar-item-template.directive.mjs +12 -1
  83. package/esm2022/panelbar/panelbar-item-title.directive.mjs +12 -19
  84. package/esm2022/panelbar/panelbar-item.component.mjs +26 -11
  85. package/esm2022/panelbar/panelbar.component.mjs +40 -17
  86. package/esm2022/panelbar.module.mjs +13 -8
  87. package/esm2022/splitter/splitter-pane.component.mjs +40 -20
  88. package/esm2022/splitter/splitter.component.mjs +25 -41
  89. package/esm2022/splitter.module.mjs +13 -5
  90. package/esm2022/stacklayout.module.mjs +14 -2
  91. package/esm2022/stepper/events/activate-event.mjs +5 -5
  92. package/esm2022/stepper/localization/custom-messages.component.mjs +9 -1
  93. package/esm2022/stepper/localization/messages.mjs +1 -1
  94. package/esm2022/stepper/stepper.component.mjs +32 -39
  95. package/esm2022/stepper/stepper.service.mjs +4 -4
  96. package/esm2022/stepper/template-directives/indicator-template.directive.mjs +10 -1
  97. package/esm2022/stepper/template-directives/label-template.directive.mjs +10 -1
  98. package/esm2022/stepper/template-directives/step-template.directive.mjs +12 -1
  99. package/esm2022/stepper.module.mjs +14 -2
  100. package/esm2022/tabstrip/directives/tab-content.directive.mjs +12 -24
  101. package/esm2022/tabstrip/directives/tab-title.directive.mjs +10 -29
  102. package/esm2022/tabstrip/events/select-event.mjs +3 -1
  103. package/esm2022/tabstrip/events/tabclose-event.mjs +2 -1
  104. package/esm2022/tabstrip/events/tabscroll-event.mjs +2 -2
  105. package/esm2022/tabstrip/localization/custom-messages.component.mjs +11 -2
  106. package/esm2022/tabstrip/localization/messages.mjs +3 -3
  107. package/esm2022/tabstrip/models/tabstrip-tab.component.mjs +30 -17
  108. package/esm2022/tabstrip/tabstrip.component.mjs +49 -37
  109. package/esm2022/tabstrip.module.mjs +13 -7
  110. package/esm2022/tilelayout/reorder-event.mjs +3 -2
  111. package/esm2022/tilelayout/resize-event.mjs +3 -2
  112. package/esm2022/tilelayout/tilelayout-item-body.component.mjs +10 -1
  113. package/esm2022/tilelayout/tilelayout-item-header.component.mjs +12 -2
  114. package/esm2022/tilelayout/tilelayout-item.component.mjs +20 -10
  115. package/esm2022/tilelayout/tilelayout.component.mjs +31 -26
  116. package/esm2022/tilelayout.module.mjs +13 -7
  117. package/esm2022/timeline/templates/timeline-card-actions.directive.mjs +11 -2
  118. package/esm2022/timeline/templates/timeline-card-body.directive.mjs +11 -2
  119. package/esm2022/timeline/templates/timeline-card-header.directive.mjs +12 -2
  120. package/esm2022/timeline/timeline.component.mjs +3 -0
  121. package/esm2022/timeline.module.mjs +13 -4
  122. package/expansionpanel/events/action-event.d.ts +3 -3
  123. package/expansionpanel/expansionpanel-title.directive.d.ts +12 -3
  124. package/expansionpanel/expansionpanel.component.d.ts +20 -27
  125. package/expansionpanel.module.d.ts +14 -2
  126. package/fesm2022/progress-kendo-angular-layout.mjs +1072 -641
  127. package/gridlayout.module.d.ts +14 -2
  128. package/layout.module.d.ts +10 -21
  129. package/layouts/grid-layout.component.d.ts +24 -17
  130. package/layouts/gridlayout-item.component.d.ts +16 -4
  131. package/layouts/models/gridlayout-gap-settings.d.ts +3 -3
  132. package/layouts/models/gridlayout-row-col-size.d.ts +4 -4
  133. package/layouts/models/layout-align-settings.d.ts +3 -3
  134. package/layouts/models/layout-horizontal-align.d.ts +1 -1
  135. package/layouts/models/layout-vertical-align.d.ts +1 -1
  136. package/layouts/stack-layout.component.d.ts +15 -6
  137. package/package.json +11 -10
  138. package/panelbar/events/collapse-event.d.ts +2 -2
  139. package/panelbar/events/expand-event.d.ts +2 -2
  140. package/panelbar/events/item-click-event.d.ts +3 -3
  141. package/panelbar/events/select-event.d.ts +2 -2
  142. package/panelbar/events/state-change-event.d.ts +2 -2
  143. package/panelbar/panelbar-content.directive.d.ts +12 -1
  144. package/panelbar/panelbar-expand-mode.d.ts +3 -4
  145. package/panelbar/panelbar-item-model.d.ts +6 -6
  146. package/panelbar/panelbar-item-template.directive.d.ts +12 -1
  147. package/panelbar/panelbar-item-title.directive.d.ts +12 -19
  148. package/panelbar/panelbar-item.component.d.ts +24 -9
  149. package/panelbar/panelbar.component.d.ts +40 -17
  150. package/panelbar.module.d.ts +13 -8
  151. package/splitter/splitter-pane.component.d.ts +40 -20
  152. package/splitter/splitter.component.d.ts +24 -40
  153. package/splitter.module.d.ts +13 -5
  154. package/stacklayout.module.d.ts +14 -2
  155. package/stepper/events/activate-event.d.ts +5 -5
  156. package/stepper/localization/custom-messages.component.d.ts +9 -1
  157. package/stepper/localization/messages.d.ts +1 -1
  158. package/stepper/models/orientation.d.ts +1 -3
  159. package/stepper/models/step-predicate.d.ts +5 -6
  160. package/stepper/models/step-type.d.ts +1 -4
  161. package/stepper/models/stepper-step.interface.d.ts +12 -12
  162. package/stepper/stepper.component.d.ts +32 -39
  163. package/stepper/template-directives/indicator-template.directive.d.ts +10 -1
  164. package/stepper/template-directives/label-template.directive.d.ts +10 -1
  165. package/stepper/template-directives/step-template.directive.d.ts +12 -1
  166. package/stepper.module.d.ts +14 -2
  167. package/tabstrip/directives/tab-content.directive.d.ts +12 -24
  168. package/tabstrip/directives/tab-title.directive.d.ts +10 -29
  169. package/tabstrip/events/select-event.d.ts +3 -1
  170. package/tabstrip/events/tabclose-event.d.ts +2 -1
  171. package/tabstrip/events/tabscroll-event.d.ts +2 -2
  172. package/tabstrip/localization/custom-messages.component.d.ts +11 -2
  173. package/tabstrip/localization/messages.d.ts +3 -3
  174. package/tabstrip/models/scroll-buttons-visibility.d.ts +1 -1
  175. package/tabstrip/models/scrollable-settings.d.ts +17 -22
  176. package/tabstrip/models/size.d.ts +1 -1
  177. package/tabstrip/models/tab-alignment.d.ts +1 -1
  178. package/tabstrip/models/tab-position.d.ts +1 -1
  179. package/tabstrip/models/tabstrip-tab.component.d.ts +30 -17
  180. package/tabstrip/tabstrip.component.d.ts +41 -29
  181. package/tabstrip.module.d.ts +13 -7
  182. package/tilelayout/models/flowmode.type.d.ts +7 -8
  183. package/tilelayout/models/gap.interface.d.ts +3 -5
  184. package/tilelayout/reorder-event.d.ts +3 -2
  185. package/tilelayout/resize-event.d.ts +3 -2
  186. package/tilelayout/tilelayout-item-body.component.d.ts +10 -1
  187. package/tilelayout/tilelayout-item-header.component.d.ts +12 -2
  188. package/tilelayout/tilelayout-item.component.d.ts +20 -10
  189. package/tilelayout/tilelayout.component.d.ts +31 -26
  190. package/tilelayout.module.d.ts +13 -7
  191. package/timeline/events/navigation-direction.d.ts +6 -0
  192. package/timeline/models/anchor-target.d.ts +6 -0
  193. package/timeline/templates/timeline-card-actions.directive.d.ts +11 -2
  194. package/timeline/templates/timeline-card-body.directive.d.ts +11 -2
  195. package/timeline/templates/timeline-card-header.directive.d.ts +12 -2
  196. package/timeline/timeline.component.d.ts +3 -0
  197. package/timeline.module.d.ts +13 -4
@@ -29,20 +29,19 @@ const packageMetadata = {
29
29
  productName: 'Kendo UI for Angular',
30
30
  productCode: 'KENDOUIANGULAR',
31
31
  productCodes: ['KENDOUIANGULAR'],
32
- publishDate: 1750152493,
33
- version: '19.1.2-develop.3',
32
+ publishDate: 1750430829,
33
+ version: '19.1.2-develop.5',
34
34
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/?utm_medium=product&utm_source=kendoangular&utm_campaign=kendo-ui-angular-purchase-license-keys-warning'
35
35
  };
36
36
 
37
37
  /**
38
- * Represents the expand modes of the PanelBar.
39
- * By default, the expand mode is set to `multiple`.
38
+ * Defines the expand modes of the PanelBar.
40
39
  */
41
40
  var PanelBarExpandMode;
42
41
  (function (PanelBarExpandMode) {
43
42
  /**
44
43
  * Allows you to expand only one item at a time.
45
- * When you expand an item, the item that was previously expanded is coll.
44
+ * When you expand an item, the item that was previously expanded is collapsed.
46
45
  */
47
46
  PanelBarExpandMode[PanelBarExpandMode["Single"] = 0] = "Single";
48
47
  /**
@@ -56,7 +55,7 @@ var PanelBarExpandMode;
56
55
  */
57
56
  PanelBarExpandMode[PanelBarExpandMode["Multiple"] = 2] = "Multiple";
58
57
  /**
59
- * By default, the expand mode is set to `multiple`.
58
+ * The default expand mode set to `multiple`.
60
59
  */
61
60
  PanelBarExpandMode[PanelBarExpandMode["Default"] = 2] = "Default";
62
61
  })(PanelBarExpandMode || (PanelBarExpandMode = {}));
@@ -109,8 +108,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
109
108
  }], ctorParameters: function () { return []; } });
110
109
 
111
110
  /**
112
- * Represents the content template of the declaratively initialized PanelBar items.
111
+ * Defines the content template of the declaratively initialized PanelBar items.
112
+ * To define the content template, nest an `<ng-template>` tag
113
+ * with the `kendoPanelBarContent` directive inside the `<kendo-panelbar-item>` tag.
113
114
  * The content can be expanded or collapsed through the item.
115
+ *
116
+ * @example
117
+ * ```html
118
+ * <kendo-panelbar-item title="Item">
119
+ * <div kendoPanelBarContent>
120
+ * <p>Item content goes here</p>
121
+ * </div>
122
+ * </kendo-panelbar-item>
123
+ * ```
114
124
  */
115
125
  class PanelBarContentDirective {
116
126
  templateRef;
@@ -129,29 +139,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
129
139
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
130
140
 
131
141
  /**
132
- * Represents the template directive of the PanelBar which helps to customize the item title
142
+ * Defines the template directive of the PanelBar which helps to customize the item title
133
143
  * ([more information and example]({% slug templates_panelbar %}#toc-customizing-the-appearance-of-the-title)).
144
+ * To define the template, nest an `<ng-template>` tag
145
+ * with the `kendoPanelBarItemTitle` directive inside the `<kendo-panelbar-item>` tag.
134
146
  *
135
- * > The `kendoPanelBarItemTitle` directive overrides the PanelBarItem [title]({% slug api_layout_panelbaritemcomponent %}#toc-title) option.
147
+ * The `kendoPanelBarItemTitle` directive overrides the PanelBarItem [title]({% slug api_layout_panelbaritemcomponent %}#toc-title) option.
136
148
  *
137
149
  * @example
138
- * ```ts-preview
139
- *
140
- * _@Component({
141
- * selector: 'my-app',
142
- * template: `
143
- * <kendo-panelbar>
144
- * <kendo-panelbar-item [expanded]="true">
145
- * <ng-template kendoPanelBarItemTitle>
146
- * Item Title
147
- * </ng-template>
148
- * </kendo-panelbar-item>
149
- * </kendo-panelbar>
150
- * `
151
- * })
152
- *
153
- * class AppComponent {}
154
- *
150
+ * ```html
151
+ * <kendo-panelbar>
152
+ * <kendo-panelbar-item [expanded]="true">
153
+ * <ng-template kendoPanelBarItemTitle>
154
+ * Item Title
155
+ * </ng-template>
156
+ * </kendo-panelbar-item>
157
+ * </kendo-panelbar>
155
158
  * ```
156
159
  */
157
160
  class PanelBarItemTitleDirective {
@@ -302,7 +305,14 @@ const closestItem = (target, targetAttr, scope) => closestInScope(target, hasIte
302
305
  */
303
306
  let nextId = 0;
304
307
  /**
305
- * Represents the items of the PanelBar.
308
+ * Represents the PanelBar item component for Angular. Defines the items of the PanelBar.
309
+ *
310
+ * @example
311
+ * ```html
312
+ * <kendo-panelbar-item title="Item 1" [expanded]="true">
313
+ * <kendo-panelbar-item title="Sub Item 1"></kendo-panelbar-item>
314
+ * </kendo-panelbar-item>
315
+ * ```
306
316
  */
307
317
  class PanelBarItemComponent {
308
318
  parent;
@@ -319,17 +329,21 @@ class PanelBarItemComponent {
319
329
  */
320
330
  id = `default-${nextId++}`;
321
331
  /**
322
- * Defines the icon that will be rendered next to the title ([see example]({% slug items_panelbar %}#toc-title-icons)).
332
+ * Defines the icon that renders next to the title ([see example]({% slug items_panelbar %}#toc-title-icons)).
333
+ *
334
+ * @default ''
323
335
  */
324
336
  icon = '';
325
337
  /**
326
- * Defines the icon that will be rendered next to the title by using a custom CSS class
338
+ * Defines the icon that renders next to the title by using a custom CSS class
327
339
  * ([see example]({% slug items_panelbar %}#toc-title-icons)).
340
+ *
341
+ * @default ''
328
342
  */
329
343
  iconClass = '';
330
344
  /**
331
- * Defines an SVGIcon to be rendered.
332
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
345
+ * Defines an SVG icon to render.
346
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
333
347
  */
334
348
  set svgIcon(icon) {
335
349
  if (isDevMode() && icon && this.icon && this.iconClass) {
@@ -341,12 +355,16 @@ class PanelBarItemComponent {
341
355
  return this._svgIcon;
342
356
  }
343
357
  /**
344
- * Defines the location of the image that will be displayed next to the title
358
+ * Defines the location of the image that displays next to the title
345
359
  * ([see example]({% slug items_panelbar %}#toc-title-images)).
360
+ *
361
+ * @default ''
346
362
  */
347
363
  imageUrl = '';
348
364
  /**
349
365
  * When set to `true`, disables a PanelBar item ([see example]({% slug items_panelbar %}#toc-disabled-state)).
366
+ *
367
+ * @default false
350
368
  */
351
369
  disabled = false;
352
370
  /**
@@ -365,13 +383,13 @@ class PanelBarItemComponent {
365
383
  }
366
384
  /**
367
385
  * Sets the selected state of a PanelBar item ([see example]({% slug items_panelbar %}#toc-selected-state)).
386
+ *
387
+ * @default false
368
388
  */
369
389
  selected = false;
370
390
  /**
371
391
  * Sets the content of the PanelBar item.
372
- * By design, it is used when the
373
- * [items]({% slug api_layout_panelbarcomponent %}#toc-items)
374
- * property of the PanelBar is set.
392
+ * It is used when the [`items`]({% slug api_layout_panelbarcomponent %}#toc-items) property of the PanelBar is set.
375
393
  */
376
394
  content;
377
395
  /**
@@ -637,7 +655,7 @@ class PanelBarItemComponent {
637
655
  >
638
656
  </kendo-icon-wrapper>
639
657
  </span>
640
- <div
658
+ <div
641
659
  #contentWrapper
642
660
  *ngIf="keepContent || (!disabled && expanded && (hasChildItems || hasContent))"
643
661
  [@toggle]="state"
@@ -791,7 +809,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
791
809
  >
792
810
  </kendo-icon-wrapper>
793
811
  </span>
794
- <div
812
+ <div
795
813
  #contentWrapper
796
814
  *ngIf="keepContent || (!disabled && expanded && (hasChildItems || hasContent))"
797
815
  [@toggle]="state"
@@ -948,7 +966,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
948
966
  }] } });
949
967
 
950
968
  /**
951
- * Represents the template directive of the PanelBar which helps to customize the item content.
969
+ * Defines the template directive of the PanelBar which helps to customize the item content.
970
+ * To define the template, nest an `<ng-template>` tag
971
+ * with the `kendoPanelBarItemTemplate` directive inside the `<kendo-panelbar>` tag.
972
+ *
973
+ * @example
974
+ * ```html
975
+ * <kendo-panelbar>
976
+ * <ng-template kendoPanelBarItemTemplate let-dataItem>
977
+ * <span>{{ dataItem.title }}</span>
978
+ * </ng-template>
979
+ * </kendo-panelbar>
980
+ * ```
952
981
  */
953
982
  class PanelBarItemTemplateDirective {
954
983
  templateRef;
@@ -975,18 +1004,15 @@ class PreventableEvent {
975
1004
  prevented = false;
976
1005
  /**
977
1006
  * Prevents the default action for a specified event.
978
- * In this way, the source component suppresses
979
- * the built-in behavior that follows the event.
1007
+ * The source component suppresses the built-in behavior that follows the event.
980
1008
  */
981
1009
  preventDefault() {
982
1010
  this.prevented = true;
983
1011
  }
984
1012
  /**
985
- * Returns `true` if the event was prevented
986
- * by any of its subscribers.
1013
+ * Returns `true` if the event was prevented by any of its subscribers.
987
1014
  *
988
- * @returns `true` if the default action was prevented.
989
- * Otherwise, returns `false`.
1015
+ * @returns `true` if the default action was prevented. Otherwise, returns `false`.
990
1016
  */
991
1017
  isDefaultPrevented() {
992
1018
  return this.prevented;
@@ -1000,61 +1026,81 @@ class PreventableEvent {
1000
1026
  }
1001
1027
 
1002
1028
  /**
1003
- * Arguments for the `collapse` event of the PanelBar.
1029
+ * Defines the arguments for the `collapse` event of the PanelBar.
1004
1030
  */
1005
1031
  class PanelBarCollapseEvent extends PreventableEvent {
1006
1032
  /**
1007
- * The item that will be collapsed.
1033
+ * Defines the item that will be collapsed.
1008
1034
  */
1009
1035
  item;
1010
1036
  }
1011
1037
 
1012
1038
  /**
1013
- * Arguments for the `expand` event of the PanelBar.
1039
+ * Defines the arguments for the `expand` event of the PanelBar.
1014
1040
  */
1015
1041
  class PanelBarExpandEvent extends PreventableEvent {
1016
1042
  /**
1017
- * The item that will be expanded.
1043
+ * Defines the item that will be expanded.
1018
1044
  */
1019
1045
  item;
1020
1046
  }
1021
1047
 
1022
1048
  /**
1023
- * Arguments for the `select` event of the PanelBar.
1049
+ * Defines the arguments for the `select` event of the PanelBar.
1024
1050
  */
1025
1051
  class PanelBarSelectEvent extends PreventableEvent {
1026
1052
  /**
1027
- * The item that will be selected.
1053
+ * Defines the item that will be selected.
1028
1054
  */
1029
1055
  item;
1030
1056
  }
1031
1057
 
1032
1058
  /**
1033
- * Arguments for the `stateChange` event of the PanelBar.
1059
+ * Defines the arguments for the `stateChange` event of the PanelBar.
1034
1060
  */
1035
1061
  class PanelBarStateChangeEvent {
1036
1062
  /**
1037
- * A collection of all modified items.
1063
+ * Defines a collection of all modified items.
1038
1064
  */
1039
1065
  items;
1040
1066
  }
1041
1067
 
1042
1068
  /**
1043
- * Arguments for the `itemClick` event of the PanelBar.
1069
+ * Defines the arguments for the `itemClick` event of the PanelBar.
1044
1070
  */
1045
1071
  class PanelBarItemClickEvent {
1046
1072
  /**
1047
- * The clicked item.
1073
+ * Defines the clicked item.
1048
1074
  */
1049
1075
  item;
1050
1076
  /**
1051
- * The DOM event that triggered the `itemClick` event.
1077
+ * Defines the DOM event that triggered the `itemClick` event.
1052
1078
  */
1053
1079
  originalEvent;
1054
1080
  }
1055
1081
 
1056
1082
  /**
1057
- * Represents the [Kendo UI PanelBar component for Angular]({% slug overview_panelbar %}).
1083
+ * Represents the Kendo UI PanelBar component for Angular.
1084
+ * Displays hierarchical data as an expandable and collapsible accordion-style interface ([see overview]({% slug overview_panelbar %})).
1085
+ *
1086
+ * @example
1087
+ * ```typescript
1088
+ * @Component({
1089
+ * selector: 'my-app',
1090
+ * template: `
1091
+ * <kendo-panelbar [items]="items" expandMode="single">
1092
+ * </kendo-panelbar>
1093
+ * `
1094
+ * })
1095
+ * class AppComponent {
1096
+ * items = [
1097
+ * { title: 'Item 1', expanded: true, content: 'Content 1' },
1098
+ * { title: 'Item 2', content: 'Content 2' }
1099
+ * ];
1100
+ * }
1101
+ * ```
1102
+ * @remarks
1103
+ * Supported children components are: {@link PanelBarItemComponent}.
1058
1104
  */
1059
1105
  // TODO: add styles as input prop
1060
1106
  class PanelBarComponent {
@@ -1062,31 +1108,33 @@ class PanelBarComponent {
1062
1108
  /**
1063
1109
  * Sets the expand mode of the PanelBar through the `PanelBarExpandMode` enum ([see example]({% slug expandmodes_panelbar %})).
1064
1110
  *
1065
- * The available modes are:
1066
- * - `"single"`&mdash;Expands only one item at a time. Expanding an item collapses the item that was previously expanded.
1067
- * - `"multiple"`&mdash;The default mode of the PanelBar.
1068
- * Expands more than one item at a time. Items can also be toggled.
1069
- * - `"full"`&mdash;Expands only one item at a time.
1070
- * The expanded area occupies the entire height of the PanelBar. Requires you to set the `height` property.
1111
+ * @default 'multiple
1071
1112
  */
1072
1113
  expandMode = PanelBarExpandMode.Default;
1073
1114
  /**
1074
1115
  * Allows the PanelBar to modify the selected state of the items.
1116
+ *
1117
+ * @default true
1075
1118
  */
1076
1119
  selectable = true;
1077
1120
  /**
1078
1121
  * Sets the animate state of the PanelBar ([see example]({% slug animations_panelbar %})).
1122
+ *
1123
+ * @default true
1079
1124
  */
1080
1125
  animate = true;
1081
1126
  /**
1082
1127
  * Sets the height of the component when the `"full"` expand mode is used.
1083
- * This option is ignored in the `"multiple"` and `"single"` expand modes.
1128
+ * This option is ignored when the `"multiple"` or `"single"` expand modes are used.
1129
+ *
1130
+ * @default '400px'
1084
1131
  */
1085
1132
  height = '400px';
1086
1133
  /**
1087
1134
  * When set to `true`, the PanelBar renders the content of all items and they are persisted in the DOM
1088
1135
  * ([see example]({% slug templates_panelbar %}#toc-collections)).
1089
- * By default, this option is set to `false`.
1136
+ *
1137
+ * @default false
1090
1138
  */
1091
1139
  get keepItemContent() {
1092
1140
  return this._keepItemContent;
@@ -1108,31 +1156,32 @@ class PanelBarComponent {
1108
1156
  return this._items;
1109
1157
  }
1110
1158
  /**
1111
- * Fires each time the user interacts with a PanelBar item
1159
+ * Fires when the state of the PanelBar changes.
1160
+ * This event is triggered when an item is selected, expanded, or collapsed.
1112
1161
  * ([see example](slug:routing_panelbar#using-router-service)).
1113
1162
  * The event data contains a collection of all items that are modified.
1114
1163
  */
1115
1164
  stateChange = new EventEmitter();
1116
1165
  /**
1117
1166
  * Fires when an item is about to be selected.
1118
- * ([see example]({% slug events_panelbar %}))
1119
- * This event is preventable. If you cancel it, the item will not be selected.
1167
+ * This event is preventable. If you cancel it, the item will not be selected
1168
+ * ([see example]({% slug events_panelbar %})).
1120
1169
  */
1121
1170
  select = new EventEmitter();
1122
1171
  /**
1123
1172
  * Fires when an item is about to be expanded.
1124
- * ([see example]({% slug events_panelbar %}))
1125
- * This event is preventable. If you cancel it, the item will remain collapsed.
1173
+ * This event is preventable. If you cancel it, the item will remain collapsed
1174
+ * ([see example]({% slug events_panelbar %})).
1126
1175
  */
1127
1176
  expand = new EventEmitter();
1128
1177
  /**
1129
1178
  * Fires when an item is about to be collapsed.
1130
- * ([see example]({% slug events_panelbar %}))
1131
- * This event is preventable. If you cancel it, the item will remain expanded.
1179
+ * This event is preventable. If you cancel it, the item will remain expanded
1180
+ * ([see example]({% slug events_panelbar %})).
1132
1181
  */
1133
1182
  collapse = new EventEmitter();
1134
1183
  /**
1135
- * Fires when the user clicks an item ([see example]({% slug events_panelbar %})).
1184
+ * Fires when an item is clicked ([see example]({% slug events_panelbar %})).
1136
1185
  */
1137
1186
  itemClick = new EventEmitter();
1138
1187
  hostClasses = true;
@@ -1906,6 +1955,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1906
1955
 
1907
1956
  /**
1908
1957
  * Represents the pane component of the Splitter.
1958
+ *
1959
+ * @example
1960
+ * ```html
1961
+ * <kendo-splitter>
1962
+ * <kendo-splitter-pane size="30%" [collapsible]="true">
1963
+ * Left pane content
1964
+ * </kendo-splitter-pane>
1965
+ * <kendo-splitter-pane>
1966
+ * Right pane content
1967
+ * </kendo-splitter-pane>
1968
+ * </kendo-splitter>
1969
+ * ```
1909
1970
  */
1910
1971
  class SplitterPaneComponent {
1911
1972
  element;
@@ -1923,9 +1984,9 @@ class SplitterPaneComponent {
1923
1984
  return this._order;
1924
1985
  }
1925
1986
  /**
1926
- * Sets the initial size of the pane.
1927
- * Accepts units in pixel and percentage values.
1928
- * Has to be between the `min` and `max` properties.
1987
+ * Defines the initial size of the pane.
1988
+ * Accepts values in pixels and percentages.
1989
+ * The value must be between the `min` and `max` properties.
1929
1990
  */
1930
1991
  set size(newSize) {
1931
1992
  this._size = newSize;
@@ -1937,9 +1998,9 @@ class SplitterPaneComponent {
1937
1998
  return this._size;
1938
1999
  }
1939
2000
  /**
1940
- * Sets the HTML attributes of the splitter bar.
1941
- * The property accepts string key-value based pairs.
1942
- * Attributes which are essential for certain functionalities cannot be changed.
2001
+ * Defines the HTML attributes of the splitter bar.
2002
+ * Accepts string key-value pairs.
2003
+ * You cannot change attributes that are essential for certain functionalities.
1943
2004
  */
1944
2005
  set splitterBarAttributes(attributes) {
1945
2006
  this._splitterBarAttributes = attributes;
@@ -1952,34 +2013,42 @@ class SplitterPaneComponent {
1952
2013
  return this._splitterBarAttributes;
1953
2014
  }
1954
2015
  /**
1955
- * The CSS classes that will be rendered on the splitter bar.
1956
- * Supports the type of values that are supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
2016
+ * Defines the CSS classes that are rendered on the splitter bar.
2017
+ * Supports the same values as [`ngClass`](link:site.data.urls.angular['ngclassapi']).
1957
2018
  */
1958
2019
  splitterBarClass;
1959
2020
  /**
1960
- * Sets the minimum possible size of the pane.
1961
- * Accepts units in pixel and percentage values.
2021
+ * Defines the minimum possible size of the pane.
2022
+ * Accepts values in pixels and percentages.
1962
2023
  */
1963
2024
  min;
1964
2025
  /**
1965
- * Sets the maximum possible size of the pane.
1966
- * Accepts units in pixel and percentage values.
2026
+ * Defines the maximum possible size of the pane.
2027
+ * Accepts values in pixels and percentages.
1967
2028
  */
1968
2029
  max;
1969
2030
  /**
1970
- * Specifies if the user is allowed to resize the pane and provide space for other panes.
2031
+ * Determines if you can resize the pane and provide space for other panes.
2032
+ *
2033
+ * @default true
1971
2034
  */
1972
2035
  resizable = true;
1973
2036
  /**
1974
- * Specifies if the user is allowed to hide the pane and provide space for other panes.
2037
+ * Determines if you can hide the pane and provide space for other panes.
2038
+ *
2039
+ * @default false
1975
2040
  */
1976
2041
  collapsible = false;
1977
2042
  /**
1978
- * Specifies if overflowing content is scrollable or hidden.
2043
+ * Determines if overflowing content is scrollable or hidden.
2044
+ *
2045
+ * @default true
1979
2046
  */
1980
2047
  scrollable = true;
1981
2048
  /**
1982
- * Specifies if the pane is initially collapsed.
2049
+ * Determines if the pane is initially collapsed.
2050
+ *
2051
+ * @default false
1983
2052
  */
1984
2053
  collapsed = false;
1985
2054
  /**
@@ -2002,15 +2071,15 @@ class SplitterPaneComponent {
2002
2071
  */
2003
2072
  overlayContent = false;
2004
2073
  /**
2005
- * Fires each time the user resizes the Splitter pane.
2074
+ * Fires when the Splitter pane size changes.
2006
2075
  * The event data contains the new pane size.
2007
- * Allows a two-way binding of the pane `size` property.
2076
+ * Enables two-way binding of the pane `size` property.
2008
2077
  */
2009
2078
  sizeChange = new EventEmitter();
2010
2079
  /**
2011
- * Fires each time the `collapsed` property changes.
2080
+ * Fires when the Splitter pane collapses or expands.
2012
2081
  * The event data contains the new property state.
2013
- * Allows a two-way binding of the `collapsed` pane property.
2082
+ * Enables two-way binding of the `collapsed` pane property.
2014
2083
  */
2015
2084
  collapsedChange = new EventEmitter();
2016
2085
  get isHidden() {
@@ -2476,41 +2545,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2476
2545
  type: Input
2477
2546
  }] } });
2478
2547
 
2479
- const SIZING_DOC_LINK = 'https://www.telerik.com/kendo-angular-ui/components/layout/splitter/panes/#toc-size';
2548
+ const SIZING_DOC_LINK = 'https://www.telerik.com/kendo-angular-ui/components/layout/splitter/panes/#specifying-the-dimensions';
2480
2549
  /**
2481
2550
  * Represents the [Kendo UI Splitter component for Angular]({% slug overview_splitter %}).
2482
2551
  *
2483
- * ```ts-preview
2484
- *
2485
- * @Component({
2486
- * selector: 'my-app',
2487
- * template: `
2488
- * <kendo-splitter [style.height.px]="280">
2489
- *
2490
- * <kendo-splitter-pane [collapsible]="true" size="30%">
2491
- * <h3>Inner splitter / left pane</h3>
2492
- * <p>Resizable and collapsible.</p>
2493
- * </kendo-splitter-pane>
2494
- *
2495
- * <kendo-splitter-pane>
2496
- * <h3>Inner splitter / center pane</h3>
2497
- * <p>Resizable only.</p>
2498
- * </kendo-splitter-pane>
2499
- *
2500
- * <kendo-splitter-pane [collapsible]="true" size="30%">
2501
- * <h3>Inner splitter / right pane</h3>
2502
- * <p>Resizable and collapsible.</p>
2503
- * </kendo-splitter-pane>
2504
- *
2505
- * </kendo-splitter>
2506
- * `,
2507
- * styles: [ `
2508
- * h3 { font-size: 1.2em; }
2509
- * h3, p { margin: 10px; padding: 0; }
2510
- * ` ]
2511
- * })
2512
- * class AppComponent {}
2552
+ * @example
2553
+ * ```html
2554
+ * <kendo-splitter [style.height.px]="280">
2555
+ * <kendo-splitter-pane [collapsible]="true" size="30%">
2556
+ * <h3>Left pane</h3>
2557
+ * </kendo-splitter-pane>
2558
+ * <kendo-splitter-pane>
2559
+ * <h3>Right pane</h3>
2560
+ * </kendo-splitter-pane>
2561
+ * </kendo-splitter>
2513
2562
  * ```
2563
+ * @remarks
2564
+ * Supported children components are: {@link SplitterPaneComponent}.
2514
2565
  */
2515
2566
  class SplitterComponent {
2516
2567
  element;
@@ -2520,17 +2571,20 @@ class SplitterComponent {
2520
2571
  ngZone;
2521
2572
  enclosingPane;
2522
2573
  /**
2523
- * Specifies the orientation of the panes within the Splitter.
2524
- * Panes in a horizontal Splitter are placed horizontally.
2525
- * Panes in a vertical Splitter are placed vertically.
2574
+ * Defines the orientation of the panes within the Splitter.
2575
+ * Use `horizontal` to place panes horizontally or `vertical` to place them vertically.
2576
+ *
2577
+ * @default 'horizontal'
2526
2578
  */
2527
2579
  orientation = 'horizontal';
2528
2580
  /**
2529
- * Sets the width or height (depending on the orientation) of the Splitter splitbars in pixels.
2581
+ * Defines the width or height of the Splitter splitbars in pixels.
2582
+ * The dimension depends on the orientation of the Splitter.
2530
2583
  */
2531
2584
  splitbarWidth;
2532
2585
  /**
2533
- * The distance in pixels that the separator is moved with during keyboard navigation.
2586
+ * Defines the distance in pixels that you move the separator during keyboard navigation.
2587
+ *
2534
2588
  * @default 10
2535
2589
  */
2536
2590
  set resizeStep(value) {
@@ -2540,14 +2594,13 @@ class SplitterComponent {
2540
2594
  return this.splitterService.resizeStep;
2541
2595
  }
2542
2596
  /**
2543
- * The CSS classes that will be rendered on the splitter bars.
2544
- * Supports the type of values that are supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
2597
+ * Defines the CSS classes that are rendered on the splitter bars.
2598
+ * Supports the same values as [`ngClass`](link:site.data.urls.angular['ngclassapi']).
2545
2599
  */
2546
2600
  splitterBarClass;
2547
2601
  /**
2548
- * Fires after a Splitter pane is resized or collapsed.
2549
- * Useful for triggering layout calculations on components
2550
- * which are positioned inside the panes.
2602
+ * Fires when the layout of the Splitter changes.
2603
+ * Use this event to trigger layout calculations on components that are positioned inside the panes.
2551
2604
  */
2552
2605
  layoutChange;
2553
2606
  get hostClasses() {
@@ -2779,32 +2832,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2779
2832
 
2780
2833
  /**
2781
2834
  * Represents the content template of the Kendo UI TabStrip.
2782
- * To define the template, nest a `<ng-template>` tag with the `kendoTabContent` inside the component tag.
2835
+ * To define the template, nest an `<ng-template>` tag with the `kendoTabContent` directive inside the component tag.
2783
2836
  *
2784
2837
  * @example
2785
- * ```ts-preview
2786
- *
2787
- * _@Component({
2788
- * selector: 'my-app',
2789
- * template: `
2790
- * <kendo-tabstrip [ngStyle]="{'width': '400px'}" [animate]="true">
2791
- * <kendo-tabstrip-tab title="Paris" [selected]="true">
2792
- * <ng-template kendoTabContent>
2793
- * <h3>Content 1</h3>
2794
- * </ng-template>
2795
- * </kendo-tabstrip-tab>
2796
- *
2797
- * <kendo-tabstrip-tab title="Sofia">
2798
- * <ng-template kendoTabContent>
2799
- * <h3>Content 2</h3>
2800
- * </ng-template>
2801
- * </kendo-tabstrip-tab>
2802
- * </kendo-tabstrip>
2803
- * `
2804
- * })
2805
- *
2806
- * class AppComponent {}
2807
- *
2838
+ * ```html
2839
+ * <kendo-tabstrip>
2840
+ * <kendo-tabstrip-tab title="First Tab">
2841
+ * <ng-template kendoTabContent>
2842
+ * <div class="tab-content">
2843
+ * <h2>Welcome</h2>
2844
+ * <p>This is the content of the first tab.</p>
2845
+ * </div>
2846
+ * </ng-template>
2847
+ * </kendo-tabstrip-tab>
2848
+ * </kendo-tabstrip>
2808
2849
  * ```
2809
2850
  */
2810
2851
  class TabContentDirective {
@@ -2825,37 +2866,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2825
2866
 
2826
2867
  /**
2827
2868
  * Represents the title template of the Kendo UI TabStrip.
2828
- * To define the template, nest a `<ng-template>` tag with the `kendoTabTitle` directive inside the component tag.
2829
- *
2830
- * > The `kendoTabTitle` directive overrides the TabStripTab [title]({% slug api_layout_tabstriptabcomponent %}#toc-title) option.
2869
+ * To define the template, nest an `<ng-template>` tag with the `kendoTabTitle` directive inside the component tag.
2870
+ * The `kendoTabTitle` directive overrides the TabStripTab [`title`]({% slug api_layout_tabstriptabcomponent %}#toc-title) option.
2831
2871
  *
2832
2872
  * @example
2833
- * ```ts-preview
2834
- *
2835
- * _@Component({
2836
- * selector: 'my-app',
2837
- * template: `
2838
- * <kendo-tabstrip>
2839
- * <kendo-tabstrip-tab [selected]="true">
2840
- * <ng-template kendoTabTitle>
2841
- * <h4>Custom Title</h4>
2842
- * </ng-template>
2843
- * <ng-template kendoTabContent>
2844
- * <h3>Content 1</h3>
2845
- * </ng-template>
2846
- * </kendo-tabstrip-tab>
2847
- *
2848
- * <kendo-tabstrip-tab title="Sofia">
2849
- * <ng-template kendoTabContent>
2850
- * <h3>Content 2</h3>
2851
- * </ng-template>
2852
- * </kendo-tabstrip-tab>
2853
- * </kendo-tabstrip>
2854
- * `
2855
- * })
2856
- *
2857
- * class AppComponent {}
2858
- *
2873
+ * ```html
2874
+ * <kendo-tabstrip>
2875
+ * <kendo-tabstrip-tab>
2876
+ * <ng-template kendoTabTitle>
2877
+ * <span class="custom-title">My Custom Title</span>
2878
+ * </ng-template>
2879
+ * </kendo-tabstrip-tab>
2880
+ * </kendo-tabstrip>
2859
2881
  * ```
2860
2882
  */
2861
2883
  class TabTitleDirective {
@@ -2894,52 +2916,65 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2894
2916
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
2895
2917
 
2896
2918
  /**
2897
- * Represents the tab component of the TabStrip.
2919
+ * Represents the Kendo UI TabStrip tab component.
2920
+ * Use this component to define individual tabs within a TabStrip.
2921
+ *
2922
+ * @example
2923
+ * ```html
2924
+ * <kendo-tabstrip>
2925
+ * <kendo-tabstrip-tab title="Home" [selected]="true">
2926
+ * <ng-template kendoTabContent>
2927
+ * Home content here
2928
+ * </ng-template>
2929
+ * </kendo-tabstrip-tab>
2930
+ * </kendo-tabstrip>
2931
+ * ```
2898
2932
  */
2899
2933
  class TabStripTabComponent {
2900
2934
  /**
2901
- * Sets the tab title ([see example](slug:tabs_tabstrip#toc-tab-titles)).
2935
+ * Sets the title text for the tab ([see example](slug:tabs_tabstrip#toc-tab-titles)).
2902
2936
  */
2903
2937
  title;
2904
2938
  /**
2905
- * Used to disable a tab ([see example]({% slug tabs_tabstrip %}#toc-disabled-tabs)).
2939
+ * Disables the tab and prevents user interaction ([see example]({% slug tabs_tabstrip %}#toc-disabled-tabs)).
2906
2940
  *
2907
- * Defaults to `false`.
2941
+ * @default false
2908
2942
  */
2909
2943
  disabled = false;
2910
2944
  /**
2911
- * The CSS classes that will be rendered on the `tab` element.
2912
- * Supports the type of values that are supported by [ngClass](link:site.data.urls.angular['ngclassapi']).
2945
+ * Specifies the CSS classes to apply to the `tab` element.
2946
+ * Accepts the same values as [`ngClass`](link:site.data.urls.angular['ngclassapi']).
2913
2947
  */
2914
2948
  cssClass;
2915
2949
  /**
2916
- * The CSS styles that will be rendered on the `tab` element.
2917
- * Supports the type of values that are supported by [ngStyle](link:site.data.urls.angular['ngstyleapi']).
2950
+ * Specifies the CSS styles to apply to the `tab` element.
2951
+ * Accepts the same values as [`ngStyle`](link:site.data.urls.angular['ngstyleapi']).
2918
2952
  */
2919
2953
  cssStyle;
2920
2954
  /**
2921
- * Determines which tab will be selected upon the initial loading of the TabStrip
2955
+ * Selects the tab when the TabStrip loads
2922
2956
  * ([see example](slug:tabs_tabstrip#toc-selected-tab)).
2923
2957
  */
2924
2958
  selected;
2925
2959
  /**
2926
- * When set to `true`, a close button will be rendered inside the tab.
2927
- * This option overrides the value of the TabStrip `closable` option.
2960
+ * Shows a close button inside the tab when set to `true`.
2961
+ * This setting overrides the TabStrip `closable` option.
2928
2962
  */
2929
2963
  closable;
2930
2964
  /**
2931
- * Defines the name for an existing font icon in the Kendo UI theme for the close icon.
2932
- * This option overrides the value of the TabStrip `closeIcon` option.
2965
+ * Sets the name of an existing font icon in the Kendo UI theme for the close button.
2966
+ * This setting overrides the TabStrip `closeIcon` option.
2933
2967
  */
2934
2968
  closeIcon;
2935
2969
  /**
2936
- * Allows the usage of custom icons by defining a custom CSS class, or multiple classes separated by spaces.
2937
- * This option overrides the value of the TabStrip `closeIcon` option.
2970
+ * Sets custom CSS classes for the close button icon.
2971
+ * You can define a single class or multiple classes separated by spaces.
2972
+ * This setting overrides the TabStrip `closeIcon` option.
2938
2973
  */
2939
2974
  closeIconClass;
2940
2975
  /**
2941
- * Defines an SVGIcon to be rendered for the close icon.
2942
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
2976
+ * Sets an SVG icon for the close button.
2977
+ * You can use an [existing Kendo SVG icon](slug:svgicon_list) or provide a custom one.
2943
2978
  */
2944
2979
  closeSVGIcon;
2945
2980
  get tabContent() {
@@ -3004,7 +3039,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3004
3039
 
3005
3040
  /**
3006
3041
  * Arguments for the `tabClose` event of the TabStrip.
3007
- * The `tabClose` event fires when the close button of the tab is clicked.
3042
+ * The `tabClose` event fires when a tab is closed (clicked on the close button).
3008
3043
  *
3009
3044
  */
3010
3045
  class TabCloseEvent {
@@ -3014,6 +3049,7 @@ class TabCloseEvent {
3014
3049
  * Constructs the event arguments for the `tabClose` event.
3015
3050
  * @param index - The index of the closed tab.
3016
3051
  * @param tab - The closed tab instance
3052
+ * @hidden
3017
3053
  */
3018
3054
  constructor(index, tab) {
3019
3055
  this.index = index;
@@ -3023,7 +3059,7 @@ class TabCloseEvent {
3023
3059
 
3024
3060
  /**
3025
3061
  * Arguments for the `select` event of the TabStrip.
3026
- * The `select` event fires when a tab is selected (clicked).
3062
+ * The `select` event fires when tab is selected (clicked).
3027
3063
  */
3028
3064
  class SelectEvent extends PreventableEvent$1 {
3029
3065
  index;
@@ -3032,6 +3068,8 @@ class SelectEvent extends PreventableEvent$1 {
3032
3068
  * Constructs the event arguments for the `select` event.
3033
3069
  * @param index - The index of the selected tab.
3034
3070
  * @param title - The title of the selected tab.
3071
+ *
3072
+ * @hidden
3035
3073
  */
3036
3074
  constructor(index, title) {
3037
3075
  super();
@@ -3511,12 +3549,12 @@ const normalizeScrollableSettings = (settings) => normalizeSettings(settings ===
3511
3549
 
3512
3550
  /**
3513
3551
  * Arguments for the `tabScroll` event of the TabStrip.
3514
- * The `tabScroll` event fires when the tabs are being scrolled.
3552
+ * The `tabScroll` event fires when you scroll the tabs.
3515
3553
  *
3516
3554
  */
3517
3555
  class TabScrollEvent extends PreventableEvent$1 {
3518
3556
  /**
3519
- * The DOM event that triggered the tab scroll.
3557
+ * The original DOM event that caused the tab scroll.
3520
3558
  */
3521
3559
  originalEvent;
3522
3560
  /**
@@ -3865,15 +3903,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3865
3903
  */
3866
3904
  class TabStripMessages extends ComponentMessages {
3867
3905
  /**
3868
- * The title for the **Close** button in the TabStrip tab.
3906
+ * Sets the title for the **Close** button in the TabStrip tab.
3869
3907
  */
3870
3908
  closeTitle;
3871
3909
  /**
3872
- * The title for the **Previous Tab** button when the Tabstrip is scrollable.
3910
+ * Sets the title for the **Previous Tab** button when the TabStrip is scrollable.
3873
3911
  */
3874
3912
  previousTabButton;
3875
3913
  /**
3876
- * The title for the **Next Tab** button when the Tabstrip is scrollable.
3914
+ * Sets the title for the **Next Tab** button when the TabStrip is scrollable.
3877
3915
  */
3878
3916
  nextTabButton;
3879
3917
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: TabStripMessages, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -3926,6 +3964,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3926
3964
 
3927
3965
  /**
3928
3966
  * Represents the [Kendo UI TabStrip component for Angular]({% slug overview_tabstrip %}).
3967
+ *
3968
+ * @example
3969
+ * ```html
3970
+ * <kendo-tabstrip>
3971
+ * <kendo-tabstrip-tab [title]="'First Tab'">
3972
+ * <ng-template kendoTabContent>
3973
+ * <p>Content of the first tab.</p>
3974
+ * </ng-template>
3975
+ * </kendo-tabstrip-tab>
3976
+ * <kendo-tabstrip-tab [title]="'Second Tab'">
3977
+ * <ng-template kendoTabContent>
3978
+ * <p>Content of the second tab.</p>
3979
+ * </ng-template>
3980
+ * </kendo-tabstrip-tab>
3981
+ * </kendo-tabstrip>
3982
+ * ```
3983
+ * @remarks
3984
+ * Supported children components are: {@link TabStripCustomMessagesComponent}, {@link TabStripTabComponent}.
3929
3985
  */
3930
3986
  class TabStripComponent {
3931
3987
  localization;
@@ -3936,6 +3992,7 @@ class TabStripComponent {
3936
3992
  ngZone;
3937
3993
  /**
3938
3994
  * Sets the height of the TabStrip.
3995
+ * Accepts a CSS size value, such as `100px`, `50%`, or `auto`.
3939
3996
  */
3940
3997
  set height(value) {
3941
3998
  this._height = value;
@@ -3945,7 +4002,7 @@ class TabStripComponent {
3945
4002
  return this._height;
3946
4003
  }
3947
4004
  /**
3948
- * Enables the tab animation.
4005
+ * Sets whether the TabStrip should animate when switching tabs.
3949
4006
  *
3950
4007
  * @default true
3951
4008
  */
@@ -3953,34 +4010,30 @@ class TabStripComponent {
3953
4010
  /**
3954
4011
  * Sets the alignment of the tabs.
3955
4012
  *
3956
- * @default: 'start'
4013
+ * @default 'start'
3957
4014
  */
3958
4015
  tabAlignment = 'start';
3959
4016
  /**
3960
- * Sets the position of the tabs. Defaults to `top`.
4017
+ * Sets the position of the tabs.
3961
4018
  *
3962
4019
  * @default 'top'
3963
4020
  */
3964
4021
  tabPosition = 'top';
3965
4022
  /**
3966
- * When set to `true`, the component renders all tabs and they are persisted in the DOM.
3967
- * By default, `keepTabContent` is `false`.
4023
+ * When set to `true`, the tabs are persisted in the DOM and their content is not destroyed when they are not selected ([see example](slug:rendering_tabstrip)).
3968
4024
  *
3969
4025
  * @default false
3970
4026
  */
3971
4027
  keepTabContent = false;
3972
4028
  /**
3973
- * When set to `true`, a close button will be rendered inside each tab.
3974
- * By default, `closable` is `false`.
4029
+ * When set to `true`, renders a close button inside each tab.
3975
4030
  *
3976
4031
  * @default false
3977
4032
  */
3978
4033
  closable = false;
3979
4034
  /**
3980
- * Enables the scrolling of the tab list. When set to `true` and the total size of all tabs
3981
- * is greater than the size of the TabStrip container, scroll buttons will be rendered on each end of the tab list.
3982
- *
3983
- * By default, `scrollable` is `false`.
4035
+ * Enables scrolling of the tab list.
4036
+ * When set to `true` and the total size of all tabs exceeds the size of the TabStrip container, scroll buttons appear on each end of the tab list.
3984
4037
  *
3985
4038
  * @default false
3986
4039
  */
@@ -3997,14 +4050,9 @@ class TabStripComponent {
3997
4050
  return this._scrollableSettings;
3998
4051
  }
3999
4052
  /**
4000
- * Specifies the size of the TabStrip.
4001
- * ([see example](slug:api_layout_tabstripcomponent#toc-size).
4002
- *
4003
- * The possible values are:
4004
- * * `small`
4005
- * * `medium` (Default)
4006
- * * `large`
4007
- * * `none`
4053
+ * Sets the size of the TabStrip.
4054
+ * [See example](slug:api_layout_tabstripcomponent#toc-size).
4055
+ * @default 'medium'
4008
4056
  */
4009
4057
  set size(value) {
4010
4058
  switch (value) {
@@ -4035,16 +4083,17 @@ class TabStripComponent {
4035
4083
  return this._size;
4036
4084
  }
4037
4085
  /**
4038
- * Defines the name for an existing font icon in the Kendo UI theme for the close icon.
4086
+ * Defines the name of an existing font icon in the Kendo UI theme for the close icon.
4087
+ * @default 'x'
4039
4088
  */
4040
4089
  closeIcon = 'x';
4041
4090
  /**
4042
- * Allows defining a custom CSS class, or multiple classes separated by spaces, which will be applied to the close button.
4091
+ * Defines a custom CSS class, or multiple classes separated by spaces, applied to the close button.
4043
4092
  */
4044
4093
  closeIconClass;
4045
4094
  /**
4046
- * Defines an SVGIcon to be rendered for the close icon.
4047
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
4095
+ * Defines an SVGIcon to render for the close icon.
4096
+ * The input accepts either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
4048
4097
  */
4049
4098
  set closeSVGIcon(icon) {
4050
4099
  if (isDevMode() && icon && this.closeIcon && this.closeIcon !== 'x') {
@@ -4056,23 +4105,23 @@ class TabStripComponent {
4056
4105
  return this._closeSVGIcon;
4057
4106
  }
4058
4107
  /**
4059
- * Determines whether the content associated with each tab will be rendered.
4108
+ * If set to `false`, the content area is hidden, but the tab headers are still visible.
4060
4109
  *
4061
4110
  * @default true
4062
4111
  */
4063
4112
  showContentArea = true;
4064
4113
  /**
4065
- * Fires each time the user selects a tab ([see example](slug:events_tabstrip)).
4114
+ * Fires each time a tab is selected.
4066
4115
  * The event data contains the index of the selected tab and its title.
4067
4116
  */
4068
4117
  tabSelect = new EventEmitter();
4069
4118
  /**
4070
- * Fires each time the user closes a tab.
4119
+ * Fires each time a tab is closed.
4071
4120
  * The event data contains the index of the closed tab and its instance.
4072
4121
  */
4073
4122
  tabClose = new EventEmitter();
4074
4123
  /**
4075
- * Fires each time the user scrolls the TabStrip list.
4124
+ * Fires when the tab list is scrolled.
4076
4125
  * The event is preventable.
4077
4126
  */
4078
4127
  tabScroll = new EventEmitter();
@@ -4239,8 +4288,9 @@ class TabStripComponent {
4239
4288
  return isTablistHorizontal(this.tabPosition) ? 'k-hstack' : 'k-vstack';
4240
4289
  }
4241
4290
  /**
4242
- * Allows the user to select a tab programmatically.
4243
- * @param {number} index - The index of the tab that will be selected.
4291
+ * Allows you to programmatically select a tab by its index.
4292
+ * If the tab is disabled, it will not be selected.
4293
+ * @param {number} index The index of the tab that will be selected.
4244
4294
  */
4245
4295
  selectTab(index) {
4246
4296
  const tab = getTabByIndex(this.tabs, index);
@@ -4459,10 +4509,10 @@ class TabStripComponent {
4459
4509
  <ul role="tablist" #tablist
4460
4510
  class="k-reset k-tabstrip-items"
4461
4511
  [ngClass]="{
4462
- 'k-tabstrip-items-start': tabAlignment === 'start',
4463
- 'k-tabstrip-items-center': tabAlignment === 'center',
4464
- 'k-tabstrip-items-end': tabAlignment === 'end',
4465
- 'k-tabstrip-items-stretched': tabAlignment === 'stretched',
4512
+ 'k-tabstrip-items-start': tabAlignment === 'start',
4513
+ 'k-tabstrip-items-center': tabAlignment === 'center',
4514
+ 'k-tabstrip-items-end': tabAlignment === 'end',
4515
+ 'k-tabstrip-items-stretched': tabAlignment === 'stretched',
4466
4516
  'k-tabstrip-items-justify': tabAlignment === 'justify',
4467
4517
  'k-tabstrip-items-scroll': mouseScrollEnabled
4468
4518
  }"
@@ -4642,10 +4692,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4642
4692
  <ul role="tablist" #tablist
4643
4693
  class="k-reset k-tabstrip-items"
4644
4694
  [ngClass]="{
4645
- 'k-tabstrip-items-start': tabAlignment === 'start',
4646
- 'k-tabstrip-items-center': tabAlignment === 'center',
4647
- 'k-tabstrip-items-end': tabAlignment === 'end',
4648
- 'k-tabstrip-items-stretched': tabAlignment === 'stretched',
4695
+ 'k-tabstrip-items-start': tabAlignment === 'start',
4696
+ 'k-tabstrip-items-center': tabAlignment === 'center',
4697
+ 'k-tabstrip-items-end': tabAlignment === 'end',
4698
+ 'k-tabstrip-items-stretched': tabAlignment === 'stretched',
4649
4699
  'k-tabstrip-items-justify': tabAlignment === 'justify',
4650
4700
  'k-tabstrip-items-scroll': mouseScrollEnabled
4651
4701
  }"
@@ -4807,8 +4857,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4807
4857
  }] } });
4808
4858
 
4809
4859
  /**
4810
- * Custom component messages override default component messages
4811
- * ([see example]({% slug rtl_layout %})).
4860
+ * Represents the custom messages component for the TabStrip.
4861
+ * It allows you to override the default messages used in the TabStrip component ([see example]({% slug rtl_layout %})).
4862
+ *
4863
+ * ```html
4864
+ * <kendo-tabstrip>
4865
+ * <kendo-tabstrip-messages
4866
+ * closeTitle="Close this tab"
4867
+ * previousTabButton="Go to previous tab"
4868
+ * </kendo-tabstrip-messages>
4869
+ * </kendo-tabstrip>
4870
+ * ```
4812
4871
  */
4813
4872
  class TabStripCustomMessagesComponent extends TabStripMessages {
4814
4873
  service;
@@ -4843,11 +4902,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4843
4902
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
4844
4903
 
4845
4904
  /**
4846
- * Represents a template that defines the content of the Drawer.
4847
- * To define the template, nest an `<ng-template>` tag
4848
- * with the `kendoDrawerTemplate` directive inside the `<kendo-drawer>` tag.
4849
- * Using this template directive will override all other templates,
4850
- * for example, `kendoDrawerHeaderTemplate` and `kendoDrawerItemTemplate`.
4905
+ * Defines a template that specifies the content of the Drawer.
4906
+ * To define the template, nest an `<ng-template>` tag with the `kendoDrawerTemplate` directive inside the `<kendo-drawer>` tag.
4907
+ * Using this template directive overrides all other templates, for example, `kendoDrawerHeaderTemplate` and `kendoDrawerItemTemplate`.
4908
+ *
4909
+ * @example
4910
+ * ```html
4911
+ * <kendo-drawer>
4912
+ * <ng-template kendoDrawerTemplate>
4913
+ * <div class="custom-drawer-content">
4914
+ * <h3>Custom Drawer</h3>
4915
+ * <ul>
4916
+ * <li>Custom Item 1</li>
4917
+ * <li>Custom Item 2</li>
4918
+ * </ul>
4919
+ * </div>
4920
+ * </ng-template>
4921
+ * </kendo-drawer>
4922
+ * ```
4851
4923
  */
4852
4924
  class DrawerTemplateDirective {
4853
4925
  templateRef;
@@ -4868,9 +4940,25 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4868
4940
  }] }]; } });
4869
4941
 
4870
4942
  /**
4871
- * Represents a template that defines the item content of the Drawer.
4872
- * To define the template, nest an `<ng-template>` tag
4873
- * with the `kendoDrawerItemTemplate` directive inside the `<kendo-drawer>` tag.
4943
+ * Defines a template that specifies the item content of the Drawer.
4944
+ * To define the template, nest an `<ng-template>` tag with the `kendoDrawerItemTemplate` directive inside the `<kendo-drawer>` tag.
4945
+ *
4946
+ * The `let-item` context variable provides access to the item data.
4947
+ *
4948
+ * For the Hierarchical Drawer, the `kendoDrawerItemTemplate` directive provides additional context fields:
4949
+ *
4950
+ * * `level`&mdash;A number that indicates the nesting level of the current item. Use the `let-level="level"` syntax to access the nesting level.
4951
+ * * `hasChildren`&mdash;A boolean that indicates whether the current item has nested items. Use the `let-hasChildren="hasChildren"` syntax to access the value.
4952
+ * * `isItemExpanded`&mdash;A boolean that holds information about the expanded state of the current item, which indicates whether its children are visible or not. Use the `let-isItemExpanded="isItemExpanded"` syntax to access the value of the expanded state.
4953
+ *
4954
+ * @example
4955
+ * ```html
4956
+ * <kendo-drawer>
4957
+ * <ng-template kendoDrawerItemTemplate let-item>
4958
+ * <span class="custom-item">{{ item.text }}</span>
4959
+ * </ng-template>
4960
+ * </kendo-drawer>
4961
+ * ```
4874
4962
  */
4875
4963
  class DrawerItemTemplateDirective {
4876
4964
  templateRef;
@@ -4891,9 +4979,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4891
4979
  }] }]; } });
4892
4980
 
4893
4981
  /**
4894
- * Represents a template that defines the header content of the Drawer.
4895
- * To define the template, nest an `<ng-template>` tag
4896
- * with the `kendoDrawerHeaderTemplate` directive inside the `<kendo-drawer>` tag.
4982
+ * Defines a template that specifies the header content of the Drawer.
4983
+ * To define the template, nest an `<ng-template>` tag with the `kendoDrawerHeaderTemplate` directive inside the `<kendo-drawer>` tag.
4984
+ *
4985
+ * @example
4986
+ * ```html
4987
+ * <kendo-drawer>
4988
+ * <ng-template kendoDrawerHeaderTemplate>
4989
+ * <h3>Navigation Menu</h3>
4990
+ * </ng-template>
4991
+ * </kendo-drawer>
4992
+ * ```
4897
4993
  */
4898
4994
  class DrawerHeaderTemplateDirective {
4899
4995
  templateRef;
@@ -4914,9 +5010,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4914
5010
  }] }]; } });
4915
5011
 
4916
5012
  /**
4917
- * Represents a template that defines the footer content of the Drawer.
4918
- * To define the template, nest an `<ng-template>` tag
4919
- * with the `kendoDrawerFooterTemplate` directive inside the `<kendo-drawer>` tag.
5013
+ * Defines a template that specifies the footer content of the Drawer.
5014
+ * To define the template, nest an `<ng-template>` tag with the `kendoDrawerFooterTemplate` directive inside the `<kendo-drawer>` tag.
5015
+ *
5016
+ * @example
5017
+ * ```html
5018
+ * <kendo-drawer>
5019
+ * <ng-template kendoDrawerFooterTemplate>
5020
+ * <p>© 2023 Company Name</p>
5021
+ * </ng-template>
5022
+ * </kendo-drawer>
5023
+ * ```
4920
5024
  */
4921
5025
  class DrawerFooterTemplateDirective {
4922
5026
  templateRef;
@@ -5559,32 +5663,31 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
5559
5663
  const DEFAULT_ANIMATION = { type: 'slide', duration: 200 };
5560
5664
  /**
5561
5665
  * Represents the [Kendo UI Drawer component for Angular]({% slug overview_drawer %}).
5666
+ * Provides a dismissible or permanently visible panel for navigation in responsive web applications.
5562
5667
  *
5563
5668
  * @example
5564
- * ```ts-preview
5565
- * _@Component({
5566
- * selector: 'my-app',
5567
- * template: `
5568
- * <kendo-drawer-container>
5569
- * <kendo-drawer #drawer
5570
- * [items]="items"
5571
- * mode="overlay"
5572
- * [(expanded)]="expanded">
5573
- * </kendo-drawer>
5574
- * <kendo-drawer-content>
5575
- * <button class="k-button" (click)="drawer.toggle()">Open the Drawer</button>
5576
- * </kendo-drawer-content>
5577
- * </kendo-drawer-container>
5578
- * `
5669
+ * ```typescript
5670
+ * @Component({
5671
+ * selector: 'my-app',
5672
+ * template: `
5673
+ * <kendo-drawer-container>
5674
+ * <kendo-drawer #drawer
5675
+ * [items]="items"
5676
+ * mode="overlay"
5677
+ * [(expanded)]="expanded">
5678
+ * </kendo-drawer>
5679
+ * <kendo-drawer-content>
5680
+ * <button class="k-button" (click)="drawer.toggle()">Open the Drawer</button>
5681
+ * </kendo-drawer-content>
5682
+ * </kendo-drawer-container>
5683
+ * `
5579
5684
  * })
5580
5685
  * class AppComponent {
5581
- * public expanded = false;
5582
- *
5583
- * public items: any[] = [
5584
- * { text: 'Inbox', icon: 'k-i-inbox' },
5585
- * { text: 'Notifications', icon: 'k-i-bell' },
5586
- * { text: 'Date', icon: 'k-i-calendar' }
5587
- * ];
5686
+ * public expanded = false;
5687
+ * public items = [
5688
+ * { text: 'Inbox', icon: 'inbox' },
5689
+ * { text: 'Notifications', icon: 'bell' }
5690
+ * ];
5588
5691
  * }
5589
5692
  * ```
5590
5693
  */
@@ -5619,52 +5722,58 @@ class DrawerComponent {
5619
5722
  return this.drawerWidth;
5620
5723
  }
5621
5724
  /**
5622
- * Specifies the mode in which the Drawer will be displayed.
5725
+ * Specifies the mode in which the Drawer displays.
5623
5726
  *
5624
- * The possible values are:
5625
- * * (Default) `overlay`
5626
- * * `push`
5727
+ * @default 'overlay'
5627
5728
  */
5628
5729
  mode = 'overlay';
5629
5730
  /**
5630
5731
  * Specifies the position of the Drawer
5631
5732
  * ([see example]({% slug positioning_drawer %})).
5632
5733
  *
5633
- * The possible values are:
5634
- * * (Default) `start`
5635
- * * `end`
5734
+ * @default 'start'
5636
5735
  */
5637
5736
  position = 'start';
5638
5737
  /**
5639
- * Enables the mini (compact) view of the Drawer which is displayed when the component is collapsed
5738
+ * Enables the mini (compact) view of the Drawer which displays when the component is collapsed
5640
5739
  * ([see example]({% slug expandmodespositions_drawer %}#toc-mini-view)).
5740
+ *
5741
+ * @default false
5641
5742
  */
5642
5743
  mini = false;
5643
5744
  /**
5644
5745
  * Specifies the state of the Drawer.
5746
+ *
5747
+ * @default false
5645
5748
  */
5646
5749
  expanded = false;
5647
5750
  /**
5648
5751
  * Defines the width of the Drawer when it is expanded.
5649
- * Defaults to `240`.
5752
+ *
5753
+ * @default 240
5650
5754
  */
5651
5755
  width = 240;
5652
5756
  /**
5653
- * Defines the width of the Drawer when the mini view is enabled
5654
- * and the component is collapsed. Defaults to `60`.
5757
+ * Defines the width of the Drawer when the mini view is enabled and the component is collapsed.
5758
+ *
5759
+ * @default 50
5655
5760
  */
5656
5761
  miniWidth = 50;
5657
5762
  /**
5658
- * Specifies if the Drawer will be automatically collapsed when an item
5659
- * or the overlay is clicked. Defaults to `true`.
5763
+ * Specifies if the Drawer automatically collapses when an item or the overlay is clicked.
5764
+ *
5765
+ * @default true
5660
5766
  */
5661
5767
  autoCollapse = true;
5662
5768
  /**
5663
- * The collection of items that will be rendered in the Drawer.
5769
+ * Defines the collection of items that render in the Drawer.
5770
+ *
5771
+ * @default []
5664
5772
  */
5665
5773
  items = [];
5666
5774
  /**
5667
5775
  * Defines a callback function which determines if an item should be expanded.
5776
+ * This is useful for hierarchical data structures where the expansion state of an item depends on its parent or other items.
5668
5777
  */
5669
5778
  set isItemExpanded(fn) {
5670
5779
  if (isDevMode && isPresent(fn) && typeof fn !== 'function') {
@@ -5680,16 +5789,10 @@ class DrawerComponent {
5680
5789
  */
5681
5790
  direction;
5682
5791
  /**
5683
- * Specifies the animation settings of the Drawer.
5792
+ * Specifies the animation settings of the Drawer
5684
5793
  * ([see example]({% slug interaction_drawer %}#toc-toggling-between-states)).
5685
5794
  *
5686
- * The possible values are:
5687
- * * Boolean
5688
- * * (Default) `true`
5689
- * * `false`
5690
- * * `DrawerAnimation`
5691
- * * (Default) `type?: 'slide'`
5692
- * * `duration`&mdash;Accepts a number in milliseconds. Defaults to `300ms`.
5795
+ * @default { type: 'slide', duration: 200 }
5693
5796
  */
5694
5797
  animation = DEFAULT_ANIMATION;
5695
5798
  /**
@@ -5701,11 +5804,12 @@ class DrawerComponent {
5701
5804
  */
5702
5805
  collapse = new EventEmitter();
5703
5806
  /**
5704
- * Fires when a Drawer item is selected. This event is preventable.
5807
+ * Fires when an item in the Drawer is selected.
5808
+ * This event is preventable.
5705
5809
  */
5706
5810
  select = new EventEmitter();
5707
5811
  /**
5708
- * Fires when the `expanded` property of the component was updated.
5812
+ * Fires when the `expanded` property of the component is updated.
5709
5813
  * Used to provide a two-way binding for the `expanded` property.
5710
5814
  */
5711
5815
  expandedChange = new EventEmitter();
@@ -5772,8 +5876,9 @@ class DrawerComponent {
5772
5876
  }
5773
5877
  /**
5774
5878
  * Toggles the visibility of the Drawer.
5879
+ * If the `expanded` parameter is not provided, the Drawer will toggle between expanded and collapsed states.
5775
5880
  *
5776
- * @param expanded? - Boolean. Specifies if the Drawer will be expanded or collapsed.
5881
+ * @param expanded Specifies if the Drawer will be expanded or collapsed.
5777
5882
  */
5778
5883
  toggle(expanded) {
5779
5884
  const previous = this.expanded;
@@ -5987,7 +6092,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
5987
6092
  }] } });
5988
6093
 
5989
6094
  /**
5990
- * Serves as a container for the [Kendo UI Drawer component for Angular]({% slug overview_drawer %}) and its content.
6095
+ * Serves as a container for the [Drawer component]({% slug overview_drawer %}) and its content.
6096
+ *
6097
+ * @example
6098
+ * ```html
6099
+ * <kendo-drawer-container>
6100
+ * <kendo-drawer [items]="items"></kendo-drawer>
6101
+ * <kendo-drawer-content>
6102
+ * <h1>Main Content</h1>
6103
+ * </kendo-drawer-content>
6104
+ * </kendo-drawer-container>
6105
+ * ```
6106
+ * @remarks
6107
+ * Supported children components are: {@link DrawerComponent}, {@link DrawerContentComponent}.
5991
6108
  */
5992
6109
  class DrawerContainerComponent {
5993
6110
  localizationService;
@@ -6098,7 +6215,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
6098
6215
  }] } });
6099
6216
 
6100
6217
  /**
6101
- * Represents the content of the [Kendo UI Drawer component for Angular]({% slug overview_drawer %}).
6218
+ * Defines the content of the Drawer component.
6219
+ *
6220
+ * @example
6221
+ * ```html
6222
+ * <kendo-drawer-content>
6223
+ * <h1>Main Content Area</h1>
6224
+ * <p>Your application content goes here.</p>
6225
+ * </kendo-drawer-content>
6226
+ * ```
6102
6227
  */
6103
6228
  class DrawerContentComponent {
6104
6229
  hostClasses = true;
@@ -6124,23 +6249,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
6124
6249
  }] } });
6125
6250
 
6126
6251
  /**
6127
- * Arguments for the `select` event of the Drawer.
6252
+ * Defines the arguments for the `select` event of the Drawer.
6128
6253
  */
6129
6254
  class DrawerSelectEvent extends PreventableEvent$1 {
6130
6255
  /**
6131
- * The index of the selected item in the `items` collection.
6256
+ * Defines the index of the selected item in the `items` collection.
6132
6257
  */
6133
6258
  index;
6134
6259
  /**
6135
- * The selected Drawer item.
6260
+ * Defines the selected Drawer item.
6136
6261
  */
6137
6262
  item;
6138
6263
  /**
6139
- * The DOM event that triggered the selection.
6264
+ * Defines the DOM event that triggered the selection.
6140
6265
  */
6141
6266
  originalEvent;
6142
6267
  /**
6143
- * The Drawer that triggered the event.
6268
+ * Defines the Drawer that triggered the event.
6144
6269
  */
6145
6270
  sender;
6146
6271
  /**
@@ -6153,9 +6278,20 @@ class DrawerSelectEvent extends PreventableEvent$1 {
6153
6278
  }
6154
6279
 
6155
6280
  /**
6156
- * Represents a template that defines the content of the whole Step.
6281
+ * Use this template to define custom content for the entire step.
6157
6282
  * To define the template, nest an `<ng-template>` tag
6158
6283
  * with the `kendoStepperStepTemplate` directive inside the `<kendo-stepper>` tag.
6284
+ *
6285
+ * @example
6286
+ * ```html
6287
+ * <kendo-stepper>
6288
+ * <ng-template kendoStepperStepTemplate let-step="step" let-index="index">
6289
+ * <div class="custom-step">
6290
+ * <span>{{ step.label }}</span>
6291
+ * </div>
6292
+ * </ng-template>
6293
+ * </kendo-stepper>
6294
+ * ```
6159
6295
  */
6160
6296
  class StepperStepTemplateDirective {
6161
6297
  templateRef;
@@ -6176,9 +6312,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
6176
6312
  }] }]; } });
6177
6313
 
6178
6314
  /**
6179
- * Represents a template that defines the content of the Step label.
6315
+ * Use this template to define custom content for the step label.
6180
6316
  * To define the template, nest an `<ng-template>` tag
6181
6317
  * with the `kendoStepperLabelTemplate` directive inside the `<kendo-stepper>` tag.
6318
+ *
6319
+ * @example
6320
+ * ```html
6321
+ * <kendo-stepper>
6322
+ * <ng-template kendoStepperLabelTemplate let-step="step" let-index="index">
6323
+ * <span class="custom-label">{{ step.label }}</span>
6324
+ * </ng-template>
6325
+ * </kendo-stepper>
6326
+ * ```
6182
6327
  */
6183
6328
  class StepperLabelTemplateDirective {
6184
6329
  templateRef;
@@ -6199,9 +6344,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
6199
6344
  }] }]; } });
6200
6345
 
6201
6346
  /**
6202
- * Represents a template that defines the content of the Step indicator.
6347
+ * Use this template to define custom content for the step indicator.
6203
6348
  * To define the template, nest an `<ng-template>` tag
6204
6349
  * with the `kendoStepperIndicatorTemplate` directive inside the `<kendo-stepper>` tag.
6350
+ *
6351
+ * @example
6352
+ * ```html
6353
+ * <kendo-stepper>
6354
+ * <ng-template kendoStepperIndicatorTemplate let-step="step" let-index="index">
6355
+ * <span>{{ index + 1 }}</span>
6356
+ * </ng-template>
6357
+ * </kendo-stepper>
6358
+ * ```
6205
6359
  */
6206
6360
  class StepperIndicatorTemplateDirective {
6207
6361
  templateRef;
@@ -6241,19 +6395,19 @@ handlersRTL[Keys.ArrowRight] = 'left';
6241
6395
  */
6242
6396
  let StepperActivateEvent$1 = class StepperActivateEvent extends PreventableEvent$1 {
6243
6397
  /**
6244
- * The index of the activated step in the `steps` collection.
6398
+ * Specifies the index of the activated step in the `steps` collection.
6245
6399
  */
6246
6400
  index;
6247
6401
  /**
6248
- * The activated step.
6402
+ * Specifies the activated step.
6249
6403
  */
6250
6404
  step;
6251
6405
  /**
6252
- * The DOM event that triggered the step activation.
6406
+ * Specifies the DOM event that triggered the step activation.
6253
6407
  */
6254
6408
  originalEvent;
6255
6409
  /**
6256
- * The Stepper that triggered the event.
6410
+ * Specifies the Stepper that triggered the event.
6257
6411
  */
6258
6412
  sender;
6259
6413
  /**
@@ -6929,7 +7083,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
6929
7083
  */
6930
7084
  class StepperMessages extends ComponentMessages {
6931
7085
  /**
6932
- * The optional text.
7086
+ * Specifies the optional text.
6933
7087
  */
6934
7088
  optional;
6935
7089
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: StepperMessages, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -6983,20 +7137,22 @@ const DEFAULT_ANIMATION_DURATION = 400;
6983
7137
  * Represents the [Kendo UI Stepper component for Angular]({% slug overview_stepper %}).
6984
7138
  *
6985
7139
  * @example
6986
- * ```ts-preview
6987
- * _@Component({
6988
- * selector: 'my-app',
6989
- * template: `
6990
- * <kendo-stepper [steps]="steps">
6991
- * </kendo-stepper>
6992
- * `
7140
+ * ```ts
7141
+ * @Component({
7142
+ * selector: 'my-app',
7143
+ * template: `
7144
+ * <kendo-stepper [steps]="steps">
7145
+ * </kendo-stepper>
7146
+ * `
6993
7147
  * })
6994
7148
  * class AppComponent {
6995
- * public steps: Array<StepperStep> = [
6996
- * { label: 'Step One' }, { label: 'Step Two' }, { label: 'Step Three' }
6997
- * ];
7149
+ * public steps: Array<StepperStep> = [
7150
+ * { label: 'Step One' }, { label: 'Step Two' }, { label: 'Step Three' }
7151
+ * ];
6998
7152
  * }
6999
7153
  * ```
7154
+ * @remarks
7155
+ * Supported children components are: {@link StepperCustomMessagesComponent}.
7000
7156
  */
7001
7157
  class StepperComponent {
7002
7158
  renderer;
@@ -7013,10 +7169,7 @@ class StepperComponent {
7013
7169
  /**
7014
7170
  * Specifies the type of the steps in the Stepper.
7015
7171
  *
7016
- * The possible values are:
7017
- * * (Default) `indicator`
7018
- * * `label`
7019
- * * `full`
7172
+ * @default 'indicator'
7020
7173
  */
7021
7174
  stepType = 'indicator';
7022
7175
  /**
@@ -7029,13 +7182,11 @@ class StepperComponent {
7029
7182
  * Specifies the orientation of the Stepper
7030
7183
  * ([see example]({% slug orientation_stepper %})).
7031
7184
  *
7032
- * The possible values are:
7033
- * * (Default) `horizontal`
7034
- * * `vertical`
7185
+ * @default 'horizontal'
7035
7186
  */
7036
7187
  orientation = 'horizontal';
7037
7188
  /**
7038
- * The index of the current step.
7189
+ * Specifies the index of the current step.
7039
7190
  */
7040
7191
  set currentStep(value) {
7041
7192
  this.stepperService.currentStep = value;
@@ -7044,8 +7195,8 @@ class StepperComponent {
7044
7195
  return this.stepperService.currentStep;
7045
7196
  }
7046
7197
  /**
7047
- * The collection of steps that will be rendered in the Stepper.
7048
- * ([see example]({% slug step_appearance_stepper %}))
7198
+ * Specifies the collection of steps that will be rendered in the Stepper
7199
+ * ([see example]({% slug step_appearance_stepper %})).
7049
7200
  */
7050
7201
  set steps(steps) {
7051
7202
  if (isPresent(steps) && steps.length > 0) {
@@ -7056,8 +7207,8 @@ class StepperComponent {
7056
7207
  return this._steps;
7057
7208
  }
7058
7209
  /**
7059
- * Defines an SVG icon to be rendered inside the step indicator instead of the default numeric or text content.
7060
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7210
+ * Specifies an SVG icon to be rendered inside the step indicator instead of the default numeric or text content.
7211
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7061
7212
  */
7062
7213
  set svgIcon(icon) {
7063
7214
  this._svgIcon = icon;
@@ -7066,42 +7217,38 @@ class StepperComponent {
7066
7217
  return this._svgIcon;
7067
7218
  }
7068
7219
  /**
7069
- * Defines an SVGIcon to be rendered for the success icon.
7070
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7220
+ * Specifies an SVG icon to be rendered for the success icon.
7221
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7071
7222
  */
7072
7223
  successSVGIcon;
7073
7224
  /**
7074
- * Defines an SVGIcon to be rendered for the error icon.
7075
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7225
+ * Specifies an SVG icon to be rendered for the error icon.
7226
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7076
7227
  */
7077
7228
  errorSVGIcon;
7078
7229
  /**
7079
- * Specifies a custom icon that will be rendered inside the step
7080
- * for valid previous steps.
7230
+ * Specifies an SVG icon that will be rendered inside the step for valid previous steps.
7231
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7081
7232
  */
7082
7233
  successIcon;
7083
7234
  /**
7084
- * Specifies a custom icon that will be rendered inside the step
7085
- * for invalid previous steps.
7086
- */
7235
+ * Specifies an SVG icon that will be rendered inside the step for invalid previous steps.
7236
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7237
+ */
7087
7238
  errorIcon;
7088
7239
  /**
7089
- * Specifies the duration of the progress indicator animation in milliseconds. Defaults to `400ms`.
7240
+ * Specifies the duration of the progress indicator animation in milliseconds.
7090
7241
  *
7091
- * The possible values are:
7092
- * * Boolean
7093
- * * (Default) `true`
7094
- * * false
7095
- * * Number
7242
+ * @default true
7096
7243
  */
7097
7244
  animation = true;
7098
7245
  /**
7099
- * Fires when a step is about to be activated. This event is preventable.
7246
+ * Fires when a step is about to be activated. You can prevent this event.
7100
7247
  */
7101
7248
  activate = new EventEmitter();
7102
7249
  /**
7103
7250
  * Fires when the `currentStep` property of the component was updated.
7104
- * Used to provide a two-way binding for the `currentStep` property.
7251
+ * Use this event to provide a two-way binding for the `currentStep` property.
7105
7252
  */
7106
7253
  currentStepChange = new EventEmitter();
7107
7254
  /**
@@ -7388,23 +7535,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
7388
7535
  }] } });
7389
7536
 
7390
7537
  /**
7391
- * Arguments for the `activate` event of the Stepper.
7538
+ * Represents the arguments for the `activate` event of the Stepper.
7392
7539
  */
7393
7540
  class StepperActivateEvent extends PreventableEvent$1 {
7394
7541
  /**
7395
- * The index of the activated step in the `steps` collection.
7542
+ * Specifies the index of the activated step in the `steps` collection.
7396
7543
  */
7397
7544
  index;
7398
7545
  /**
7399
- * The activated step.
7546
+ * Specifies the activated step.
7400
7547
  */
7401
7548
  step;
7402
7549
  /**
7403
- * The DOM event that triggered the step activation.
7550
+ * Specifies the DOM event that triggered the step activation.
7404
7551
  */
7405
7552
  originalEvent;
7406
7553
  /**
7407
- * The Stepper that triggered the event.
7554
+ * Specifies the Stepper that triggered the event.
7408
7555
  */
7409
7556
  sender;
7410
7557
  /**
@@ -7417,8 +7564,16 @@ class StepperActivateEvent extends PreventableEvent$1 {
7417
7564
  }
7418
7565
 
7419
7566
  /**
7420
- * Custom component messages override default component messages
7567
+ * Provides custom component messages that override default component messages
7421
7568
  * ([see example]({% slug rtl_layout %})).
7569
+ *
7570
+ * ```html
7571
+ * <kendo-stepper>
7572
+ * <kendo-stepper-messages
7573
+ * optional="Optional step"
7574
+ * ></kendo-stepper-messages>
7575
+ * </kendo-stepper>
7576
+ * ```
7422
7577
  */
7423
7578
  class StepperCustomMessagesComponent extends StepperMessages {
7424
7579
  service;
@@ -7457,7 +7612,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
7457
7612
  */
7458
7613
  class Messages extends ComponentMessages {
7459
7614
  /**
7460
- * The alt attribute text of the image in the avatar.
7615
+ * Defines the alt attribute text of the image in the Avatar.
7461
7616
  */
7462
7617
  avatarAlt;
7463
7618
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: Messages, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -7510,7 +7665,26 @@ const DEFAULT_SIZE = 'medium';
7510
7665
  const DEFAULT_THEME_COLOR = 'primary';
7511
7666
  const DEFAULT_FILL_MODE = 'solid';
7512
7667
  /**
7513
- * Displays images, icons or initials representing people or other entities.
7668
+ * Represents the Kendo UI Avatar component for Angular. Displays images, icons, or initials representing people or other entities.
7669
+ *
7670
+ * @example
7671
+ * ```typescript
7672
+ * @Component({
7673
+ * selector: 'my-app',
7674
+ * template: `
7675
+ * <kendo-avatar [imageSrc]="userImage" size="large"></kendo-avatar>
7676
+ * <kendo-avatar [initials]="userInitials" themeColor="primary"></kendo-avatar>
7677
+ * <kendo-avatar [icon]="userIcon" fillMode="outline"></kendo-avatar>
7678
+ * `
7679
+ * })
7680
+ * class AppComponent {
7681
+ * userImage = 'path/to/image.jpg';
7682
+ * userInitials = 'JD';
7683
+ * userIcon = 'user';
7684
+ * }
7685
+ * ```
7686
+ * @remarks
7687
+ * Supported children components are: {@link AvatarCustomMessagesComponent}.
7514
7688
  */
7515
7689
  class AvatarComponent {
7516
7690
  localization;
@@ -7537,14 +7711,10 @@ class AvatarComponent {
7537
7711
  this.rounded = mapShapeToRounded(shape);
7538
7712
  }
7539
7713
  /**
7540
- * Specifies the size of the avatar
7714
+ * Specifies the size of the Avatar
7541
7715
  * ([see example]({% slug appearance_avatar %}#toc-size)).
7542
7716
  *
7543
- * The possible values are:
7544
- * * `small`
7545
- * * `medium` (Default)
7546
- * * `large`
7547
- * * `none`
7717
+ * @default 'medium'
7548
7718
  */
7549
7719
  set size(size) {
7550
7720
  if (size !== this._size) {
@@ -7557,15 +7727,10 @@ class AvatarComponent {
7557
7727
  return this._size;
7558
7728
  }
7559
7729
  /**
7560
- * Specifies the rounded styling of the avatar
7730
+ * Specifies the rounded styling of the Avatar
7561
7731
  * ([see example](slug:appearance_avatar#toc-roundness)).
7562
7732
  *
7563
- * The possible values are:
7564
- * * `small`
7565
- * * `medium`
7566
- * * `large`
7567
- * * `full` (Default)
7568
- * * `none`
7733
+ * @default 'full'
7569
7734
  */
7570
7735
  set rounded(rounded) {
7571
7736
  if (rounded !== this._rounded) {
@@ -7578,22 +7743,10 @@ class AvatarComponent {
7578
7743
  return this._rounded;
7579
7744
  }
7580
7745
  /**
7581
- * Specifies the theme color of the avatar.
7582
- * The theme color will be applied as background and border color, while also amending the text color accordingly.
7746
+ * Specifies the theme color of the Avatar.
7747
+ * The theme color applies as background and border color while adjusting the text color accordingly.
7583
7748
  *
7584
- * The possible values are:
7585
- * * `base`&mdash; Applies the base coloring value.
7586
- * * `primary` (Default)&mdash;Applies coloring based on primary theme color.
7587
- * * `secondary`&mdash;Applies coloring based on secondary theme color.
7588
- * * `tertiary`&mdash; Applies coloring based on tertiary theme color.
7589
- * * `info`&mdash;Applies coloring based on info theme color.
7590
- * * `success`&mdash; Applies coloring based on success theme color.
7591
- * * `warning`&mdash; Applies coloring based on warning theme color.
7592
- * * `error`&mdash; Applies coloring based on error theme color.
7593
- * * `dark`&mdash; Applies coloring based on dark theme color.
7594
- * * `light`&mdash; Applies coloring based on light theme color.
7595
- * * `inverse`&mdash; Applies coloring based on inverted theme color.
7596
- * * `none`&mdash; Removes the styling associated with the theme color.
7749
+ * @default 'primary'
7597
7750
  */
7598
7751
  set themeColor(themeColor) {
7599
7752
  if (themeColor !== this._themeColor) {
@@ -7606,12 +7759,9 @@ class AvatarComponent {
7606
7759
  return this._themeColor;
7607
7760
  }
7608
7761
  /**
7609
- * Specifies the appearance fill style of the avatar.
7762
+ * Specifies the fill style of the Avatar.
7610
7763
  *
7611
- * The possible values are:
7612
- * * `solid` (Default)
7613
- * * `outline`
7614
- * * `none`
7764
+ * @default 'solid'
7615
7765
  */
7616
7766
  set fillMode(fillMode) {
7617
7767
  if (fillMode !== this.fillMode) {
@@ -7633,17 +7783,18 @@ class AvatarComponent {
7633
7783
  this.fillMode = fillMode;
7634
7784
  }
7635
7785
  /**
7636
- * Sets a border to the avatar.
7786
+ * Adds a border to the Avatar.
7787
+ *
7788
+ * @default false
7637
7789
  */
7638
7790
  border = false;
7639
7791
  /**
7640
- * Defines a CSS class or multiple classes separated by spaces
7641
- * which are applied to a span element inside the avatar.
7642
- * Allows the usage of custom icons.
7792
+ * Defines a CSS class or multiple classes separated by spaces.
7793
+ * You can apply these classes to a `span` element inside the Avatar and also use custom icons.
7643
7794
  */
7644
7795
  iconClass;
7645
7796
  /**
7646
- * Sets the width of the avatar.
7797
+ * Sets the width of the Avatar.
7647
7798
  */
7648
7799
  width;
7649
7800
  /**
@@ -7653,7 +7804,7 @@ class AvatarComponent {
7653
7804
  return this.width;
7654
7805
  }
7655
7806
  /**
7656
- * Sets the height of the avatar.
7807
+ * Sets the height of the Avatar.
7657
7808
  */
7658
7809
  height;
7659
7810
  /**
@@ -7663,26 +7814,26 @@ class AvatarComponent {
7663
7814
  return this.height;
7664
7815
  }
7665
7816
  /**
7666
- * The CSS styles that will be rendered on the content element of the avatar.
7667
- * Supports the type of values that are supported by [ngStyle](link:site.data.urls.angular['ngstyleapi']).
7817
+ * Defines the CSS styles that render on the content element of the Avatar.
7818
+ * Supports the type of values that [`ngStyle`](link:site.data.urls.angular['ngstyleapi']) supports.
7668
7819
  */
7669
7820
  cssStyle;
7670
7821
  /**
7671
- * Sets `initials` to the avatar.
7822
+ * Sets the initials for the Avatar.
7672
7823
  */
7673
7824
  initials;
7674
7825
  /**
7675
- * Sets the `icon` for the avatar.
7826
+ * Sets the icon for the Avatar.
7676
7827
  * All [Kendo UI Icons](slug:icons#icons-list) are supported.
7677
7828
  */
7678
7829
  icon;
7679
7830
  /**
7680
- * Sets the `image` source of the avatar.
7831
+ * Sets the image source of the Avatar.
7681
7832
  */
7682
7833
  imageSrc;
7683
7834
  /**
7684
- * Defines an SVGIcon to be rendered.
7685
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7835
+ * Defines an SVG icon to render.
7836
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
7686
7837
  */
7687
7838
  set svgIcon(icon) {
7688
7839
  if (isDevMode() && icon && this.icon && this.iconClass) {
@@ -7900,8 +8051,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
7900
8051
 
7901
8052
  // eslint-disable no-forward-ref
7902
8053
  /**
7903
- * Custom component messages override default component messages
8054
+ * Provides custom component messages that override default component messages
7904
8055
  * ([see example]({% slug rtl_layout %})).
8056
+ *
8057
+ * ```html
8058
+ * <kendo-avatar>
8059
+ * <kendo-avatar-messages
8060
+ * avatarAlt="User's profile picture"
8061
+ * ></kendo-avatar-messages>
8062
+ * </kendo-avatar>
8063
+ * ```
7905
8064
  */
7906
8065
  class AvatarCustomMessagesComponent extends Messages {
7907
8066
  service;
@@ -7936,7 +8095,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
7936
8095
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
7937
8096
 
7938
8097
  /**
7939
- * Represents the [Kendo UI Card component for Angular]({% slug overview_card %})
8098
+ * Represents the Kendo UI Card component for Angular.
8099
+ * Displays content in a structured container with customizable layout and styling ([Card overview]({% slug overview_card %})).
8100
+ *
8101
+ * @example
8102
+ * ```html
8103
+ * <kendo-card orientation="vertical">
8104
+ * <kendo-card-header>
8105
+ * <h5 kendoCardTitle>Card Title</h5>
8106
+ * </kendo-card-header>
8107
+ * <kendo-card-body>
8108
+ * <p>Card content goes here.</p>
8109
+ * </kendo-card-body>
8110
+ * </kendo-card>
8111
+ * ```
8112
+ * @remarks
8113
+ * Supported children components are: {@link CardFooterComponent}, {@link CardHeaderComponent}, {@link CardActionsComponent}, {@link CardBodyComponent}.
7940
8114
  */
7941
8115
  class CardComponent {
7942
8116
  localizationService;
@@ -7957,15 +8131,13 @@ class CardComponent {
7957
8131
  /**
7958
8132
  * Specifies the layout of the Card content.
7959
8133
  *
7960
- * The possible values are:
7961
- * * (Default) `vertical`
7962
- * * `horizontal`
7963
- *
8134
+ * @default 'vertical'
7964
8135
  */
7965
8136
  orientation = 'vertical';
7966
8137
  /**
7967
8138
  * Defines the width of the Card.
7968
- * Defaults to `285px`.
8139
+ *
8140
+ * @default '285px'
7969
8141
  */
7970
8142
  width = '285px';
7971
8143
  dynamicRTLSubscription;
@@ -8032,7 +8204,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8032
8204
  }] } });
8033
8205
 
8034
8206
  /**
8035
- * Specifies the content in the Card header.
8207
+ * Defines the content in the Card header.
8208
+ * The header can include a title, subtitle, and other elements that provide context for the Card's content.
8209
+ *
8210
+ * @example
8211
+ * ```html
8212
+ * <kendo-card-header>
8213
+ * <h5 kendoCardTitle>Card Title</h5>
8214
+ * <p kendoCardSubtitle>Card Subtitle</p>
8215
+ * </kendo-card-header>
8216
+ * ```
8036
8217
  */
8037
8218
  class CardHeaderComponent {
8038
8219
  hostClass = true;
@@ -8056,7 +8237,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8056
8237
  }] } });
8057
8238
 
8058
8239
  /**
8059
- * Specifies the content in the Card body.
8240
+ * Defines the content in the Card body.
8241
+ * The body is the main area of the Card where the primary content is displayed.
8242
+ *
8243
+ * @example
8244
+ * ```html
8245
+ * <kendo-card-body>
8246
+ * <p>Main content of the card.</p>
8247
+ * </kendo-card-body>
8248
+ * ```
8060
8249
  */
8061
8250
  class CardBodyComponent {
8062
8251
  hostClass = true;
@@ -8080,7 +8269,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8080
8269
  }] } });
8081
8270
 
8082
8271
  /**
8083
- * Specifies the content in the Card footer.
8272
+ * Defines the content in the Card footer.
8273
+ * The footer can include additional information, actions, or links related to the Card's content.
8274
+ *
8275
+ * @example
8276
+ * ```html
8277
+ * <kendo-card-footer>
8278
+ * <p>Footer content</p>
8279
+ * </kendo-card-footer>
8280
+ * ```
8084
8281
  */
8085
8282
  class CardFooterComponent {
8086
8283
  hostClass = true;
@@ -8104,8 +8301,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8104
8301
  }] } });
8105
8302
 
8106
8303
  /**
8107
- * Specifies the action buttons of the Card.
8108
- * * ([see example]({% slug actions_card %})).
8304
+ * Defines the action buttons of the Card ([see example]({% slug actions_card %})).
8305
+ * The Card actions can be used to perform operations related to the Card's content, such as saving, editing, or deleting.
8306
+ *
8307
+ * @example
8308
+ * ```html
8309
+ * <kendo-card-actions
8310
+ * layout="end"
8311
+ * orientation="horizontal">
8312
+ * </kendo-card-actions>
8313
+ * ```
8109
8314
  */
8110
8315
  class CardActionsComponent {
8111
8316
  hostClass = true;
@@ -8128,27 +8333,20 @@ class CardActionsComponent {
8128
8333
  return this.orientation === 'horizontal';
8129
8334
  }
8130
8335
  /**
8131
- * Specifies the layout of the Card action buttons.
8132
- *
8133
- * * The possible values are:
8134
- * * (Default) `horizontal`
8135
- * * `vertical`
8336
+ * Specifies the orientation of the Card action buttons.
8136
8337
  *
8338
+ * @default 'horizontal'
8137
8339
  */
8138
8340
  orientation = 'horizontal';
8139
8341
  /**
8140
8342
  * Specifies the layout of the Card action buttons.
8141
8343
  *
8142
- * The possible values are:
8143
- * * (Default) `start`
8144
- * * `center`
8145
- * * `end`
8146
- * * `stretched`
8147
- *
8344
+ * @default 'start'
8148
8345
  */
8149
8346
  layout = 'start';
8150
8347
  /**
8151
- * Allows the declarative specification of the Card actions.
8348
+ * Defines the Card actions declaratively.
8349
+ * You can pass an array of `CardAction` objects or a `TemplateRef`.
8152
8350
  */
8153
8351
  set actions(value) {
8154
8352
  if (Array.isArray(value)) {
@@ -8159,7 +8357,7 @@ class CardActionsComponent {
8159
8357
  }
8160
8358
  }
8161
8359
  /**
8162
- * Fires when the user clicks an action button.
8360
+ * Fires when you click an action button.
8163
8361
  */
8164
8362
  action = new EventEmitter();
8165
8363
  /**
@@ -8264,7 +8462,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8264
8462
  }] } });
8265
8463
 
8266
8464
  /**
8267
- * Specifies a separator in the content of the Card.
8465
+ * Defines a separator in the content of the Card.
8466
+ * The separator can be used to visually divide sections within the Card.
8467
+ *
8468
+ * ```html
8469
+ * <kendo-card>
8470
+ * <div kendoCardSeparator></div>
8471
+ * <p>Content below the separator</p>
8472
+ * </kendo-card>
8473
+ * ```
8268
8474
  */
8269
8475
  class CardSeparatorDirective {
8270
8476
  hostClass = true;
@@ -8281,9 +8487,7 @@ class CardSeparatorDirective {
8281
8487
  /**
8282
8488
  * Specifies the orientation of the Card separator.
8283
8489
  *
8284
- * The possible values are:
8285
- * (Default) `horizontal`
8286
- * `vertical`
8490
+ * @default 'horizontal'
8287
8491
  */
8288
8492
  orientation = 'horizontal';
8289
8493
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: CardSeparatorDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
@@ -8314,7 +8518,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8314
8518
  }] } });
8315
8519
 
8316
8520
  /**
8317
- * Specifies the text and styles for the title of the Card.
8521
+ * Defines the text and styles for the title of the Card.
8522
+ * The title is displayed at the top of the Card, above the subtitle and content.
8523
+ *
8524
+ * ```html
8525
+ * <kendo-card>
8526
+ * <h3 kendoCardTitle>Card Title</h3>
8527
+ * </kendo-card>
8528
+ * ```
8318
8529
  */
8319
8530
  class CardTitleDirective {
8320
8531
  hostClass = true;
@@ -8333,7 +8544,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8333
8544
  }] } });
8334
8545
 
8335
8546
  /**
8336
- * Specifies the text and styles for the subtitle of the Card.
8547
+ * Defines the text and styles for the subtitle of the Card.
8548
+ * The subtitle is displayed below the title and above the content of the Card.
8549
+ *
8550
+ * ```html
8551
+ * <kendo-card>
8552
+ * <h4 kendoCardSubtitle>Card Subtitle</h4>
8553
+ * </kendo-card>
8554
+ * ```
8337
8555
  */
8338
8556
  class CardSubtitleDirective {
8339
8557
  hostClass = true;
@@ -8352,7 +8570,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8352
8570
  }] } });
8353
8571
 
8354
8572
  /**
8355
- * Specifies any media that will be displayed and aligned in the Card.
8573
+ * Defines any media that displays and aligns in the Card.
8574
+ * The media can be an image, video, or any other media type.
8575
+ *
8576
+ * ```html
8577
+ * <kendo-card>
8578
+ * <div kendoCardMedia>
8579
+ * <img src="path/to/image.jpg" alt="Card Media">
8580
+ * </div>
8581
+ * </kendo-card>
8582
+ * ```
8356
8583
  */
8357
8584
  class CardMediaDirective {
8358
8585
  hostClass = true;
@@ -8371,28 +8598,37 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8371
8598
  }] } });
8372
8599
 
8373
8600
  /**
8374
- * The settings of the Card action buttons.
8601
+ * Defines the settings of the Card action buttons.
8375
8602
  */
8376
8603
  class CardAction {
8377
8604
  /**
8378
- * Determines if the action button is styled as a primary button.
8605
+ * Specifies whether the action button uses primary styling.
8379
8606
  */
8380
8607
  primary;
8381
8608
  /**
8382
- * Determines if the action button is styled as a flat button.
8609
+ * Specifies whether the action button uses flat styling.
8383
8610
  */
8384
8611
  flat;
8385
8612
  /**
8386
- * The text of the action button.
8613
+ * Defines the text of the action button.
8387
8614
  */
8388
8615
  text;
8389
8616
  }
8390
8617
 
8391
8618
  /**
8392
- * Represents a template that defines the content of the ExpansionPanel title.
8393
- * To define the template, nest an `<ng-template>` tag
8394
- * with the `kendoExpansionPanelTitleDirective` directive inside the `<kendo-expansionpanel>` tag.
8619
+ * Defines a template that specifies the content of the ExpansionPanel title.
8620
+ * To define the template, nest an `<ng-template>` tag with the `kendoExpansionPanelTitleDirective` directive inside the `<kendo-expansionpanel>` tag
8395
8621
  * ([see example]({% slug title_expansionpanel %}#toc-title-template)).
8622
+ *
8623
+ * @example
8624
+ * ```html
8625
+ * <kendo-expansionpanel>
8626
+ * <ng-template kendoExpansionPanelTitleDirective>
8627
+ * <h3>Custom Title</h3>
8628
+ * </ng-template>
8629
+ * <p>Panel content</p>
8630
+ * </kendo-expansionpanel>
8631
+ * ```
8396
8632
  */
8397
8633
  class ExpansionPanelTitleDirective {
8398
8634
  templateRef;
@@ -8432,11 +8668,11 @@ function collapse(duration, height) {
8432
8668
  }
8433
8669
 
8434
8670
  /**
8435
- * Arguments for the `action` event of the ExpansionPanel.
8671
+ * Defines the arguments for the `action` event of the ExpansionPanel.
8436
8672
  */
8437
8673
  class ExpansionPanelActionEvent extends PreventableEvent$1 {
8438
8674
  /**
8439
- * The action that will take place upon interaction with the ExpansionPanel.
8675
+ * Defines the action that takes place upon interaction with the ExpansionPanel.
8440
8676
  */
8441
8677
  action;
8442
8678
  /**
@@ -8451,19 +8687,16 @@ class ExpansionPanelActionEvent extends PreventableEvent$1 {
8451
8687
  const DEFAULT_DURATION = 200;
8452
8688
  const CONTENT_HIDDEN_CLASS = 'k-hidden';
8453
8689
  /**
8454
- * Represents the [Kendo UI ExpansionPanel component for Angular]({% slug overview_expansionpanel %}).
8690
+ * Represents the Kendo UI ExpansionPanel component for Angular. Provides an expandable and collapsible content container with customizable header and animation ([see overview]({% slug overview_expansionpanel %})).
8455
8691
  *
8456
8692
  * @example
8457
- * ```ts-preview
8458
- * _@Component({
8459
- * selector: 'my-app',
8460
- * template: `
8461
- * <kendo-expansionpanel title="Chile" subtitle="South America">
8462
- * There are various theories about the origin of the word Chile.
8463
- * </kendo-expansionpanel>
8464
- * `
8465
- * })
8466
- * class AppComponent {}
8693
+ * ```html
8694
+ * <kendo-expansionpanel
8695
+ * title="Chile"
8696
+ * subtitle="South America"
8697
+ * [expanded]="isExpanded">
8698
+ * There are various theories about the origin of the word Chile.
8699
+ * </kendo-expansionpanel>
8467
8700
  * ```
8468
8701
  */
8469
8702
  class ExpansionPanelComponent {
@@ -8478,7 +8711,7 @@ class ExpansionPanelComponent {
8478
8711
  */
8479
8712
  title = '';
8480
8713
  /**
8481
- * Specifies the secondary text in the header of the ExpansionPanel, which is rendered next to the collapse/expand icon
8714
+ * Specifies the secondary text in the header of the ExpansionPanel, which renders next to the collapse/expand icon
8482
8715
  * ([see example](slug:title_expansionpanel#toc-titles-and-subtitles)).
8483
8716
  */
8484
8717
  subtitle = '';
@@ -8490,7 +8723,7 @@ class ExpansionPanelComponent {
8490
8723
  */
8491
8724
  disabled = false;
8492
8725
  /**
8493
- * Specifies whether the ExpansionPanel is expanded. The property supports two-way binding.
8726
+ * Specifies whether the ExpansionPanel is expanded. The property supports two-way binding
8494
8727
  * ([see example]({% slug interaction_expansionpanel %}#toc-setting-the-initial-state)).
8495
8728
  *
8496
8729
  * @default false
@@ -8511,8 +8744,8 @@ class ExpansionPanelComponent {
8511
8744
  return this._expanded;
8512
8745
  }
8513
8746
  /**
8514
- * Defines an SVGIcon for the expanded state of the component.
8515
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
8747
+ * Defines an SVG icon for the expanded state of the component.
8748
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
8516
8749
  */
8517
8750
  set svgExpandIcon(icon) {
8518
8751
  if (isDevMode() && icon && this.expandIcon) {
@@ -8524,8 +8757,8 @@ class ExpansionPanelComponent {
8524
8757
  return this._svgExpandIcon;
8525
8758
  }
8526
8759
  /**
8527
- * Defines an SVGIcon for the collapsed state of the component.
8528
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
8760
+ * Defines an SVG icon for the collapsed state of the component.
8761
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
8529
8762
  */
8530
8763
  set svgCollapseIcon(icon) {
8531
8764
  if (isDevMode() && icon && this.collapseIcon) {
@@ -8537,12 +8770,12 @@ class ExpansionPanelComponent {
8537
8770
  return this._svgCollapseIcon;
8538
8771
  }
8539
8772
  /**
8540
- * Sets a custom icon via css class(es), for the collapsed state of the component
8773
+ * Sets a custom icon via CSS class(es) for the collapsed state of the component
8541
8774
  * ([see example]({% slug icons_expansionpanel %}#toc-icons)).
8542
8775
  */
8543
8776
  expandIcon;
8544
8777
  /**
8545
- * Sets a custom icon via css class(es), for the expanded state of the component
8778
+ * Sets a custom icon via CSS class(es) for the expanded state of the component
8546
8779
  * ([see example]({% slug icons_expansionpanel %}#toc-icons)).
8547
8780
  */
8548
8781
  collapseIcon;
@@ -8550,11 +8783,7 @@ class ExpansionPanelComponent {
8550
8783
  * Specifies the animation settings of the ExpansionPanel
8551
8784
  * ([see example]({% slug animations_expansionpanel %})).
8552
8785
  *
8553
- * The possible values are:
8554
- * * Boolean
8555
- * * (Default) `true` Numeric values represent duration. Default duration is 200ms.
8556
- * * false
8557
- * * Number
8786
+ * @default true
8558
8787
  */
8559
8788
  animation = true;
8560
8789
  /**
@@ -8569,12 +8798,12 @@ class ExpansionPanelComponent {
8569
8798
  */
8570
8799
  action = new EventEmitter();
8571
8800
  /**
8572
- * Fires when the ExpansionPanel is expanded. If there is animation it will fire when the animation is complete
8801
+ * Fires when the ExpansionPanel is expanded. If there is animation it fires when the animation is complete
8573
8802
  * ([see example](slug:events_expansionpanel)).
8574
8803
  */
8575
8804
  expand = new EventEmitter();
8576
8805
  /**
8577
- * Fires when the ExpansionPanel is collapsed. If there is animation it will fire when the animation is complete
8806
+ * Fires when the ExpansionPanel is collapsed. If there is animation it fires when the animation is complete
8578
8807
  * ([see example](slug:events_expansionpanel)).
8579
8808
  */
8580
8809
  collapse = new EventEmitter();
@@ -8714,7 +8943,7 @@ class ExpansionPanelComponent {
8714
8943
  * Toggles the visibility of the ExpansionPanel
8715
8944
  * ([see example](slug:interaction_expansionpanel#toggling-between-states)).
8716
8945
  *
8717
- * @param expanded? - Boolean. Specifies, whether the ExpansionPanel will be expanded or collapsed.
8946
+ * @param expanded Specifies whether the ExpansionPanel will be expanded or collapsed.
8718
8947
  */
8719
8948
  toggle(expanded) {
8720
8949
  const previous = this.expanded;
@@ -9131,8 +9360,9 @@ const REVERSE_OVERLAP_THRESHOLD = -0.7;
9131
9360
  const HINT_BORDERS_HEIGHT = 2;
9132
9361
 
9133
9362
  /**
9134
- * Arguments for the `reorder` event. The event fires when the order or starting
9135
- * positions of the items is changed via the UI. If you prevent the event, the change is canceled ([see example]({% slug reordering_tilelayout %}#toc-handling-the-reorder-event)).
9363
+ * Arguments for the `reorder` event.
9364
+ * The event fires when you change the order or starting positions of items through the UI.
9365
+ * You can prevent this event to cancel the reorder operation.
9136
9366
  */
9137
9367
  class TileLayoutReorderEvent extends PreventableEvent$1 {
9138
9368
  item;
@@ -9169,8 +9399,9 @@ class TileLayoutReorderEvent extends PreventableEvent$1 {
9169
9399
  }
9170
9400
 
9171
9401
  /**
9172
- * Arguments for the `resize` event. The `resize` event fires when any item size
9173
- * is changed from the UI. If you cancel the event, the change is prevented ([see example]({% slug resizing_tilelayout %}#toc-handling-the-resize-event)).
9402
+ * Arguments for the `resize` event.
9403
+ * The `resize` event fires when you change any item size through the UI.
9404
+ * You can prevent this event to stop the resize operation.
9174
9405
  */
9175
9406
  class TileLayoutResizeEvent extends PreventableEvent$1 {
9176
9407
  item;
@@ -9785,8 +10016,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9785
10016
  }], ctorParameters: function () { return [{ type: i0.NgZone }, { type: i0.Renderer2 }, { type: i1.LocalizationService }]; } });
9786
10017
 
9787
10018
  /**
9788
- * Holds the content of the header section of the TileLayoutItem component.
9789
- * This is the area which can be dragged to reorder the items if reordering is enabled for this item.
10019
+ * Contains the header content of the `TileLayoutItem` component.
10020
+ * You can drag this area to reorder items when reordering is enabled.
10021
+ *
10022
+ * @example
10023
+ * ```html
10024
+ * <kendo-tilelayout-item>
10025
+ * <kendo-tilelayout-item-header>
10026
+ * <h3>Custom Header</h3>
10027
+ * </kendo-tilelayout-item-header>
10028
+ * <p>Item content</p>
10029
+ * </kendo-tilelayout-item>
10030
+ * ```
9790
10031
  */
9791
10032
  class TileLayoutItemHeaderComponent {
9792
10033
  hostClass = true;
@@ -9869,6 +10110,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9869
10110
 
9870
10111
  /**
9871
10112
  * Represents a tile item within the TileLayoutComponent.
10113
+ *
10114
+ * @example
10115
+ * ```html
10116
+ * <kendo-tilelayout>
10117
+ * <kendo-tilelayout-item [title]="'Item 1'" [colSpan]="2">
10118
+ * <p>Item content goes here</p>
10119
+ * </kendo-tilelayout-item>
10120
+ * </kendo-tilelayout>
10121
+ * ```
10122
+ * @remarks
10123
+ * Supported children components are: {@link TileLayoutItemBodyComponent}, {@link TileLayoutItemHeaderComponent}.
9872
10124
  */
9873
10125
  class TileLayoutItemComponent {
9874
10126
  elem;
@@ -9878,23 +10130,22 @@ class TileLayoutItemComponent {
9878
10130
  draggingService;
9879
10131
  keyboardNavigationService;
9880
10132
  /**
9881
- * The title that will be rendered in the item header ([see example]({% slug tiles_tilelayout %}#toc-tiles-configuration)).
10133
+ * Sets the title text that appears in the item header ([see example]({% slug tiles_tilelayout %}#toc-tiles-configuration)).
9882
10134
  */
9883
10135
  title;
9884
10136
  /**
9885
- * Determines how many rows will the tile item span ([see example](slug:resizing_tilelayout#programmatic-resizing)).
10137
+ * Sets how many rows the tile item spans ([see example](slug:resizing_tilelayout#programmatic-resizing)).
9886
10138
  * @default 1
9887
10139
  */
9888
10140
  rowSpan = 1;
9889
10141
  /**
9890
- * Determines how many columns will the tile item span ([see example](slug:resizing_tilelayout#programmatic-resizing)).
10142
+ * Sets how many columns the tile item spans ([see example](slug:resizing_tilelayout#programmatic-resizing)).
9891
10143
  * @default 1
9892
10144
  */
9893
10145
  colSpan = 1;
9894
10146
  /**
9895
- * Determines the order of the tile items within the TileLayout.
9896
- * If not set, the items will receive increasing sequential order in accordance with
9897
- * their position in the DOM when initially rendered.
10147
+ * Sets the order of the tile item within the TileLayout.
10148
+ * When not set, items receive increasing order values based on their DOM position.
9898
10149
  */
9899
10150
  set order(value) {
9900
10151
  this._order = value;
@@ -9904,21 +10155,21 @@ class TileLayoutItemComponent {
9904
10155
  return this._order;
9905
10156
  }
9906
10157
  /**
9907
- * Sets the starting column of the item ([see example](slug:tiles_tilelayout#size-and-position)).
10158
+ * Sets the starting column position of the item ([see example](slug:tiles_tilelayout#size-and-position)).
9908
10159
  */
9909
10160
  col;
9910
10161
  /**
9911
- * Sets the starting row of the item ([see example](slug:tiles_tilelayout#size-and-position)).
10162
+ * Sets the starting row position of the item ([see example](slug:tiles_tilelayout#size-and-position)).
9912
10163
  */
9913
10164
  row;
9914
10165
  /**
9915
- * Determines whether the item can be reordered. By default all items are reorderable when the [reorderable]({% slug api_layout_tilelayoutcomponent %}#toc-reorderable) property of the TileLayoutComponent is set to `true` ([see example]({% slug reordering_tilelayout %}#toc-disabling-reordering)).
10166
+ * Enables or disables individual item reordering.
9916
10167
  *
9917
10168
  * @default true
9918
10169
  */
9919
10170
  reorderable = true;
9920
10171
  /**
9921
- * Determines whether the item can be resized. By default all items are resizable when the [resizable]({% slug api_layout_tilelayoutcomponent %}#resizable) property of the TileLayoutComponent is set to `true` ([see example](slug:resizing_tilelayout#toc-disabling-resizing)).
10172
+ * Enables or disables individual item resizing.
9922
10173
  * @default true
9923
10174
  */
9924
10175
  resizable = true;
@@ -10164,6 +10415,16 @@ const autoFlowClasses = {
10164
10415
  };
10165
10416
  /**
10166
10417
  * Represents the [Kendo UI TileLayout component for Angular]({% slug overview_tilelayout %})
10418
+ *
10419
+ * @example
10420
+ * ```html
10421
+ * <kendo-tilelayout [columns]="3" [gap]="10">
10422
+ * <kendo-tilelayout-item>Content 1</kendo-tilelayout-item>
10423
+ * <kendo-tilelayout-item>Content 2</kendo-tilelayout-item>
10424
+ * </kendo-tilelayout>
10425
+ * ```
10426
+ * @remarks
10427
+ * Supported children components are: {@link TileLayoutItemComponent}.
10167
10428
  */
10168
10429
  class TileLayoutComponent {
10169
10430
  zone;
@@ -10173,22 +10434,22 @@ class TileLayoutComponent {
10173
10434
  draggingService;
10174
10435
  navigationService;
10175
10436
  /**
10176
- * Defines the number of columns ([see example](slug:tiles_tilelayout#size-and-position)).
10437
+ * Specifies the number of columns ([see example](slug:tiles_tilelayout#size-and-position)).
10177
10438
  * @default 1
10178
10439
  */
10179
10440
  columns = 1;
10180
10441
  /**
10181
- * Determines the width of the columns. Numeric values are treated as pixels ([see example](slug:tiles_tilelayout#size-and-position)).
10442
+ * Sets the width of the columns.
10443
+ * Use numeric values for pixels or string values for other CSS units ([see example](slug:tiles_tilelayout#size-and-position)).
10182
10444
  * @default '1fr'
10183
10445
  */
10184
10446
  columnWidth = '1fr';
10185
10447
  /**
10186
- * The numeric values which determine the spacing in pixels between the layout items horizontally and vertically.
10187
- * Properties:
10188
- * * rows - the vertical spacing. Numeric values are treated as pixels. Defaults to `16`.
10189
- * * columns - the horizontal spacing. Numeric values are treated as pixels. Defaults to `16`.
10448
+ * Sets the spacing between layout items in pixels.
10449
+ * Use an object with `rows` and `columns` properties to set different horizontal and vertical spacing.
10450
+ * Use a single number to apply the same spacing to both directions.
10190
10451
  *
10191
- * When bound to a single numeric value, it will be set to both `rows` and `columns` properties.
10452
+ * @default { rows: 16, columns: 16 }
10192
10453
  */
10193
10454
  set gap(value) {
10194
10455
  this._gap = (typeof value === 'number') ? { rows: value, columns: value } : Object.assign(this._gap, value);
@@ -10197,48 +10458,42 @@ class TileLayoutComponent {
10197
10458
  return this._gap;
10198
10459
  }
10199
10460
  /**
10200
- * Determines whether the reordering functionality will be enabled ([see example]({% slug reordering_tilelayout %})).
10461
+ * Enables or disables item reordering ([see example]({% slug reordering_tilelayout %})).
10201
10462
  * @default false
10202
10463
  */
10203
10464
  reorderable = false;
10204
10465
  /**
10205
- * Determines whether the resizing functionality will be enabled ([see example]({% slug resizing_tilelayout %})).
10466
+ * Enables or disables item resizing ([see example]({% slug resizing_tilelayout %})).
10206
10467
  * @default false
10207
10468
  */
10208
10469
  resizable = false;
10209
10470
  /**
10210
- * Determines the height of the rows. Numeric values are treated as pixels ([see example](slug:tiles_tilelayout#size-and-position)).
10471
+ * Sets the height of the rows.
10472
+ * Use numeric values for pixels or string values for other CSS units ([see example](slug:tiles_tilelayout#size-and-position)).
10211
10473
  * @default '1fr'
10212
10474
  */
10213
10475
  rowHeight = '1fr';
10214
10476
  /**
10215
- * Controls how the auto-placement algorithm works, specifying exactly how auto-placed items are flowed in the TileLayout ([see example]({% slug tiles_autoflow_tilelayout %})).
10216
- * For further reference, check the [grid-auto-flow CSS article](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow).
10217
10477
  *
10218
- * The possible values are:
10219
- * * (Default) `column`
10220
- * * `row`
10221
- * * `row dense`
10222
- * * `column dense`
10223
- * * `none`
10478
+ * Controls how the auto-placement algorithm works, specifying exactly how auto-placed items are flowed in the TileLayout ([see example]({% slug tiles_autoflow_tilelayout %})).
10224
10479
  *
10480
+ * For further reference, check the [grid-auto-flow CSS article](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow).
10481
+ * @default 'column'
10225
10482
  */
10226
10483
  autoFlow = 'column';
10227
10484
  /**
10228
- * When the keyboard navigation is enabled, the user can use dedicated shortcuts to interact with the TileLayout.
10229
- * By default, navigation is enabled. To disable it and include focusable TileLayout content as a part of the natural tab sequence of the page, set the property to `false`.
10230
- *
10485
+ * Enables or disables [keyboard navigation](slug:keyboard_navigation_tilelayout).
10231
10486
  * @default true
10232
10487
  */
10233
10488
  navigable = true;
10234
10489
  /**
10235
- * Fires when the user completes the reordering of the item ([see example]({% slug reordering_tilelayout %})).
10236
- * This event is preventable. If you cancel it, the item will not be reordered.
10490
+ * Fires when item reordering is completed ([see example]({% slug reordering_tilelayout %})).
10491
+ * You can prevent this event to cancel the reorder operation.
10237
10492
  */
10238
10493
  reorder = new EventEmitter();
10239
10494
  /**
10240
- * Fires when the user completes the resizing of the item ([see example]({% slug resizing_tilelayout %})).
10241
- * This event is preventable. If you cancel it, the item will not be resized.
10495
+ * Fires when item resizing is completed ([see example]({% slug resizing_tilelayout %})).
10496
+ * You can prevent this event to cancel the resize operation.
10242
10497
  */
10243
10498
  resize = new EventEmitter();
10244
10499
  hostClass = true;
@@ -10260,7 +10515,8 @@ class TileLayoutComponent {
10260
10515
  return this.draggingService.order;
10261
10516
  }
10262
10517
  /**
10263
- * A query list of all declared [TileLayoutItemComponent]({% slug api_layout_tilelayoutitemcomponent %}) items.
10518
+ * Contains a query list of the `TileLayoutItemComponent` instances that are used in the TileLayout.
10519
+ * This allows you to access the items programmatically and manipulate their properties or listen to their events.
10264
10520
  */
10265
10521
  items;
10266
10522
  hint;
@@ -10513,7 +10769,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
10513
10769
  }] } });
10514
10770
 
10515
10771
  /**
10516
- * Holds the main content of the TileLayoutItem component.
10772
+ * Contains the main content of the `TileLayoutItem` component.
10773
+ *
10774
+ * @example
10775
+ * ```html
10776
+ * <kendo-tilelayout-item>
10777
+ * <kendo-tilelayout-item-body>
10778
+ * <p>Main content goes here</p>
10779
+ * </kendo-tilelayout-item-body>
10780
+ * </kendo-tilelayout-item>
10781
+ * ```
10517
10782
  */
10518
10783
  class TileLayoutItemBodyComponent {
10519
10784
  hostClass = true;
@@ -10642,7 +10907,23 @@ const validateGridLayoutRowsCols = (arr) => {
10642
10907
  };
10643
10908
 
10644
10909
  /**
10645
- * Represents the [Kendo UI GridLayout component for Angular]({% slug overview_gridlayout %}).
10910
+ * Represents the Kendo UI GridLayout component for Angular.
10911
+ * Arranges child components in a two-dimensional grid layout with customizable rows, columns, and gaps ([see overview]({% slug overview_gridlayout %})).
10912
+ *
10913
+ * @example
10914
+ * ```html
10915
+ * <kendo-gridlayout [rows]="[100, 200]" [cols]="['1fr', '2fr']" [gap]="10">
10916
+ * <kendo-gridlayout-item [row]="1" [col]="1">
10917
+ * <p>Item 1</p>
10918
+ * </kendo-gridlayout-item>
10919
+ * <kendo-gridlayout-item [row]="1" [col]="2">
10920
+ * <p>Item 2</p>
10921
+ * </kendo-gridlayout-item>
10922
+ * </kendo-gridlayout>
10923
+ * ```
10924
+ *
10925
+ * @remarks
10926
+ * Supported children components are: {@link GridLayoutItemComponent}.
10646
10927
  */
10647
10928
  class GridLayoutComponent {
10648
10929
  renderer;
@@ -10656,31 +10937,22 @@ class GridLayoutComponent {
10656
10937
  * Specifies the number of rows and their height
10657
10938
  * ([More details](slug:layout_gridlayout#toc-rows-and-columns)).
10658
10939
  *
10659
- * Accepts an array, which serves two purposes:
10660
- *
10661
- * The number of elements in the array defines the number of rows.
10662
- * Each array element defines the size of the corresponding row. The possible array values are:
10663
- * * `number` - Defines the size in pixels.
10664
- * * `string` - Enables the usage of arbitrary units e.g. `20%` or `auto`.
10665
- * * [GridLayoutRowSize]({% slug api_layout_gridlayoutrowsize %}) - Configuration object, which accepts a `height` key.
10940
+ * You can define rows by passing an array where the number of elements determines the number of rows or each element defines the size of the corresponding row.
10941
+ * For example, you can use CSS units like `px`, `%`, `fr`, or `auto` to define the row sizes.
10666
10942
  */
10667
10943
  rows;
10668
10944
  /**
10669
10945
  * Specifies the number of columns and their widths
10670
10946
  * ([More details](slug:layout_gridlayout#toc-rows-and-columns)).
10671
10947
  *
10672
- * Accepts an array, which serves two purposes:
10673
- *
10674
- * The number of elements in the array defines the number of columns.
10675
- * Each array element defines the size of the corresponding column. The possible array values are:
10676
- * * `number` - Defines the size in pixels.
10677
- * * `string` - Enables the usage of arbitrary units e.g. `20%` or `auto`.
10678
- * * [GridLayoutColSize]({% slug api_layout_gridlayoutcolsize %}) - Configuration object, which accepts a `width` key.
10948
+ * You can define columns by passing an array where the number of elements determines the number of columns or each element defines the size of the corresponding column.
10949
+ * For example, you can use CSS units like `px`, `%`, `fr`, or `auto` to define the column sizes.
10679
10950
  */
10680
10951
  cols;
10681
10952
  /**
10682
- * Specifies the gaps between the elements. The default value is `0`
10683
- * ([see example](slug:layout_gridlayout#toc-gap)).
10953
+ * Specifies the gaps between the elements ([see example](slug:layout_gridlayout#toc-gap)).
10954
+ *
10955
+ * @default 0
10684
10956
  */
10685
10957
  gap = 0;
10686
10958
  /**
@@ -10801,6 +11073,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
10801
11073
  type: Input
10802
11074
  }] } });
10803
11075
 
11076
+ /**
11077
+ * Represents the GridLayout item component. Defines the positioning and spanning of individual items within a GridLayout.
11078
+ *
11079
+ * @example
11080
+ * ```html
11081
+ * <kendo-gridlayout-item [row]="1" [col]="2" [rowSpan]="2" [colSpan]="1">
11082
+ * <div>Grid item content</div>
11083
+ * </kendo-gridlayout-item>
11084
+ * ```
11085
+ */
10804
11086
  class GridLayoutItemComponent {
10805
11087
  renderer;
10806
11088
  element;
@@ -10815,13 +11097,15 @@ class GridLayoutItemComponent {
10815
11097
  */
10816
11098
  col;
10817
11099
  /**
10818
- * Determines how many rows will the item span. The default size is one row
10819
- * ([see example]({% slug items_gridlayout %}#toc-size-and-position)).
11100
+ * Specifies how many rows the item spans ([see example]({% slug items_gridlayout %}#toc-size-and-position)).
11101
+ *
11102
+ * @default 1
10820
11103
  */
10821
11104
  rowSpan;
10822
11105
  /**
10823
- * Determines how many columns will the item span. The default size is one column
10824
- * ([see example]({% slug items_gridlayout %}#toc-size-and-position)).
11106
+ * Specifies how many columns the item spans ([see example]({% slug items_gridlayout %}#toc-size-and-position)).
11107
+ *
11108
+ * @default 1
10825
11109
  */
10826
11110
  colSpan;
10827
11111
  constructor(renderer, element) {
@@ -10867,7 +11151,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
10867
11151
  }] } });
10868
11152
 
10869
11153
  /**
10870
- * Represents the [Kendo UI StackLayout component for Angular]({% slug overview_stacklayout %}).
11154
+ * Represents the Kendo UI StackLayout component for Angular.
11155
+ * Arranges child components in a single row or column with customizable alignment and spacing ([see overview]({% slug overview_stacklayout %})).
11156
+ *
11157
+ * @example
11158
+ * ```html
11159
+ * <kendo-stacklayout orientation="horizontal" [gap]="16">
11160
+ * <button class="k-button">Button 1</button>
11161
+ * <button class="k-button">Button 2</button>
11162
+ * <button class="k-button">Button 3</button>
11163
+ * </kendo-stacklayout>
11164
+ * ```
10871
11165
  */
10872
11166
  class StackLayoutComponent {
10873
11167
  renderer;
@@ -10895,17 +11189,16 @@ class StackLayoutComponent {
10895
11189
  return this._align;
10896
11190
  }
10897
11191
  /**
10898
- * Specifies the gap between the inner StackLayout elements. The default value is `0`
10899
- * ([see example](slug:layout_stacklayout#toc-gap)).
11192
+ * Specifies the gap between the inner StackLayout elements ([see example](slug:layout_stacklayout#toc-gap)).
11193
+ *
11194
+ * @default 0
10900
11195
  */
10901
11196
  gap = 0;
10902
11197
  /**
10903
11198
  * Specifies the orientation of the StackLayout
10904
11199
  * ([see example]({% slug layout_stacklayout %}#toc-orientation)).
10905
11200
  *
10906
- * The possible values are:
10907
- * (Default) `horizontal`
10908
- * `vertical`
11201
+ * @default 'horizontal'
10909
11202
  */
10910
11203
  orientation = 'horizontal';
10911
11204
  _align = {
@@ -11073,8 +11366,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11073
11366
  * with the `kendoTimelineCardActionsTemplate` directive inside the `<kendo-timeline>` tag.
11074
11367
  *
11075
11368
  * The following values are available as context variables:
11076
- * - `let-event="event"` (`TimelineEvent`) - The current card's event. Also available as implicit context variable.
11077
- * - `let-index="index"` (`number`) - The current event index.
11369
+ * - `let-event="event"` (`TimelineEvent`)&mdash;The current card's event. Also available as implicit context variable.
11370
+ * - `let-index="index"` (`number`)&mdash;The current event index.
11371
+ *
11372
+ * @example
11373
+ * ```html
11374
+ * <kendo-timeline [events]="events">
11375
+ * <ng-template kendoTimelineCardActionsTemplate let-event let-index="index">
11376
+ * Content for the actions of the card with index {{ index }} and event {{ event.title }}.
11377
+ * </ng-template>
11378
+ * </kendo-timeline>
11379
+ * ```
11078
11380
  */
11079
11381
  class TimelineCardActionsTemplateDirective {
11080
11382
  templateRef;
@@ -11099,8 +11401,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11099
11401
  * with the `kendoTimelineCardBodyTemplate` directive inside the `<kendo-timeline>` tag.
11100
11402
  *
11101
11403
  * The following values are available as context variables:
11102
- * - `let-event="event"` (`TimelineEvent`) - The current card's event. Also available as implicit context variable.
11103
- * - `let-index="index"` (`number`) - The current event index.
11404
+ * - `let-event="event"` (`TimelineEvent`)&mdash;The current card's event. Also available as implicit context variable.
11405
+ * - `let-index="index"` (`number`)&mdash;The current event index.
11406
+ *
11407
+ * @example
11408
+ * ```html
11409
+ * <kendo-timeline [events]="events">
11410
+ * <ng-template kendoTimelineCardBodyTemplate let-event let-index="index">
11411
+ * Component for the body of the card with index {{ index }} and event {{ event.title }}.
11412
+ * </ng-template>
11413
+ * </kendo-timeline>
11414
+ * ```
11104
11415
  */
11105
11416
  class TimelineCardBodyTemplateDirective {
11106
11417
  templateRef;
@@ -11125,8 +11436,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11125
11436
  * with the `kendoTimelineCardHeaderTemplate` directive inside the `<kendo-timeline>` tag.
11126
11437
  *
11127
11438
  * The following values are available as context variables:
11128
- * - `let-event="event"` (`TimelineEvent`) - The current card's event. Also available as implicit context variable.
11129
- * - `let-index="index"` (`number`) - The current event index.
11439
+ * - `let-event="event"` (`TimelineEvent`)&mdash;The current card's event. Also available as implicit context variable.
11440
+ * - `let-index="index"` (`number`)&mdash;The current event index.
11441
+ *
11442
+ * @example
11443
+ * ```html
11444
+ * <kendo-timeline [events]="events">
11445
+ * <ng-template kendoTimelineCardHeaderTemplate let-event let-index="index">
11446
+ * <span class="k-event-title">Title: {{ event.title }}</span>
11447
+ * <div kendoCardSubtitle>Event number {{ index }}</div>
11448
+ * </ng-template>
11449
+ * </kendo-timeline>
11450
+ * ```
11130
11451
  */
11131
11452
  class TimelineCardHeaderTemplateDirective {
11132
11453
  templateRef;
@@ -12572,6 +12893,9 @@ const DEFAULT_EVENT_HEIGHT = 600;
12572
12893
  const DEFAULT_DATE_FORMAT = 'MMMM dd, yyyy';
12573
12894
  /**
12574
12895
  * Represents the [Kendo UI Timeline component for Angular]({% slug overview_timeline %}).
12896
+ *
12897
+ * @remarks
12898
+ * Supported children components are: {@link TimelineCustomMessagesComponent}.
12575
12899
  */
12576
12900
  class TimelineComponent {
12577
12901
  timelineService;
@@ -13005,14 +13329,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13005
13329
  }] } });
13006
13330
 
13007
13331
  /**
13008
- * Utility array that contains all `Avatar` related components and directives.
13332
+ * Use the `KENDO_AVATAR` utility array to add all Avatar-related components and directives to a standalone Angular component.
13009
13333
  */
13010
13334
  const KENDO_AVATAR = [
13011
13335
  AvatarComponent,
13012
13336
  AvatarCustomMessagesComponent
13013
13337
  ];
13014
13338
  /**
13015
- * Utility array that contains all `Card` related components and directives.
13339
+ * Use the `KENDO_CARD` utility array to add all Card-related components and directives to a standalone Angular component.
13016
13340
  */
13017
13341
  const KENDO_CARD = [
13018
13342
  CardComponent,
@@ -13026,7 +13350,7 @@ const KENDO_CARD = [
13026
13350
  CardTitleDirective
13027
13351
  ];
13028
13352
  /**
13029
- * Utility array that contains all `Drawer` related components and directives.
13353
+ * Use the `KENDO_DRAWER` utility array to add all Drawer-related components and directives to a standalone Angular component.
13030
13354
  */
13031
13355
  const KENDO_DRAWER = [
13032
13356
  DrawerComponent,
@@ -13038,21 +13362,21 @@ const KENDO_DRAWER = [
13038
13362
  DrawerItemTemplateDirective
13039
13363
  ];
13040
13364
  /**
13041
- * Utility array that contains all `ExpansionPanel` related components and directives.
13365
+ * Use the `KENDO_EXPANSIONPANEL` utility array to add all ExpansionPanel-related components and directives to a standalone Angular component.
13042
13366
  */
13043
13367
  const KENDO_EXPANSIONPANEL = [
13044
13368
  ExpansionPanelComponent,
13045
13369
  ExpansionPanelTitleDirective
13046
13370
  ];
13047
13371
  /**
13048
- * Utility array that contains all `GridLayout` related components and directives.
13372
+ * Use the `KENDO_GRIDLAYOUT` utility array to add all GridLayout-related components and directives to a standalone Angular component.
13049
13373
  */
13050
13374
  const KENDO_GRIDLAYOUT = [
13051
13375
  GridLayoutComponent,
13052
13376
  GridLayoutItemComponent
13053
13377
  ];
13054
13378
  /**
13055
- * Utility array that contains all `PanelBar` related components and directives.
13379
+ * Use the `KENDO_PANELBAR` utility array to add all PanelBar-related components and directives to a standalone Angular component.
13056
13380
  */
13057
13381
  const KENDO_PANELBAR = [
13058
13382
  PanelBarComponent,
@@ -13062,20 +13386,20 @@ const KENDO_PANELBAR = [
13062
13386
  PanelBarItemTitleDirective
13063
13387
  ];
13064
13388
  /**
13065
- * Utility array that contains all `Splitter` related components and directives.
13389
+ * Use the `KENDO_SPLITTER` utility array to add all Splitter-related components and directives to a standalone Angular component.
13066
13390
  */
13067
13391
  const KENDO_SPLITTER = [
13068
13392
  SplitterComponent,
13069
13393
  SplitterPaneComponent
13070
13394
  ];
13071
13395
  /**
13072
- * Utility array that contains all `StackLayout` related components and directives.
13396
+ * Use the `KENDO_STACKLAYOUT` utility array to add all StackLayout-related components and directives to a standalone Angular component.
13073
13397
  */
13074
13398
  const KENDO_STACKLAYOUT = [
13075
13399
  StackLayoutComponent
13076
13400
  ];
13077
13401
  /**
13078
- * Utility array that contains all `Stepper` related components and directives.
13402
+ * Use the `KENDO_STEPPER` utility array to add all Stepper-related components and directives to a standalone Angular component.
13079
13403
  */
13080
13404
  const KENDO_STEPPER = [
13081
13405
  StepperComponent,
@@ -13085,7 +13409,7 @@ const KENDO_STEPPER = [
13085
13409
  StepperStepTemplateDirective
13086
13410
  ];
13087
13411
  /**
13088
- * Utility array that contains all `TabStrip` related components and directives.
13412
+ * Use the `KENDO_TABSTRIP` utility array to add all TabStrip-related components and directives to a standalone Angular component.
13089
13413
  */
13090
13414
  const KENDO_TABSTRIP = [
13091
13415
  TabStripComponent,
@@ -13095,7 +13419,7 @@ const KENDO_TABSTRIP = [
13095
13419
  TabStripCustomMessagesComponent
13096
13420
  ];
13097
13421
  /**
13098
- * Utility array that contains all `TileLayout` related components and directives.
13422
+ * Use the `KENDO_TILELAYOUT` utility array to add all TileLayout-related components and directives to a standalone Angular component.
13099
13423
  */
13100
13424
  const KENDO_TILELAYOUT = [
13101
13425
  TileLayoutComponent,
@@ -13104,7 +13428,7 @@ const KENDO_TILELAYOUT = [
13104
13428
  TileLayoutItemHeaderComponent
13105
13429
  ];
13106
13430
  /**
13107
- * Utility array that contains all `Timeline` related components and directives
13431
+ * Use the `KENDO_TIMELINE` utility array to add all Timeline-related components and directives to a standalone Angular component.
13108
13432
  */
13109
13433
  const KENDO_TIMELINE = [
13110
13434
  TimelineComponent,
@@ -13114,7 +13438,7 @@ const KENDO_TIMELINE = [
13114
13438
  TimelineCardHeaderTemplateDirective
13115
13439
  ];
13116
13440
  /**
13117
- * Utility array that contains all `@progress/kendo-angular-layout` related components and directives.
13441
+ * Use the `KENDO_LAYOUT` utility array to add all `@progress/kendo-angular-layout`-related components and directives to a standalone Angular component.
13118
13442
  */
13119
13443
  const KENDO_LAYOUT = [
13120
13444
  ...KENDO_AVATAR,
@@ -13133,8 +13457,20 @@ const KENDO_LAYOUT = [
13133
13457
 
13134
13458
  // IMPORTANT: NgModule export kept for backwards compatibility
13135
13459
  /**
13136
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13137
- * definition for the Avatar component.
13460
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Avatar component.
13461
+ *
13462
+ * Use this module to add the Avatar component to your NgModule-based Angular application.
13463
+ *
13464
+ * @example
13465
+ * ```typescript
13466
+ * import { AvatarModule } from '@progress/kendo-angular-layout';
13467
+ * import { NgModule } from '@angular/core';
13468
+ *
13469
+ * @NgModule({
13470
+ * imports: [AvatarModule]
13471
+ * })
13472
+ * export class AppModule { }
13473
+ * ```
13138
13474
  */
13139
13475
  class AvatarModule {
13140
13476
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: AvatarModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13151,8 +13487,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13151
13487
 
13152
13488
  // IMPORTANT: NgModule export kept for backwards compatibility
13153
13489
  /**
13154
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13155
- * definition for the Card component.
13490
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Card component.
13491
+ *
13492
+ * Use this module to add the Card component to your NgModule-based Angular application.
13493
+ *
13494
+ * @example
13495
+ * ```typescript
13496
+ * import { CardModule } from '@progress/kendo-angular-layout';
13497
+ * import { NgModule } from '@angular/core';
13498
+ *
13499
+ * @NgModule({
13500
+ * imports: [CardModule]
13501
+ * })
13502
+ * export class AppModule { }
13503
+ * ```
13156
13504
  */
13157
13505
  class CardModule {
13158
13506
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: CardModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13169,8 +13517,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13169
13517
 
13170
13518
  // IMPORTANT: NgModule export kept for backwards compatibility
13171
13519
  /**
13172
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13173
- * definition for the Drawer component.
13520
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Drawer component.
13521
+ *
13522
+ * Use this module to add the Drawer component to your NgModule-based Angular application.
13523
+ *
13524
+ * @example
13525
+ * ```typescript
13526
+ * import { DrawerModule } from '@progress/kendo-angular-layout';
13527
+ * import { NgModule } from '@angular/core';
13528
+ *
13529
+ * @NgModule({
13530
+ * imports: [DrawerModule]
13531
+ * })
13532
+ * export class AppModule { }
13533
+ * ```
13174
13534
  */
13175
13535
  class DrawerModule {
13176
13536
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: DrawerModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13187,34 +13547,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13187
13547
 
13188
13548
  // IMPORTANT: NgModule export kept for backwards compatibility
13189
13549
  /**
13190
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13191
- * definition for the Layout components.
13550
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Layout components.
13192
13551
  *
13193
- * @example
13552
+ * Use this module to add all Layout package components to your NgModule-based Angular application.
13194
13553
  *
13195
- * ```ts-no-run
13196
- * // Import the Layout module
13554
+ * @example
13555
+ * ```typescript
13197
13556
  * import { LayoutModule } from '@progress/kendo-angular-layout';
13198
- *
13199
- * // The browser platform with a compiler
13200
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
13201
- *
13202
13557
  * import { NgModule } from '@angular/core';
13203
- *
13204
- * // Import the app component
13558
+ * import { BrowserModule } from '@angular/platform-browser';
13205
13559
  * import { AppComponent } from './app.component';
13206
13560
  *
13207
- * // Define the app module
13208
- * _@NgModule({
13209
- * declarations: [AppComponent], // declare app component
13210
- * imports: [BrowserModule, LayoutModule], // import Layout module
13211
- * bootstrap: [AppComponent]
13561
+ * @NgModule({
13562
+ * declarations: [AppComponent],
13563
+ * imports: [BrowserModule, LayoutModule],
13564
+ * bootstrap: [AppComponent]
13212
13565
  * })
13213
- * export class AppModule {}
13214
- *
13215
- * // Compile and launch the module
13216
- * platformBrowserDynamic().bootstrapModule(AppModule);
13217
- *
13566
+ * export class AppModule { }
13218
13567
  * ```
13219
13568
  */
13220
13569
  class LayoutModule {
@@ -13232,15 +13581,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13232
13581
 
13233
13582
  // IMPORTANT: NgModule export kept for backwards compatibility
13234
13583
  /**
13235
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13236
- * definition for the PanelBar component.
13584
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the PanelBar component.
13237
13585
  *
13238
- * The module registers:
13239
- * - `PanelBarComponent`&mdash;The `PanelBar` component class.
13240
- * - `PanelBarItemComponent`&mdash;The `PanelBarItem` component class.
13241
- * - `PanelBarContentComponent`&mdash;The `PanelBarContent` component class.
13242
- * - `PanelBarItemTemplateDirective&mdash;The `PanelBarItemTemplate` directive.
13243
- * - `PanelBarItemTitleDirective&mdash;The `PanelBarItemTitle` directive.
13586
+ * Use this module to add the PanelBar component to your NgModule-based Angular application.
13587
+ *
13588
+ * @example
13589
+ * ```typescript
13590
+ * import { PanelBarModule } from '@progress/kendo-angular-layout';
13591
+ * import { NgModule } from '@angular/core';
13592
+ *
13593
+ * @NgModule({
13594
+ * imports: [PanelBarModule]
13595
+ * })
13596
+ * export class AppModule { }
13597
+ * ```
13244
13598
  */
13245
13599
  class PanelBarModule {
13246
13600
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: PanelBarModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13257,12 +13611,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13257
13611
 
13258
13612
  // IMPORTANT: NgModule export kept for backwards compatibility
13259
13613
  /**
13260
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13261
- * definition for the Splitter component.
13614
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Splitter component.
13615
+ *
13616
+ * Use this module to add the Splitter component to your NgModule-based Angular application.
13617
+ *
13618
+ * @example
13619
+ * ```typescript
13620
+ * import { SplitterModule } from '@progress/kendo-angular-layout';
13621
+ * import { NgModule } from '@angular/core';
13262
13622
  *
13263
- * The module registers:
13264
- * - `SplitterComponent`&mdash;The `Splitter` component class.
13265
- * - `SplitterPaneComponent`&mdash;The `SplitterPane` component class.
13623
+ * @NgModule({
13624
+ * imports: [SplitterModule]
13625
+ * })
13626
+ * export class AppModule { }
13627
+ * ```
13266
13628
  */
13267
13629
  class SplitterModule {
13268
13630
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: SplitterModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13279,8 +13641,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13279
13641
 
13280
13642
  // IMPORTANT: NgModule export kept for backwards compatibility
13281
13643
  /**
13282
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13283
- * definition for the Stepper component.
13644
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Stepper component.
13645
+ *
13646
+ * Use this module to add the Stepper component to your NgModule-based Angular application.
13647
+ *
13648
+ * @example
13649
+ * ```typescript
13650
+ * import { StepperModule } from '@progress/kendo-angular-layout';
13651
+ * import { NgModule } from '@angular/core';
13652
+ *
13653
+ * @NgModule({
13654
+ * imports: [StepperModule]
13655
+ * })
13656
+ * export class AppModule { }
13657
+ * ```
13284
13658
  */
13285
13659
  class StepperModule {
13286
13660
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: StepperModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13297,14 +13671,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13297
13671
 
13298
13672
  // IMPORTANT: NgModule export kept for backwards compatibility
13299
13673
  /**
13300
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13301
- * definition for the TabStrip component.
13674
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the TabStrip component.
13302
13675
  *
13303
- * The module registers:
13304
- * - `TabStripComponent`&mdash;The `TabStrip` component class.
13305
- * - `TabStripTabComponent`&mdash;The `TabStripTab` component class.
13306
- * - `TabContentDirective`&mdash;The tab content directive used on the `<ng-template>` tag.
13307
- * - `TabTitleDirective`&mdash;The tab title directive used on the `<ng-template>` tag.
13676
+ * Use this module to add the TabStrip component to your NgModule-based Angular application.
13677
+ *
13678
+ * @example
13679
+ * ```typescript
13680
+ * import { TabStripModule } from '@progress/kendo-angular-layout';
13681
+ * import { NgModule } from '@angular/core';
13682
+ *
13683
+ * @NgModule({
13684
+ * imports: [TabStripModule]
13685
+ * })
13686
+ * export class AppModule { }
13687
+ * ```
13308
13688
  */
13309
13689
  class TabStripModule {
13310
13690
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: TabStripModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13321,8 +13701,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13321
13701
 
13322
13702
  // IMPORTANT: NgModule export kept for backwards compatibility
13323
13703
  /**
13324
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13325
- * definition for the ExpansionPanel component.
13704
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the ExpansionPanel component.
13705
+ *
13706
+ * Use this module to add the ExpansionPanel component to your NgModule-based Angular application.
13707
+ *
13708
+ * @example
13709
+ * ```typescript
13710
+ * import { ExpansionPanelModule } from '@progress/kendo-angular-layout';
13711
+ * import { NgModule } from '@angular/core';
13712
+ *
13713
+ * @NgModule({
13714
+ * imports: [ExpansionPanelModule]
13715
+ * })
13716
+ * export class AppModule { }
13717
+ * ```
13326
13718
  */
13327
13719
  class ExpansionPanelModule {
13328
13720
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: ExpansionPanelModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13339,14 +13731,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13339
13731
 
13340
13732
  // IMPORTANT: NgModule export kept for backwards compatibility
13341
13733
  /**
13342
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13343
- * definition for the TileLayout component.
13734
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the TileLayout component.
13735
+ *
13736
+ * Use this module to add the TileLayout component to your NgModule-based Angular application.
13737
+ *
13738
+ * @example
13739
+ * ```typescript
13740
+ * import { TileLayoutModule } from '@progress/kendo-angular-layout';
13741
+ * import { NgModule } from '@angular/core';
13344
13742
  *
13345
- * The module registers:
13346
- * - `TileLayoutComponent`&mdash;The `TileLayoutComponent` component class.
13347
- * - `TileLayoutItemComponent`&mdash;The `TileLayoutItemComponent` component class.
13348
- * - `TileLayoutItemHeaderComponent`&mdash;The `TileLayoutItemHeaderComponent` component class.
13349
- * - `TileLayoutItemBodyComponent`&mdash;The `TileLayoutItemBodyComponent` component class.
13743
+ * @NgModule({
13744
+ * imports: [TileLayoutModule]
13745
+ * })
13746
+ * export class AppModule { }
13747
+ * ```
13350
13748
  */
13351
13749
  class TileLayoutModule {
13352
13750
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: TileLayoutModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13363,8 +13761,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13363
13761
 
13364
13762
  // IMPORTANT: NgModule export kept for backwards compatibility
13365
13763
  /**
13366
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13367
- * definition for the StackLayout component.
13764
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the StackLayout component.
13765
+ *
13766
+ * Use this module to add the StackLayout component to your NgModule-based Angular application.
13767
+ *
13768
+ * @example
13769
+ * ```typescript
13770
+ * import { StackLayoutModule } from '@progress/kendo-angular-layout';
13771
+ * import { NgModule } from '@angular/core';
13772
+ *
13773
+ * @NgModule({
13774
+ * imports: [StackLayoutModule]
13775
+ * })
13776
+ * export class AppModule { }
13777
+ * ```
13368
13778
  */
13369
13779
  class StackLayoutModule {
13370
13780
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: StackLayoutModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13381,8 +13791,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13381
13791
 
13382
13792
  // IMPORTANT: NgModule export kept for backwards compatibility
13383
13793
  /**
13384
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13385
- * definition for the GridLayout component.
13794
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the GridLayout component.
13795
+ *
13796
+ * Use this module to add the GridLayout component to your NgModule-based Angular application.
13797
+ *
13798
+ * @example
13799
+ * ```typescript
13800
+ * import { GridLayoutModule } from '@progress/kendo-angular-layout';
13801
+ * import { NgModule } from '@angular/core';
13802
+ *
13803
+ * @NgModule({
13804
+ * imports: [GridLayoutModule]
13805
+ * })
13806
+ * export class AppModule { }
13807
+ * ```
13386
13808
  */
13387
13809
  class GridLayoutModule {
13388
13810
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: GridLayoutModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -13399,11 +13821,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13399
13821
 
13400
13822
  // IMPORTANT: NgModule export kept for backwards compatibility
13401
13823
  /**
13402
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13403
- * definition for the Timeline component.
13824
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Timeline component.
13404
13825
  *
13405
- * The module registers:
13406
- * - `TimelineComponent`&mdash;The `TimelineComponent` component class.
13826
+ * Use this module to add the Timeline component to your NgModule-based Angular application.
13827
+ *
13828
+ * @example
13829
+ * ```typescript
13830
+ * import { TimelineModule } from '@progress/kendo-angular-layout';
13831
+ * import { NgModule } from '@angular/core';
13832
+ *
13833
+ * @NgModule({
13834
+ * imports: [TimelineModule]
13835
+ * })
13836
+ * export class AppModule { }
13837
+ * ```
13407
13838
  */
13408
13839
  class TimelineModule {
13409
13840
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: TimelineModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });