IconData

Type

Class

Namespace

craft\fields\data

Inherits

craft\fields\data\IconData

Implements

craft\base\Serializable

Since

5.8.0

Class IconData

View source

Public Properties

Property	Description
name
set
styles

name

Default value

null

View source

set

Default value

null

View source

styles

Default value

null

View source

Public Methods

Method	Description
__construct()	Constructor
__toString()
getKeywords()	Returns the icon’s search keywords.
getSvg()	Returns the icon’s SVG markup.
serialize()	Returns the object’s serialized value.

__construct()

Constructor

View source

Arguments

• $name (string) – The icon name
• $styles (string[]) – The Font Awesome styles the icon is available in
• $set (string, null) – The handle of the custom icon set the icon belongs to, or null for Font Awesome icons

__toString()

View source

Returns

string

getKeywords()

Since

5.12.0

Returns the icon’s search keywords.

View source

Returns

string[]

getSvg()

Since

5.12.0

Returns the icon’s SVG markup.

View source

Returns

string, null – The SVG markup, or null if the icon doesn’t exist

serialize()

Returns the object’s serialized value.

View source

Returns

mixed – The serialized value