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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,34 +7,21 @@ import { IconComponent } from './icon/icon.component';
7
7
  import * as i0 from "@angular/core";
8
8
  //IMPORTANT: NgModule export kept for backwards compatibility
9
9
  /**
10
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
11
- * definition for the Icon component.
10
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Icon component.
12
11
  *
13
12
  * @example
14
- *
15
- * ```ts-no-run
16
- * // Import the Icon module
17
- * import { IconModule } from '@progress/kendo-angular-icons';
18
- *
19
- * // The browser platform with a compiler
20
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
21
- *
13
+ * ```typescript
22
14
  * import { NgModule } from '@angular/core';
23
- *
24
- * // Import the app component
15
+ * import { IconModule } from '@progress/kendo-angular-icons';
16
+ * import { BrowserModule } from '@angular/platform-browser';
25
17
  * import { AppComponent } from './app.component';
26
18
  *
27
- * // Define the app module
28
- * _@NgModule({
29
- * declarations: [AppComponent], // declare app component
30
- * imports: [BrowserModule, IconModule], // import Icon module
31
- * bootstrap: [AppComponent]
19
+ * @NgModule({
20
+ * declarations: [AppComponent],
21
+ * imports: [BrowserModule, IconModule],
22
+ * bootstrap: [AppComponent]
32
23
  * })
33
24
  * export class AppModule {}
34
- *
35
- * // Compile and launch the module
36
- * platformBrowserDynamic().bootstrapModule(AppModule);
37
- *
38
25
  * ```
39
26
  */
