IconifyIconName type

IconifyIconName is a simple object with the following properties, all properties are mandatory:

  • provider, string. API provider. For public Iconify API value is an empty string "".
  • prefix, string. Icon set prefix.
  • name, string. Icon name.

Icon name as string

API providers allow using icons from multiple API in the same document. For example, you can use default Iconify icons and custom icons from IconScout or Icons8 or custom API.

Public API

@my-icons

@icons8

mdi-light:home

@my-icons:line-24:home

@icons8:ios:home

See API providers documentation for details.

Examples

md:home
{
   "provider": "",
   "prefix": "md",
   "name": "home"
}
Because prefix does not contain dash, icon can also be referred as 'md-home'
@local:line-icons:arrow-left
{
   "provider": "local",
   "prefix": "line-icons",
   "name": "arrow-left"
}