@progress/kendo-angular-layout 19.1.2-develop.4 → 19.1.2-develop.6

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 +9 -9
  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
@@ -8,7 +8,26 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
8
8
  import { AvatarFillMode, AvatarShape, AvatarSize, AvatarThemeColor, AvatarRounded } from './models/models';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Displays images, icons or initials representing people or other entities.
11
+ * Represents the Kendo UI Avatar component for Angular. Displays images, icons, or initials representing people or other entities.
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * @Component({
16
+ * selector: 'my-app',
17
+ * template: `
18
+ * <kendo-avatar [imageSrc]="userImage" size="large"></kendo-avatar>
19
+ * <kendo-avatar [initials]="userInitials" themeColor="primary"></kendo-avatar>
20
+ * <kendo-avatar [icon]="userIcon" fillMode="outline"></kendo-avatar>
21
+ * `
22
+ * })
23
+ * class AppComponent {
24
+ * userImage = 'path/to/image.jpg';
25
+ * userInitials = 'JD';
26
+ * userIcon = 'user';
27
+ * }
28
+ * ```
29
+ * @remarks
30
+ * Supported children components are: {@link AvatarCustomMessagesComponent}.
12
31
  */
13
32
  export declare class AvatarComponent implements OnInit, AfterViewInit {
14
33
  private localization;
@@ -29,57 +48,33 @@ export declare class AvatarComponent implements OnInit, AfterViewInit {
29
48
  */
30
49
  set shape(shape: AvatarShape);
31
50
  /**
32
- * Specifies the size of the avatar
51
+ * Specifies the size of the Avatar
33
52
  * ([see example]({% slug appearance_avatar %}#toc-size)).
34
53
  *
35
- * The possible values are:
36
- * * `small`
37
- * * `medium` (Default)
38
- * * `large`
39
- * * `none`
54
+ * @default 'medium'
40
55
  */
41
56
  set size(size: AvatarSize);
42
57
  get size(): AvatarSize;
43
58
  /**
44
- * Specifies the rounded styling of the avatar
59
+ * Specifies the rounded styling of the Avatar
45
60
  * ([see example](slug:appearance_avatar#toc-roundness)).
46
61
  *
47
- * The possible values are:
48
- * * `small`
49
- * * `medium`
50
- * * `large`
51
- * * `full` (Default)
52
- * * `none`
62
+ * @default 'full'
53
63
  */
54
64
  set rounded(rounded: AvatarRounded);
55
65
  get rounded(): AvatarRounded;
56
66
  /**
57
- * Specifies the theme color of the avatar.
58
- * The theme color will be applied as background and border color, while also amending the text color accordingly.
67
+ * Specifies the theme color of the Avatar.
68
+ * The theme color applies as background and border color while adjusting the text color accordingly.
59
69
  *
60
- * The possible values are:
61
- * * `base`&mdash; Applies the base coloring value.
62
- * * `primary` (Default)&mdash;Applies coloring based on primary theme color.
63
- * * `secondary`&mdash;Applies coloring based on secondary theme color.
64
- * * `tertiary`&mdash; Applies coloring based on tertiary theme color.
65
- * * `info`&mdash;Applies coloring based on info theme color.
66
- * * `success`&mdash; Applies coloring based on success theme color.
67
- * * `warning`&mdash; Applies coloring based on warning theme color.
68
- * * `error`&mdash; Applies coloring based on error theme color.
69
- * * `dark`&mdash; Applies coloring based on dark theme color.
70
- * * `light`&mdash; Applies coloring based on light theme color.
71
- * * `inverse`&mdash; Applies coloring based on inverted theme color.
72
- * * `none`&mdash; Removes the styling associated with the theme color.
70
+ * @default 'primary'
73
71
  */
74
72
  set themeColor(themeColor: AvatarThemeColor);
75
73
  get themeColor(): AvatarThemeColor;
76
74
  /**
77
- * Specifies the appearance fill style of the avatar.
75
+ * Specifies the fill style of the Avatar.
78
76
  *
79
- * The possible values are:
80
- * * `solid` (Default)
81
- * * `outline`
82
- * * `none`
77
+ * @default 'solid'
83
78
  */
84
79
  set fillMode(fillMode: AvatarFillMode);
85
80
  get fillMode(): AvatarFillMode;
@@ -91,17 +86,18 @@ export declare class AvatarComponent implements OnInit, AfterViewInit {
91
86
  */
92
87
  set fill(fillMode: AvatarFillMode);
93
88
  /**
94
- * Sets a border to the avatar.
89
+ * Adds a border to the Avatar.
90
+ *
91
+ * @default false
95
92
  */
96
93
  border: boolean;
97
94
  /**
98
- * Defines a CSS class or multiple classes separated by spaces
99
- * which are applied to a span element inside the avatar.
100
- * Allows the usage of custom icons.
95
+ * Defines a CSS class or multiple classes separated by spaces.
96
+ * You can apply these classes to a `span` element inside the Avatar and also use custom icons.
101
97
  */
102
98
  iconClass: string;
103
99
  /**
104
- * Sets the width of the avatar.
100
+ * Sets the width of the Avatar.
105
101
  */
106
102
  width: string;
107
103
  /**
@@ -109,7 +105,7 @@ export declare class AvatarComponent implements OnInit, AfterViewInit {
109
105
  */
110
106
  get avatarWidth(): string;
111
107
  /**
112
- * Sets the height of the avatar.
108
+ * Sets the height of the Avatar.
113
109
  */
114
110
  height: string;
115
111
  /**
@@ -117,26 +113,26 @@ export declare class AvatarComponent implements OnInit, AfterViewInit {
117
113
  */
118
114
  get avatarHeight(): string;
119
115
  /**
120
- * The CSS styles that will be rendered on the content element of the avatar.
121
- * Supports the type of values that are supported by [ngStyle](link:site.data.urls.angular['ngstyleapi']).
116
+ * Defines the CSS styles that render on the content element of the Avatar.
117
+ * Supports the type of values that [`ngStyle`](link:site.data.urls.angular['ngstyleapi']) supports.
122
118
  */
123
119
  cssStyle?: any;
124
120
  /**
125
- * Sets `initials` to the avatar.
121
+ * Sets the initials for the Avatar.
126
122
  */
127
123
  initials: string;
128
124
  /**
129
- * Sets the `icon` for the avatar.
125
+ * Sets the icon for the Avatar.
130
126
  * All [Kendo UI Icons](slug:icons#icons-list) are supported.
131
127
  */
132
128
  icon: string;
133
129
  /**
134
- * Sets the `image` source of the avatar.
130
+ * Sets the image source of the Avatar.
135
131
  */
136
132
  imageSrc: string;
137
133
  /**
138
- * Defines an SVGIcon to be rendered.
139
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
134
+ * Defines an SVG icon to render.
135
+ * You can use either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
140
136
  */
141
137
  set svgIcon(icon: SVGIcon);
142
138
  get svgIcon(): SVGIcon;
@@ -6,8 +6,16 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
6
6
  import { Messages } from './messages';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Custom component messages override default component messages
9
+ * Provides custom component messages that override default component messages
10
10
  * ([see example]({% slug rtl_layout %})).
11
+ *
12
+ * ```html
13
+ * <kendo-avatar>
14
+ * <kendo-avatar-messages
15
+ * avatarAlt="User's profile picture"
16
+ * ></kendo-avatar-messages>
17
+ * </kendo-avatar>
18
+ * ```
11
19
  */
12
20
  export declare class AvatarCustomMessagesComponent extends Messages {
13
21
  protected service: LocalizationService;
@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
9
9
  */
10
10
  export declare class Messages extends ComponentMessages {
11
11
  /**
12
- * The alt attribute text of the image in the avatar.
12
+ * Defines the alt attribute text of the image in the Avatar.
13
13
  */
14
14
  avatarAlt: string;
15
15
  static ɵfac: i0.ɵɵFactoryDeclaration<Messages, never>;
@@ -3,6 +3,6 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the possible appearance fill styles of the аvatar ([see example](slug:appearance_avatar#toc-fill-mode)).
6
+ * Defines the possible fill styles of the Avatar ([see example](slug:appearance_avatar#toc-fill-mode)).
7
7
  */
8
8
  export type AvatarFillMode = 'solid' | 'outline' | 'none';
@@ -3,6 +3,6 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the possible rounded options of the аvatar ([see example](slug:appearance_avatar#roundness)).
6
+ * Defines the possible rounded options of the Avatar ([see example](slug:appearance_avatar#roundness)).
7
7
  */
8
8
  export type AvatarRounded = 'small' | 'medium' | 'large' | 'full' | 'none';
@@ -3,6 +3,6 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the possible sizes of the аvatar ([see example]({% slug appearance_avatar %}#toc-size)).
6
+ * Defines the possible sizes of the Avatar ([see example]({% slug appearance_avatar %}#toc-size)).
7
7
  */
8
8
  export type AvatarSize = 'small' | 'medium' | 'large' | 'none';
@@ -3,6 +3,6 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the possible theme colors of the аvatar ([see example]({% slug appearance_avatar %}#toc-theme-color)).
6
+ * Defines the possible theme colors of the Avatar ([see example]({% slug appearance_avatar %}#toc-theme-color)).
7
7
  */
8
8
  export type AvatarThemeColor = 'primary' | 'secondary' | 'tertiary' | 'base' | 'info' | 'success' | 'warning' | 'error' | 'dark' | 'light' | 'inverse' | 'none';
@@ -6,8 +6,20 @@ import * as i0 from "@angular/core";
6
6
  import * as i1 from "./avatar/avatar.component";
7
7
  import * as i2 from "./avatar/l10n/custom-messages.component";
8
8
  /**
9
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
10
- * definition for the Avatar component.
9
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Avatar component.
10
+ *
11
+ * Use this module to add the Avatar component to your NgModule-based Angular application.
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * import { AvatarModule } from '@progress/kendo-angular-layout';
16
+ * import { NgModule } from '@angular/core';
17
+ *
18
+ * @NgModule({
19
+ * imports: [AvatarModule]
20
+ * })
21
+ * export class AppModule { }
22
+ * ```
11
23
  */