40
27
  export class IconModule {
@@ -10,34 +10,21 @@ import * as i1 from "./icon/icon.component";
10
10
  import * as i2 from "./svg-icon/svg-icon.component";
11
11
  //IMPORTANT: NgModule export kept for backwards compatibility
12
12
  /**
13
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
14
- * definition for the Icons components.
13
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Icons components.
15
14
  *
16
15
  * @example
17
- *
18
- * ```ts-no-run
19
- * // Import the Icons module
20
- * import { IconsModule } from '@progress/kendo-angular-icons';
21
- *
22
- * // The browser platform with a compiler
23
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
24
- *
16
+ * ```typescript
25
17
  * import { NgModule } from '@angular/core';
26
- *
27
- * // Import the app component
18
+ * import { IconsModule } from '@progress/kendo-angular-icons';
19
+ * import { BrowserModule } from '@angular/platform-browser';
28
20
  * import { AppComponent } from './app.component';
29
21
  *
30
- * // Define the app module
31
- * _@NgModule({
32
- * declarations: [AppComponent], // declare app component
33
- * imports: [BrowserModule, IconsModule], // import Icons module
34
- * bootstrap: [AppComponent]
22
+ * @NgModule({
23
+ * declarations: [AppComponent],
24
+ * imports: [BrowserModule, IconsModule],
25
+ * bootstrap: [AppComponent]
35
26
  * })
36
27
  * export class AppModule {}
37
- *
38
- * // Compile and launch the module
39
- * platformBrowserDynamic().bootstrapModule(AppModule);
40
- *
41
28
  * ```
42
29
  */
43
30
  export class IconsModule {
@@ -10,7 +10,7 @@ export const packageMetadata = {
10
10
  productName: 'Kendo UI for Angular',
11
11
  productCode: 'KENDOUIANGULAR',
12
12
  productCodes: ['KENDOUIANGULAR'],
13
- publishDate: 1749196419,
14
- version: '19.1.1-develop.2',
13
+ publishDate: 1749804007,
14
+ version: '19.1.2-develop.1',
15
15
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
16
16
  };
@@ -11,7 +11,12 @@ import * as i0 from "@angular/core";
11
11
  import * as i1 from "@angular/platform-browser";
12
12
  const areSame = (i1, i2) => i1?.name === i2?.name && i1.content === i2.content && i1.viewBox === i2.viewBox;
13
13
  /**
14
- * Represents the Kendo UI SVG Icon component for Angular.
14
+ * Represents the `SVGIconComponent` for Angular.
15
+ *
16
+ * @example
17
+ * ```html
18
+ * <kendo-svg-icon [icon]="svgIcon"></kendo-svg-icon>
19
+ * ```
15
20
  */
16
21
  export class SVGIconComponent extends IconBaseDirective {
17
22
  domSanitizer;
@@ -20,7 +25,7 @@ export class SVGIconComponent extends IconBaseDirective {
20
25
  hostClass = true;
21
26
  hostAriaHidden = true;
22
27
  /**
23
- * Defines the SVG icon, which will be rendered. All [Kendo UI SVG Icons](slug:svgicon_list) are supported.
28
+ * Sets the `SVGIcon` to render. Supports all [Kendo UI SVG Icons](slug:svgicon_list).
24
29
  */
25
30
  set icon(icon) {
26
31
  const element = this.element.nativeElement;
@@ -7,34 +7,21 @@ import { SVGIconComponent } from './svg-icon/svg-icon.component';
7
7
  import * as i0 from "@angular/core";
8
8
  //IMPORTANT: NgModule export kept for backwards compatibility
9
9
  /**
10
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
11
- * definition for the SVG Icon component.
10
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the SVG Icon component.
12
11
  *
13
12
  * @example
14
- *
15
- * ```ts-no-run
16
- * // Import the SVG Icon module
17
- * import { SVGIconModule } from '@progress/kendo-angular-icons';
18
- *
19
- * // The browser platform with a compiler
20
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
21
- *
13
+ * ```typescript
22
14
  * import { NgModule } from '@angular/core';
23
- *
24
- * // Import the app component
15
+ * import { SVGIconModule } from '@progress/kendo-angular-icons';
16
+ * import { BrowserModule } from '@angular/platform-browser';
25
17
  * import { AppComponent } from './app.component';
26
18
  *
27
- * // Define the app module
28
- * _@NgModule({
29
- * declarations: [AppComponent], // declare app component
30
- * imports: [BrowserModule, SVGIconModule], // import SVG Icon module
31
- * bootstrap: [AppComponent]
19
+ * @NgModule({
20
+ * declarations: [AppComponent],
21
+ * imports: [BrowserModule, SVGIconModule],
22
+ * bootstrap: [AppComponent]
32
23
  * })
33
24
  * export class AppModule {}
34
- *
35
- * // Compile and launch the module
36
- * platformBrowserDynamic().bootstrapModule(AppModule);
37
- *
38
25
  * ```
39
26
  */
40
27
  export class SVGIconModule {
@@ -19,8 +19,8 @@ const packageMetadata = {
19
19
  productName: 'Kendo UI for Angular',
20
20
  productCode: 'KENDOUIANGULAR',
21
21
  productCodes: ['KENDOUIANGULAR'],
22
- publishDate: 1749196419,
23
- version: '19.1.1-develop.2',
22
+ publishDate: 1749804007,
23
+ version: '19.1.2-develop.1',
24
24
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
25
25
  };
26
26
 
@@ -47,25 +47,11 @@ class IconBaseDirective {
47
47
  return this.flip === 'vertical' || this.flip === 'both';
48
48
  }
49
49
  /**
50
- * Flips the icon horizontally, vertically or in both directions.
50
+ * Flips the icon horizontally, vertically, or in both directions.
51
51
  */
52
52
  flip;
53
53
  /**
54
- * Specifies the theme color for the Icon.
55
- *
56
- * The possible values are:
57
- * * `inherit` (Default)&mdash;Applies coloring based on the current color.
58
- * * `primary` &mdash;Applies coloring based on primary theme color.
59
- * * `secondary`&mdash;Applies coloring based on secondary theme color.
60
- * * `tertiary`&mdash; Applies coloring based on tertiary theme color.
61
- * * `info`&mdash;Applies coloring based on info theme color.
62
- * * `success`&mdash; Applies coloring based on success theme color.
63
- * * `warning`&mdash; Applies coloring based on warning theme color.
64
- * * `error`&mdash; Applies coloring based on error theme color.
65
- * * `dark`&mdash; Applies coloring based on dark theme color.
66
- * * `light`&mdash; Applies coloring based on light theme color.
67
- * * `inverse`&mdash; Applies coloring based on inverse theme color.
68
- *
54
+ * Sets the `IconThemeColor` for the icon. Use this property to apply a theme color.
69
55
  */
70
56
  set themeColor(themeColor) {
71
57
  const element = this.element.nativeElement;
@@ -83,18 +69,7 @@ class IconBaseDirective {
83
69
  return this._themeColor;
84
70
  }
85
71
  /**
86
- * Specifies the size of the Icon.
87
- *
88
- * The possible values are:
89
- * * `default` (Default) (Font-size: 16px; Width: 16px; Height: 16px)
90
- * * `xsmall` (Font-size: 12px; Width: 12px; Height: 12px;)
91
- * * `small` (Font-size: 14px; Width: 14px; Height: 14px;)
92
- * * `medium` (Font-size: 16px; Width: 16px; Height: 16px;)
93
- * * `large` (Font-size: 20px; Width: 20px; Height: 20px;)
94
- * * `xlarge` (Font-size: 24px; Width: 24px; Height: 24px;)
95
- * * `xxlarge` (Font-size: 32px; Width: 32px; Height: 32px;)
96
- * * `xxxlarge` (Font-size: 48px; Width: 48px; Height: 48px;)
97
- *
72
+ * Sets the `IconSize` for the icon. Use this property to change the icon size.
98
73
  */
99
74
  set size(size) {
100
75
  const currentClass = sizeClasses[this.size];
@@ -139,7 +114,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
139
114
  }] } });
140
115
 
141
116
  /**
142
- * Represents the Kendo UI Icon component for Angular.
117
+ * Represents the Icon component for Angular.
118
+ *
119
+ * @example
120
+ * ```html
121
+ * <kendo-icon name="home"></kendo-icon>
122
+ * ```
143
123
  */
144
124
  class IconComponent extends IconBaseDirective {
145
125
  element;
@@ -147,8 +127,7 @@ class IconComponent extends IconBaseDirective {
147
127
  hostClass = true;
148
128
  hostAriaHidden = true;
149
129
  /**
150
- * Defines the name for an existing icon in a Kendo UI theme, which will be rendered.
151
- * All [Kendo UI Icons](slug:icon_list) are supported.
130
+ * Sets the `Icon` to render. Supports all [Kendo UI Icons](slug:icon_list).
152
131
  */
153
132
  set name(name) {
154
133
  if (isDocumentAvailable()) {
@@ -196,7 +175,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
196
175
 
197
176
  const areSame = (i1, i2) => i1?.name === i2?.name && i1.content === i2.content && i1.viewBox === i2.viewBox;
198
177
  /**
199
- * Represents the Kendo UI SVG Icon component for Angular.
178
+ * Represents the `SVGIconComponent` for Angular.
179
+ *
180
+ * @example
181
+ * ```html
182
+ * <kendo-svg-icon [icon]="svgIcon"></kendo-svg-icon>
183
+ * ```
200
184
  */
201
185
  class SVGIconComponent extends IconBaseDirective {
202
186
  domSanitizer;
@@ -205,7 +189,7 @@ class SVGIconComponent extends IconBaseDirective {
205
189
  hostClass = true;
206
190
  hostAriaHidden = true;
207
191
  /**
208
- * Defines the SVG icon, which will be rendered. All [Kendo UI SVG Icons](slug:svgicon_list) are supported.
192
+ * Sets the `SVGIcon` to render. Supports all [Kendo UI SVG Icons](slug:svgicon_list).
209
193
  */
210
194
  set icon(icon) {
211
195
  const element = this.element.nativeElement;
@@ -290,8 +274,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
290
274
  const isPresent = (value) => value !== null && value !== undefined;
291
275
 
292
276
  /**
293
- * A service that returns the current icon settings to be used in subscribers.
294
- * Use the public `notify` method to change the icon settings dynamically.
277
+ * Represents the service that manages icon settings.
278
+ * Use the `notify` method to update icon settings dynamically.
279
+ *
280
+ * @example
281
+ * ```typescript
282
+ * constructor(private iconSettingsService: IconSettingsService) {}
283
+ *
284
+ * this.iconSettingsService.notify({ themeColor: 'primary' });
285
+ * ```
295
286
  */
296
287
  class IconSettingsService {
297
288
  /**
@@ -299,9 +290,13 @@ class IconSettingsService {
299
290
  */
300
291
  changes = new Subject();
301
292
  /**
302
- * Notifies subscribers that the icon settings were changed.
293
+ * Notifies subscribers about changes in the icon settings.
303
294
  *
304
- * @param iconSettings - (Optional) A new value for the [icon settings token]({% slug api_icons_icon_settings %}).
295
+ * @param iconSettings - (Optional) Sets a new value for the [icon settings token]({% slug api_icons_icon_settings %}).
296
+ * @example
297
+ * ```typescript
298
+ * iconSettingsService.notify({ size: 'large' });
299
+ * ```
305
300
  */
306
301
  notify(iconSettings) {
307
302
  this.changes.next(iconSettings);
@@ -332,38 +327,36 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
332
327
  }] });
333
328
 
334
329
  /**
335
- * A token that specifies the [IconSettings](slug:api_icons_iconsettings) of the Kendo UI for Angular components ([see example](slug:icon_settings#toc-icons-configuration)).
330
+ * Represents the token for the `IconSettings` of Kendo UI for Angular components.
331
+ * Use this token to configure icon settings. ([See example.](slug:icon_settings#toc-icons-configuration))
336
332
  *
337
- * ```ts
333
+ * @example
334
+ * ```typescript
338
335
  * import { NgModule } from '@angular/core';
339
336
  *
340
337
  * @NgModule({
341
- * ...
342
- * providers: [{ provide: ICON_SETTINGS, useValue: { type: 'svg', size: 'xsmall' }}]
338
+ * providers: [{ provide: ICON_SETTINGS, useValue: { type: 'svg', size: 'xsmall' } }]
343
339
  * })
344
340
  * export class AppModule {}
345
341
  * ```
346
- *
347
342
  */
348
343
  const ICON_SETTINGS = new InjectionToken('Kendo UI Icon-Settings token');
349
344
 
350
345
  const DEFAULT_ICON_SETTINGS = { type: 'svg' };
351
346
  /**
352
- * The service responsible for handling changes in the icons settings. Should be included in the providers array when implementing the functionality in a standalone component.
347
+ * Represents the service that manages icon settings.
348
+ * Add this service to the `providers` array when you use it in a standalone component.
353
349
  *
354
350
  * @example
355
- *
356
- * ```ts-no-run
357
- * // Import the IconsService
351
+ * ```typescript
358
352
  * import { IconsService } from '@progress/kendo-angular-icons';
359
353
  *
360
- * // Define a standalone component
361
354
  * @Component({
362
- * selector: my-component,
363
- * standalone: true,
364
- * imports: [ ... ],
365
- * providers: [IconsService, { provide: ICON_SETTINGS , useValue: { type: 'font' } }],
366
- * template: ...
355
+ * selector: 'my-component',
356
+ * standalone: true,
357
+ * imports: [ ... ],
358
+ * providers: [IconsService, { provide: ICON_SETTINGS, useValue: { type: 'font' } }],
359
+ * template: `...`
367
360
  * })
368
361
  * export class AppComponent {}
369
362
  * ```
@@ -372,7 +365,7 @@ class IconsService {
372
365
  _iconSettings;
373
366
  iconSettingsService;
374
367
  /**
375
- * Notifies subscribers of the initial icon settings, and upon each call to `notify`.
368
+ * Notifies subscribers of the initial icon settings and on each call to `notify`.
376
369
  * @hidden
377
370
  */
378
371
  changes = new BehaviorSubject(this.iconSettings || DEFAULT_ICON_SETTINGS);
@@ -441,37 +434,24 @@ class IconWrapperComponent {
441
434
  element;
442
435
  hostClass = true;
443
436
  /**
444
- * Defines the name for an existing font icon in a Kendo UI theme, which will be rendered.
445
- * All [Kendo UI Icons](slug:icons#icons-list) are supported.
437
+ * Sets the name for an existing font icon in a Kendo UI theme to render.
438
+ * Supports all [Kendo UI Icons](slug:icons#icons-list).
446
439
  */
447
440
  name;
448
441
  /**
449
- * Defines an [SVGIcon](slug:api_icons_svgicon) to be rendered.
442
+ * Sets the [SVGIcon](slug:api_icons_svgicon) to render.
450
443
  */
451
444
  svgIcon;
452
445
  /**
453
- * Provided by consuming components in case an additional k-specific class needs to be rendered
454
- * on the internal Icon component.
446
+ * Sets an additional class on the internal Icon component.
455
447
  */
456
448
  innerCssClass = '';
457
449
  /**
458
- * Provided by consuming components in case a custom font icon class is set
459
- * by the developer using the consuming component through its API.
450
+ * Sets a custom font icon class using the API of the consuming component.
460
451
  */
461
452
  customFontClass = '';
462
453
  /**
463
- * Specifies the size of the Icon.
464
- *
465
- * The possible values are:
466
- * * `default` (Default) (Font-size: 16px; Width: 16px; Height: 16px)
467
- * * `xsmall` (Font-size: 12px; Width: 12px; Height: 12px;)
468
- * * `small` (Font-size: 14px; Width: 14px; Height: 14px;)
469
- * * `medium` (Font-size: 16px; Width: 16px; Height: 16px;)
470
- * * `large` (Font-size: 20px; Width: 20px; Height: 20px;)
471
- * * `xlarge` (Font-size: 24px; Width: 24px; Height: 24px;)
472
- * * `xxlarge` (Font-size: 32px; Width: 32px; Height: 32px;)
473
- * * `xxxlarge` (Font-size: 48px; Width: 48px; Height: 48px;)
474
- *
454
+ * Sets the `IconSize` for the icon.
475
455
  */
476
456
  size;
477
457
  get customClasses() {
@@ -587,34 +567,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
587
567
 
588
568
  //IMPORTANT: NgModule export kept for backwards compatibility
589
569
  /**
590
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
591
- * definition for the Icon component.
570
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Icon component.
592
571
  *
593
572
  * @example
594
- *
595
- * ```ts-no-run
596
- * // Import the Icon module
597
- * import { IconModule } from '@progress/kendo-angular-icons';
598
- *
599
- * // The browser platform with a compiler
600
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
601
- *
573
+ * ```typescript
602
574
  * import { NgModule } from '@angular/core';
603
- *
604
- * // Import the app component
575
+ * import { IconModule } from '@progress/kendo-angular-icons';
576
+ * import { BrowserModule } from '@angular/platform-browser';
605
577
  * import { AppComponent } from './app.component';
606
578
  *
607
- * // Define the app module
608
- * _@NgModule({
609
- * declarations: [AppComponent], // declare app component
610
- * imports: [BrowserModule, IconModule], // import Icon module
611
- * bootstrap: [AppComponent]
579
+ * @NgModule({
580
+ * declarations: [AppComponent],
581
+ * imports: [BrowserModule, IconModule],
582
+ * bootstrap: [AppComponent]
612
583
  * })
613
584
  * export class AppModule {}
614
- *
615
- * // Compile and launch the module
616
- * platformBrowserDynamic().bootstrapModule(AppModule);
617
- *
618
585
  * ```
619
586
  */
620
587
  class IconModule {
@@ -632,34 +599,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
632
599
 
633
600
  //IMPORTANT: NgModule export kept for backwards compatibility
634
601
  /**
635
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
636
- * definition for the SVG Icon component.
602
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the SVG Icon component.
637
603
  *
638
604
  * @example
639
- *
640
- * ```ts-no-run
641
- * // Import the SVG Icon module
642
- * import { SVGIconModule } from '@progress/kendo-angular-icons';
643
- *
644
- * // The browser platform with a compiler
645
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
646
- *
605
+ * ```typescript
647
606
  * import { NgModule } from '@angular/core';
648
- *
649
- * // Import the app component
607
+ * import { SVGIconModule } from '@progress/kendo-angular-icons';
608
+ * import { BrowserModule } from '@angular/platform-browser';
650
609
  * import { AppComponent } from './app.component';
651
610
  *
652
- * // Define the app module
653
- * _@NgModule({
654
- * declarations: [AppComponent], // declare app component
655
- * imports: [BrowserModule, SVGIconModule], // import SVG Icon module
656
- * bootstrap: [AppComponent]
611
+ * @NgModule({
612
+ * declarations: [AppComponent],
613
+ * imports: [BrowserModule, SVGIconModule],
614
+ * bootstrap: [AppComponent]
657
615
  * })
658
616
  * export class AppModule {}
659
- *
660
- * // Compile and launch the module
661
- * platformBrowserDynamic().bootstrapModule(AppModule);
662
- *
663
617
  * ```
664
618
  */
665
619
  class SVGIconModule {
@@ -676,19 +630,61 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
676
630
  }] });
677
631
 
678
632
  /**
679
- * Utility array that contains all `KendoIcon` related components and directives
633
+ * Represents the utility array that contains all `KendoIcon`-related components and directives.
634
+ *
635
+ * @example
636
+ * ```typescript
637
+ * import { Component } from '@angular/core';
638
+ * import { KENDO_ICON } from '@progress/kendo-angular-icons';
639
+ *
640
+ * @Component({
641
+ * selector: 'my-app',
642
+ * standalone: true,
643
+ * imports: [KENDO_ICON],
644
+ * template: `...`,
645
+ * })
646
+ * export class AppComponent {}
647
+ * ```
680
648
  */
681
649
  const KENDO_ICON = [
682
650
  IconComponent
683
651
  ];
684
652
  /**
685
- * Utility array that contains all `KendoSVGIcon` related components and directives
653
+ * Represents the utility array that contains all `KendoSVGIcon`-related components and directives.
654
+ *
655
+ * @example
656
+ * ```typescript
657
+ * import { Component } from '@angular/core';
658
+ * import { KENDO_SVGICON } from '@progress/kendo-angular-icons';
659
+ *
660
+ * @Component({
661
+ * selector: 'my-app',
662
+ * standalone: true,
663
+ * imports: [KENDO_SVGICON],
664
+ * template: `...`,
665
+ * })
666
+ * export class AppComponent {}
667
+ * ```
686
668
  */
687
669
  const KENDO_SVGICON = [
688
670
  SVGIconComponent
689
671
  ];
690
672
  /**
691
- * Utility array that contains all `@progress/kendo-angular-icons` related components and directives
673
+ * Represents the utility array that contains all `@progress/kendo-angular-icons`-related components and directives.
674
+ *
675
+ * @example
676
+ * ```typescript
677
+ * import { Component, ViewEncapsulation } from '@angular/core';
678
+ * import { KENDO_ICONS } from '@progress/kendo-angular-icons';
679
+ *
680
+ * @Component({
681
+ * selector: 'my-app',
682
+ * standalone: true,
683
+ * imports: [KENDO_ICONS],
684
+ * template: `...`,
685
+ * })
686
+ * export class AppComponent {}
687
+ * ```
692
688
  */
693
689
  const KENDO_ICONS = [
694
690
  ...KENDO_ICON,
@@ -697,34 +693,21 @@ const KENDO_ICONS = [
697
693
 
698
694
  //IMPORTANT: NgModule export kept for backwards compatibility
699
695
  /**
700
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
701
- * definition for the Icons components.
696
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Icons components.
702
697
  *
703
698
  * @example
704
- *
705
- * ```ts-no-run
706
- * // Import the Icons module
707
- * import { IconsModule } from '@progress/kendo-angular-icons';
708
- *
709
- * // The browser platform with a compiler
710
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
711
- *
699
+ * ```typescript
712
700
  * import { NgModule } from '@angular/core';
713
- *
714
- * // Import the app component
701
+ * import { IconsModule } from '@progress/kendo-angular-icons';
702
+ * import { BrowserModule } from '@angular/platform-browser';
715
703
  * import { AppComponent } from './app.component';
716
704
  *
717
- * // Define the app module
718
- * _@NgModule({
719
- * declarations: [AppComponent], // declare app component
720
- * imports: [BrowserModule, IconsModule], // import Icons module
721
- * bootstrap: [AppComponent]
705
+ * @NgModule({
706
+ * declarations: [AppComponent],
707
+ * imports: [BrowserModule, IconsModule],
708
+ * bootstrap: [AppComponent]
722
709
  * })
723
710
  * export class AppModule {}
724
- *
725
- * // Compile and launch the module
726
- * platformBrowserDynamic().bootstrapModule(AppModule);
727
- *
728
711
  * ```
729
712
  */
730
713
  class IconsModule {
@@ -6,7 +6,12 @@ import { ElementRef, Renderer2 } from '@angular/core';
6
6
  import { IconBaseDirective } from '../common/icon-base';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Represents the Kendo UI Icon component for Angular.
9
+ * Represents the Icon component for Angular.
10
+ *
11
+ * @example
12
+ * ```html
13
+ * <kendo-icon name="home"></kendo-icon>
14
+ * ```
10
15
  */
11
16
  export declare class IconComponent extends IconBaseDirective {
12
17
  element: ElementRef;
@@ -14,8 +19,7 @@ export declare class IconComponent extends IconBaseDirective {
14
19
  hostClass: boolean;
15
20
  hostAriaHidden: boolean;
16
21
  /**
17
- * Defines the name for an existing icon in a Kendo UI theme, which will be rendered.
18
- * All [Kendo UI Icons](slug:icon_list) are supported.
22
+ * Sets the `Icon` to render. Supports all [Kendo UI Icons](slug:icon_list).
19
23
  */
20
24
  set name(name: string);
21
25
  get name(): string;
@@ -15,37 +15,24 @@ export declare class IconWrapperComponent implements OnDestroy {
15
15
  element: ElementRef;
16
16
  hostClass: boolean;
17
17
  /**
18
- * Defines the name for an existing font icon in a Kendo UI theme, which will be rendered.
19
- * All [Kendo UI Icons](slug:icons#icons-list) are supported.
18
+ * Sets the name for an existing font icon in a Kendo UI theme to render.
19
+ * Supports all [Kendo UI Icons](slug:icons#icons-list).
20
20
  */
21
21
  name: string;
22
22
  /**
23
- * Defines an [SVGIcon](slug:api_icons_svgicon) to be rendered.
23
+ * Sets the [SVGIcon](slug:api_icons_svgicon) to render.
24
24
  */
25
25
  svgIcon: SVGIcon;
26
26
  /**
27
- * Provided by consuming components in case an additional k-specific class needs to be rendered
28
- * on the internal Icon component.
27
+ * Sets an additional class on the internal Icon component.
29
28
  */
30
29
  innerCssClass: string;
31
30
  /**
32
- * Provided by consuming components in case a custom font icon class is set
33
- * by the developer using the consuming component through its API.
31
+ * Sets a custom font icon class using the API of the consuming component.
34
32
  */
35
33
  customFontClass: string;
36
34
  /**
37
- * Specifies the size of the Icon.
38
- *
39
- * The possible values are:
40
- * * `default` (Default) (Font-size: 16px; Width: 16px; Height: 16px)
41
- * * `xsmall` (Font-size: 12px; Width: 12px; Height: 12px;)
42
- * * `small` (Font-size: 14px; Width: 14px; Height: 14px;)
43
- * * `medium` (Font-size: 16px; Width: 16px; Height: 16px;)
44
- * * `large` (Font-size: 20px; Width: 20px; Height: 20px;)
45
- * * `xlarge` (Font-size: 24px; Width: 24px; Height: 24px;)
46
- * * `xxlarge` (Font-size: 32px; Width: 32px; Height: 32px;)
47
- * * `xxxlarge` (Font-size: 48px; Width: 48px; Height: 48px;)
48
- *
35
+ * Sets the `IconSize` for the icon.
49
36
  */
50
37
  size: IconSize;
51
38
  get customClasses(): string;