Icons Overview

The icon components are used to display font or SVG icons.

Basic Usage

The following example demonstrates all available Icon components in action.

import { Component, ViewEncapsulation } from '@angular/core';

import { camera } from '@progress/kendo-svg-icons';

@Component({
    selector: 'my-app',
    template: `
        <div class="wrapper">
            <div class="icon-wrapper">
                <span>Icon</span>
                <kendo-icon [name]="'photo-camera'" [size]="'medium'"></kendo-icon>
            </div>
            <div class="svg-icon-wrapper">
                <span>SVG Icon</span>
                <kendo-svg-icon [icon]="icons.camera" [size]="'medium'"></kendo-svg-icon>
            </div>
        </div>
    `,
    styles: [`
       .wrapper,
       .icon-wrapper,
       .svg-icon-wrapper {
            display: flex;
        }

        .icon-wrapper,
        .svg-icon-wrapper {
           flex-direction: column;
           min-width: 80px;
           align-items: center;
       }
    `],
    encapsulation: ViewEncapsulation.None,
})
export class AppComponent {
    icons = { camera };
}
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
import { IconsModule } from '@progress/kendo-angular-icons';
import { CommonModule } from '@angular/common';

import { AppComponent } from './app.component';

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        IconsModule
    ],
    declarations: [
        AppComponent
    ],
    bootstrap: [ AppComponent ]
})
export class AppModule {}
import { enableProdMode } from '@angular/core';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app.module';

enableProdMode();

const platform = platformBrowserDynamic();
platform.bootstrapModule(AppModule, { preserveWhitespaces: true });

Installation

Either use the quick setup (Angular CLI v6 or later) or manually add the package (Angular CLI v5 or earlier).

Quick Setup with Angular CLI v6 or Later

Angular CLI v6 supports the addition of packages through the ng add command which executes in one step the set of otherwise individually needed commands.

ng add @progress/kendo-angular-icons

Manual Setup

All components that you reference during the installation will be present in the final bundle of your application. To avoid ending up with components you do not actually need, either:

  • Import all Icons components at once by using the IconsModule, or
  • Import a specific Icon component by adding it as an individual NgModule.

  1. Download and install the package.

    npm install --save @progress/kendo-angular-icons @progress/kendo-angular-common
  2. Once installed, import the NgModule of the components you need.

    To get all package components, import the IconsModule in your application root or feature module.

    import { NgModule } from '@angular/core';
       import { BrowserModule } from '@angular/platform-browser';
       import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
       import { IconsModule } from '@progress/kendo-angular-layout';
       import { AppComponent } from './app.component';
    
       @NgModule({
           bootstrap:    [AppComponent],
           declarations: [AppComponent],
           imports:      [BrowserModule, BrowserAnimationsModule, IconsModule]
       })
       export class AppModule {
       }

    The package also exports the following modules for individual components:

    • IconModule
    • SVGIconModule

    To reduce the size of your application, include only the ones you need.

    import { NgModule } from '@angular/core';
       import { BrowserModule } from '@angular/platform-browser';
       import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
       import { AppComponent } from './app.component';
    
       // Imports the Icon
       import { IconModule } from '@progress/kendo-angular-icons';
    
       @NgModule({
           bootstrap: [AppComponent],
           declarations: [AppComponent],
           imports: [BrowserModule, BrowserAnimationsModule, IconModule]
       })
       export class AppModule {}
  3. You are required to install one of the Kendo UI themes for Angular to style your components. For more information on how to add the styles, refer to the section on styling.

Dependencies

The Icons requires you to install the following peer dependencies in your application:

  • @angular/animations
  • @angular/common
  • @angular/core
  • @progress/kendo-angular-common
  • @progress/kendo-svg-icons
  • rxjs

In this article