Expand all

Icon

A wrapper for creating an icon.

Constructor

new Icon(options) #

Parameters:

Name Type Description
options Object

Configuration options
Source:

Properties

defaults #

Properties:

Name Type Description
defaults Object
Properties:
Name Type Description
base string

Base icon class. Defaults to 'mf-icon'.
glyphPrefix string

Prefix for the icon class Defaults to 'mf'.
icon string

Name of the icon.
rotation boolean

will rotate the icon by a certain number of degrees. Must be ±90, 0 or ±180 or will throw exception.
isSmall boolean

If icon is small.
addtionalClassNames string

Additional classes to be added to the icon.
Mixes in:
Source:

isTemplateMode #

Source:

Methods

getClassName() → {string} #

Return the full class name that is required for the icon to render

Source:

Returns:

Type
string
Return the full class name that is required for the icon to render

getGlyphClassName() → {string} #

Return the class that relates to the icon glyph

Source:

Returns:

Type
string
Return the class that relates to the icon glyph

preRender() #

Source: