constructor

• new IgxIconService(_sanitizer, _httpClient, _platformUtil, document): IgxIconService

• Parameters

  • _sanitizer: DomSanitizer

  • _httpClient: HttpClient

  • _platformUtil: PlatformUtil

  • document: Document

  Returns IgxIconService

iconLoaded

this.service.iconLoaded.subscribe((ev: IgxIconLoadedEvent) => ...);
Copy

defaultFamily

• get defaultFamily(): IconFamily

• Returns the default font-family.

    const defaultFamily = this.iconService.defaultFamily;
  Copy

  Returns IconFamily

• set defaultFamily(family): void

• Sets the default font-family.

    this.iconService.defaultFamily = 'svg-flags';
  Copy

  Parameters

  • family: IconFamily

  Returns void

addIconRef

• addIconRef(name, family, icon): void

• Adds an icon reference meta for an icon in a meta family. Executes only if no icon reference is found.

    this.iconService.addIconRef('aruba', 'default', { name: 'aruba', family: 'svg-flags' });
  Copy

  Parameters

  • name: string

  • family: string

  • icon: IconMeta

  Returns void

addSvgIcon

• addSvgIcon(name, url, family?, stripMeta?): void

• Adds an SVG image to the cache. SVG source is an url.

    this.iconService.addSvgIcon('aruba', '/assets/svg/country_flags/aruba.svg', 'svg-flags');
  Copy

  Parameters

  • name: string

  • url: string

  • family: string = ...

  • stripMeta: boolean = false

  Returns void

addSvgIconFromText

• addSvgIconFromText(name, iconText, family?, stripMeta?): void

• Adds an SVG image to the cache. SVG source is its text.

    this.iconService.addSvgIconFromText('simple', '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 200">
    <path d="M74 74h54v54H74" /></svg>', 'svg-flags');
  Copy

  Parameters

  • name: string

  • iconText: string

  • family: string = ...

  • stripMeta: boolean = false

  Returns void

familyClassName

• familyClassName(alias): string

• Returns the custom class, if any, associated to a given font-family.

    const familyClass = this.iconService.familyClassName('material');
  Copy

  Parameters

  • alias: string

  Returns string

getIconRef

• getIconRef(name, family): IconReference

• Returns the icon reference meta for an icon in a given family.

    const iconRef = this.iconService.getIconRef('aruba', 'default');
  Copy

  Parameters

  • name: string

  • family: string

  Returns IconReference

getSvgIcon

• getSvgIcon(name, family): SafeHtml

• Returns the cached SVG image as string.

    const svgIcon = this.iconService.getSvgIcon('aruba', 'svg-flags');
  Copy

  Parameters

  • name: string

  • family: string

  Returns SafeHtml

isSvgIconCached

• isSvgIconCached(name, family): boolean

• Returns whether a given SVG image is present in the cache.

    const isSvgCached = this.iconService.isSvgIconCached('aruba', 'svg-flags');
  Copy

  Parameters

  • name: string

  • family: string

  Returns boolean

registerFamilyAlias

• registerFamilyAlias(alias, className?, type?): this

• Registers a custom class to be applied to IgxIconComponent for a given font-family.

    this.iconService.registerFamilyAlias('material', 'material-icons');
  Copy

  Deprecated

  in version 18.1.0. Use setFamily instead.

  Parameters

  • alias: string

  • className: string = alias

  • type: IconType = "font"

  Returns this

setFamily

• setFamily(name, meta): void

• Creates a family to className relationship that is applied to the IgxIconComponent whenever that family name is used.

    this.iconService.setFamily('material', { className: 'material-icons', type: 'liga' });
  Copy

  Parameters

  • name: string

  • meta: FamilyMeta

  Returns void

setIconRef

• setIconRef(name, family, icon): void

• Similar to addIconRef, but always sets the icon reference meta for an icon in a meta family.

    this.iconService.setIconRef('aruba', 'default', { name: 'aruba', family: 'svg-flags' });
  Copy

  Parameters

  • name: string

  • family: string

  • icon: IconMeta

  Returns void