ec.components documentation
  1. Injectables
  2. IconService

File

packages/ui/src/lib/icon/icon.service.ts

Description

Service to register icons and icon sets. The default set is ec-icons. (Requires including ec-icons) https://components.entrecode.de/ui/icons?e=1

Extends

SymbolService

Index

Properties
Methods

Methods

Static get
get(name: string, registry)
Inherited from SymbolService
Defined in SymbolService:27

finds a symbol in the registry by name

Parameters :
Name Type Optional Default value
name string No
registry No SymbolService.registry
Returns : Symbol
get
get(name: string)
Inherited from SymbolService
Defined in SymbolService:70

finds a symbol in the registry by name

Parameters :
Name Type Optional
name string No
Returns : Symbol
Static resolve
resolve(name: string, registry)
Inherited from SymbolService
Defined in SymbolService:32
Parameters :
Name Type Optional Default value
name string No
registry No SymbolService.registry
Returns : string
resolve
resolve(name: string)
Inherited from SymbolService
Defined in SymbolService:75

resolves a symbols content by name

Parameters :
Name Type Optional
name string No
Returns : string
Static set
set(symbols: Symbol[], registry)
Inherited from SymbolService
Defined in SymbolService:41

Uses the given symbol set to enhance the current registry. All duplicates will be overriden. Non specified symbols will stay in the registry.

Parameters :
Name Type Optional Default value
symbols Symbol[] No []
registry No SymbolService.registry
Returns : void
set
set(symbols: Symbol[])
Inherited from SymbolService
Defined in SymbolService:81

Uses the given symbol set to enhance the current registry. All duplicates will be overriden. Non specified symbols will stay in the registry.

Parameters :
Name Type Optional Default value
symbols Symbol[] No []
Returns : void
use
use(symbols: Symbol[])
Inherited from SymbolService
Defined in SymbolService:57

Uses the given symbol set. Replaces registry.

Parameters :
Name Type Optional
symbols Symbol[] No
Returns : void
useSet
useSet(key: string)
Inherited from SymbolService
Defined in SymbolService:62

uses the set with the given key

Parameters :
Name Type Optional
key string No
Returns : void

Properties

Public registry
Type : Symbol[]
Default value : ixo
Defined in packages/ui/src/lib/icon/icon.service.ts:11

The current icon set that is registered to the service. It will be used to resolve icons from.

Static registry
Type : Symbol[]
Default value : Object.keys(SymbolService.sets).length ? SymbolService.sets[Object.keys(SymbolService.sets)[0]] : []
Inherited from SymbolService
Defined in SymbolService:16
Public registry
Type : Symbol[]
Inherited from SymbolService
Defined in SymbolService:20
Static sets
Type : literal type
Default value : { en, de, }
Inherited from SymbolService
Defined in SymbolService:12

The current symbol set that is registered to the service. It will be used to resolve strings from.

Public sets
Type : literal type
Default value : { en, de, }
Inherited from SymbolService
Defined in SymbolService:21 
import { Injectable } from '@angular/core';
import { ixo } from './ixo';
import { Symbol } from '../symbol/symbol.interface';
import { SymbolService } from '../symbol/symbol.service';
/** Service to register icons and icon sets. The default set is ec-icons. (Requires including ec-icons)
 * <example-url>https://components.entrecode.de/ui/icons?e=1</example-url>
 */
@Injectable()
export class IconService extends SymbolService {
  /** The current icon set that is registered to the service. It will be used to resolve icons from. */
  public registry: Symbol[] = ixo;
}

result-matching ""

    No results matching ""