Components Icon

Icon

Overview API Examples Style Tokens

LmnIconComponent

import { LmnIconComponent } from '@elemental/ui';
Decorators:@Component
Selectors:lmn-icon

Properties

NameTypeDescription
iconStyle
r
InputSignal<LmnIconStyle | undefined>

Define the style of the icon

nativeElement
r
HTMLElement
negative
r
InputSignalWithTransform<boolean, unknown>

Define the negative status of the icon

size
r
InputSignal<LmnIconSize>

Define the size of the icon

style
r
InputSignal<LmnIconStyle>
Deprecated

Use iconStyle instead. Will be removed in v2.0.0

Define the style of the icon

svgName
r
InputSignal<string>

Define the svg name of the icon to show

theme
r
InputSignal<LmnIconTheme>

Define the theme of the icon to show

weight
r
InputSignal<LmnIconWeight>

Define the weight of the icon

LmnIconService

import { LmnIconService } from '@elemental/ui';
Decorators:@Injectable

Properties

NameTypeDescription
lastLoadedIconSet
r
WritableSignal<string | undefined>

Methods

addIcons()

Add icons to the loaded iconsets

Presentation
addIcons(iconSet: Record<string, LmnIcon | LmnIconExtended> | LmnIconExtended[], iconSetId?: string | undefined): void;
Parameters
NameTypeDescription
iconSet
Record<string, LmnIcon | LmnIconExtended> | LmnIconExtended[]

@param iconSet

iconSetId
string | undefined

@param iconSetId

Returns
void

getIcon()

Get an icon from the loaded datasets

Presentation
getIcon(name?: string | undefined, weight?: number | undefined, style?: string | undefined): SVGElement | undefined;
Parameters
NameTypeDescription
name
string | undefined

@param name

weight
number | undefined

@param weight

style
string | undefined

@param style

Returns
SVGElement | undefined
async

loadIcons()

Load icons from a metadata remote file such as a CDN

Presentation
async loadIcons(url: string): Promise<void>;
Parameters
NameTypeDescription
url
string

@param url

Returns
Promise<void>