12
24
  export declare class AvatarModule {
13
25
  static ɵfac: i0.ɵɵFactoryDeclaration<AvatarModule, never>;
@@ -8,8 +8,16 @@ import { CardAction } from './models/card-action';
8
8
  import { Orientation } from '../common/orientation';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Specifies the action buttons of the Card.
12
- * * ([see example]({% slug actions_card %})).
11
+ * Defines the action buttons of the Card ([see example]({% slug actions_card %})).
12
+ * The Card actions can be used to perform operations related to the Card's content, such as saving, editing, or deleting.
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-card-actions
17
+ * layout="end"
18
+ * orientation="horizontal">
19
+ * </kendo-card-actions>
20
+ * ```
13
21
  */
14
22
  export declare class CardActionsComponent {
15
23
  hostClass: boolean;
@@ -20,31 +28,24 @@ export declare class CardActionsComponent {
20
28
  get verticalClass(): boolean;
21
29
  get horizontalClass(): boolean;
22
30
  /**
23
- * Specifies the layout of the Card action buttons.
24
- *
25
- * * The possible values are:
26
- * * (Default) `horizontal`
27
- * * `vertical`
31
+ * Specifies the orientation of the Card action buttons.
28
32
  *
33
+ * @default 'horizontal'
29
34
  */
30
35
  orientation: Orientation;
31
36
  /**
32
37
  * Specifies the layout of the Card action buttons.
33
38
  *
34
- * The possible values are:
35
- * * (Default) `start`
36
- * * `center`
37
- * * `end`
38
- * * `stretched`
39
- *
39
+ * @default 'start'
40
40
  */
41
41
  layout: ActionsLayout;
42
42
  /**
43
- * Allows the declarative specification of the Card actions.
43
+ * Defines the Card actions declaratively.
44
+ * You can pass an array of `CardAction` objects or a `TemplateRef`.
44
45
  */
45
46
  set actions(value: CardAction[] | TemplateRef<any>);
46
47
  /**
47
- * Fires when the user clicks an action button.
48
+ * Fires when you click an action button.
48
49
  */
49
50
  action: EventEmitter<CardAction>;
50
51
  /**
@@ -4,7 +4,15 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import * as i0 from "@angular/core";
6
6
  /**
7
- * Specifies the content in the Card body.
7
+ * Defines the content in the Card body.
8
+ * The body is the main area of the Card where the primary content is displayed.
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-card-body>
13
+ * <p>Main content of the card.</p>
14
+ * </kendo-card-body>
15
+ * ```
8
16
  */
9
17
  export declare class CardBodyComponent {
10
18
  hostClass: boolean;
@@ -4,7 +4,15 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import * as i0 from "@angular/core";
6
6
  /**
7
- * Specifies the content in the Card footer.
7
+ * Defines the content in the Card footer.
8
+ * The footer can include additional information, actions, or links related to the Card's content.
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-card-footer>
13
+ * <p>Footer content</p>
14
+ * </kendo-card-footer>
15
+ * ```
8
16
  */
9
17
  export declare class CardFooterComponent {
10
18
  hostClass: boolean;
@@ -4,7 +4,16 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import * as i0 from "@angular/core";
6
6
  /**
7
- * Specifies the content in the Card header.
7
+ * Defines the content in the Card header.
8
+ * The header can include a title, subtitle, and other elements that provide context for the Card's content.
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-card-header>
13
+ * <h5 kendoCardTitle>Card Title</h5>
14
+ * <p kendoCardSubtitle>Card Subtitle</p>
15
+ * </kendo-card-header>
16
+ * ```
8
17
  */
9
18
  export declare class CardHeaderComponent {
10
19
  hostClass: boolean;
@@ -7,7 +7,22 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
7
7
  import { Orientation } from '../common/orientation';
8
8
  import * as i0 from "@angular/core";
9
9
  /**
10
- * Represents the [Kendo UI Card component for Angular]({% slug overview_card %})
10
+ * Represents the Kendo UI Card component for Angular.
11
+ * Displays content in a structured container with customizable layout and styling ([Card overview]({% slug overview_card %})).
12
+ *
13
+ * @example
14
+ * ```html
15
+ * <kendo-card orientation="vertical">
16
+ * <kendo-card-header>
17
+ * <h5 kendoCardTitle>Card Title</h5>
18
+ * </kendo-card-header>
19
+ * <kendo-card-body>
20
+ * <p>Card content goes here.</p>
21
+ * </kendo-card-body>
22
+ * </kendo-card>
23
+ * ```
24
+ * @remarks
25
+ * Supported children components are: {@link CardFooterComponent}, {@link CardHeaderComponent}, {@link CardActionsComponent}, {@link CardBodyComponent}.
11
26
  */
12
27
  export declare class CardComponent implements OnDestroy {
13
28
  private localizationService;
@@ -22,15 +37,13 @@ export declare class CardComponent implements OnDestroy {
22
37
  /**
23
38
  * Specifies the layout of the Card content.
24
39
  *
25
- * The possible values are:
26
- * * (Default) `vertical`
27
- * * `horizontal`
28
- *
40
+ * @default 'vertical'
29
41
  */
30
42
  orientation: Orientation;
31
43
  /**
32
44
  * Defines the width of the Card.
33
- * Defaults to `285px`.
45
+ *
46
+ * @default '285px'
34
47
  */
35
48
  width: string;
36
49
  private dynamicRTLSubscription;
@@ -4,7 +4,16 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import * as i0 from "@angular/core";
6
6
  /**
7
- * Specifies any media that will be displayed and aligned in the Card.
7
+ * Defines any media that displays and aligns in the Card.
8
+ * The media can be an image, video, or any other media type.
9
+ *
10
+ * ```html
11
+ * <kendo-card>
12
+ * <div kendoCardMedia>
13
+ * <img src="path/to/image.jpg" alt="Card Media">
14
+ * </div>
15
+ * </kendo-card>
16
+ * ```
8
17
  */
9
18
  export declare class CardMediaDirective {
10
19
  hostClass: boolean;
@@ -5,7 +5,15 @@
5
5
  import { Orientation } from '../../common/orientation';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Specifies a separator in the content of the Card.
8
+ * Defines a separator in the content of the Card.
9
+ * The separator can be used to visually divide sections within the Card.
10
+ *
11
+ * ```html
12
+ * <kendo-card>
13
+ * <div kendoCardSeparator></div>
14
+ * <p>Content below the separator</p>
15
+ * </kendo-card>
16
+ * ```
9
17
  */
10
18
  export declare class CardSeparatorDirective {
11
19
  hostClass: boolean;
@@ -18,9 +26,7 @@ export declare class CardSeparatorDirective {
18
26
  /**
19
27
  * Specifies the orientation of the Card separator.
20
28
  *
21
- * The possible values are:
22
- * (Default) `horizontal`
23
- * `vertical`
29
+ * @default 'horizontal'
24
30
  */
25
31
  orientation: Orientation;
26
32
  static ɵfac: i0.ɵɵFactoryDeclaration<CardSeparatorDirective, never>;
@@ -4,7 +4,14 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import * as i0 from "@angular/core";
6
6
  /**
7
- * Specifies the text and styles for the subtitle of the Card.
7
+ * Defines the text and styles for the subtitle of the Card.
8
+ * The subtitle is displayed below the title and above the content of the Card.
9
+ *
10
+ * ```html
11
+ * <kendo-card>
12
+ * <h4 kendoCardSubtitle>Card Subtitle</h4>
13
+ * </kendo-card>
14
+ * ```
8
15
  */
9
16
  export declare class CardSubtitleDirective {
10
17
  hostClass: boolean;
@@ -4,7 +4,14 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import * as i0 from "@angular/core";
6
6
  /**
7
- * Specifies the text and styles for the title of the Card.
7
+ * Defines the text and styles for the title of the Card.
8
+ * The title is displayed at the top of the Card, above the subtitle and content.
9
+ *
10
+ * ```html
11
+ * <kendo-card>
12
+ * <h3 kendoCardTitle>Card Title</h3>
13
+ * </kendo-card>
14
+ * ```
8
15
  */
9
16
  export declare class CardTitleDirective {
10
17
  hostClass: boolean;
@@ -3,13 +3,6 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the layout of the Card action buttons.
7
- *
8
- * The possible values are:
9
- * * (Default) `start`
10
- * * `center`
11
- * * `end`
12
- * * `stretched`
13
- *
6
+ * Defines the layout of the Card action buttons.
14
7
  */
15
8
  export type ActionsLayout = 'start' | 'center' | 'end' | 'stretched';
@@ -3,19 +3,19 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The settings of the Card action buttons.
6
+ * Defines the settings of the Card action buttons.
7
7
  */
8
8
  export declare class CardAction {
9
9
  /**
10
- * Determines if the action button is styled as a primary button.
10
+ * Specifies whether the action button uses primary styling.
11
11
  */
12
12
  primary?: boolean;
13
13
  /**
14
- * Determines if the action button is styled as a flat button.
14
+ * Specifies whether the action button uses flat styling.
15
15
  */
16
16
  flat?: boolean;
17
17
  /**
18
- * The text of the action button.
18
+ * Defines the text of the action button.
19
19
  */
20
20
  text: string;
21
21
  }
package/card.module.d.ts CHANGED
@@ -13,8 +13,20 @@ import * as i7 from "./card/directives/card-separator.directive";
13
13
  import * as i8 from "./card/directives/card-subtitle.directive";
14
14
  import * as i9 from "./card/directives/card-title.directive";
15
15
  /**
16
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
17
- * definition for the Card component.
16
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Card component.
17
+ *
18
+ * Use this module to add the Card component to your NgModule-based Angular application.
19
+ *
20
+ * @example
21
+ * ```typescript
22
+ * import { CardModule } from '@progress/kendo-angular-layout';
23
+ * import { NgModule } from '@angular/core';
24
+ *
25
+ * @NgModule({
26
+ * imports: [CardModule]
27
+ * })
28
+ * export class AppModule { }
29
+ * ```
18
30
  */
19
31
  export declare class CardModule {
20
32
  static ɵfac: i0.ɵɵFactoryDeclaration<CardModule, never>;
package/codemods/utils.js CHANGED
@@ -207,8 +207,6 @@ const tsPropertyValueTransformer = (root, j, typeName, oldValue, newValue) => {
207
207
  path.node.value.value = newValue;
208
208
  }
209
209
  });
210
- // 2. Find all assignments to variables of the specified type
211
- const variablesOfType = new Set();
212
210
  // First, collect all variables with the specified type
213
211
  root
214
212
  .find(j.VariableDeclarator)
@@ -224,7 +222,6 @@ const tsPropertyValueTransformer = (root, j, typeName, oldValue, newValue) => {
224
222
  })
225
223
  .forEach(path => {
226
224
  if (path.node.id.type === 'Identifier') {
227
- variablesOfType.add(path.node.id.name);
228
225
  // Also update the initial value if it matches
229
226
  if (path.node.init &&
230
227
  path.node.init.type === 'StringLiteral' &&
@@ -3,6 +3,6 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the orientation of layouts in different scenarios.
6
+ * Defines the orientation of layouts in different scenarios.
7
7
  */
8
8
  export type Orientation = 'horizontal' | 'vertical';
@@ -9,16 +9,13 @@ export declare class PreventableEvent {
9
9
  private prevented;
10
10
  /**
11
11
  * Prevents the default action for a specified event.
12
- * In this way, the source component suppresses
13
- * the built-in behavior that follows the event.
12
+ * The source component suppresses the built-in behavior that follows the event.
14
13
  */
15
14
  preventDefault(): void;
16
15
  /**
17
- * Returns `true` if the event was prevented
18
- * by any of its subscribers.
16
+ * Returns `true` if the event was prevented by any of its subscribers.
19
17
  *
20
- * @returns `true` if the default action was prevented.
21
- * Otherwise, returns `false`.
18
+ * @returns `true` if the default action was prevented. Otherwise, returns `false`.
22
19
  */
23
20
  isDefaultPrevented(): boolean;
24
21
  /**