constructor

• new IgxIconComponent(el, iconService, ref): IgxIconComponent

• Parameters

  • el: ElementRef<any>

  • iconService: IgxIconService

  • ref: ChangeDetectorRef

  Returns IgxIconComponent

active

<igx-icon [active]="false">settings</igx-icon>
Copy

ariaHidden

@ViewChild("MyIcon") public icon: IgxIconComponent;
constructor(private cdRef:ChangeDetectorRef) {}
ngAfterViewInit() {
    this.icon.ariaHidden = false;
    this.cdRef.detectChanges();
}
Copy

el

family

<igx-icon family="material">settings</igx-icon>
Copy

name

<igx-icon name="contains" family="filter-icons"></igx-icon>
Copy

getActive

• get getActive(): boolean

• An accessor that returns the value of the active property.

  Example

  @ViewChild("MyIcon")
  public icon: IgxIconComponent;
  ngAfterViewInit() {
     let iconActive = this.icon.getActive;
  }
  Copy

  Returns boolean

getFamily

• get getFamily(): string

• An accessor that returns the value of the family property.

  Example

   @ViewChild("MyIcon")
  public icon: IgxIconComponent;
  ngAfterViewInit() {
     let iconFamily = this.icon.getFamily;
  }
  Copy

  Returns string

getInactive

• get getInactive(): boolean

• An accessor that returns inactive property.

  Example

  @ViewChild("MyIcon")
  public icon: IgxIconComponent;
  ngAfterViewInit() {
     let iconActive = this.icon.getInactive;
  }
  Copy

  Returns boolean

getName

• get getName(): string

• An accessor that returns the value of the iconName property.

  Example

  @ViewChild("MyIcon")
  public icon: IgxIconComponent;
  ngAfterViewInit() {
     let name = this.icon.getName;
  }
  Copy

  Returns string

getSvg

• get getSvg(): SafeHtml

• An accessor that returns the underlying SVG image as SafeHtml.

  Example

  @ViewChild("MyIcon")
  public icon: IgxIconComponent;
  ngAfterViewInit() {
     let svg: SafeHtml = this.icon.getSvg;
  }
  Copy

  Returns SafeHtml

template

• get template(): TemplateRef<HTMLElement>

• An accessor that returns a TemplateRef to explicit, svg or no ligature.

  Example

  @ViewChild("MyIcon")
  public icon: IgxIconComponent;
  ngAfterViewInit() {
     let iconTemplate = this.icon.template;
  }
  Copy

  Returns TemplateRef<HTMLElement>