resolve()

This function is part of IconSet class in Iconify Tools.

Function resolve() retrieve data for icon in IconifyIcon format.

Usage

Function has the following parameters:

  • name, string. Icon name.
  • full, boolean. Optional. If true, function will return full icon data (FullIconifyIcon).

Function returns IconifyIcon (or FullIconifyIcon if second parameter is true), null on error.

Example

example.ts
import { IconSet } from '@iconify/tools';

const iconSet = new IconSet({
   prefix: 'codicon',
   icons: {
       'add': {
           body: '<g fill="currentColor"><path d="M14 7v1H8v6H7V8H1V7h6V1h1v6h6z"/></g>',
       },
       'debug-pause': {
           body: '<g fill="currentColor"><path d="M4.5 3H6v10H4.5V3zm7 0v10H10V3h1.5z"/></g>',
           hidden: true,
       },
       'triangle-left': {
           body: '<g fill="currentColor"><path d="M10.44 2l.56.413v11.194l-.54.393L5 8.373v-.827L10.44 2z"/></g>',
       },
   },
   aliases: {
       'plus': {
           parent: 'add',
       },
       'triangle-right': {
           parent: 'triangle-left',
           hFlip: true,
       },
   },
});

// Resolve icon (partial and full)
console.log(iconSet.resolve('debug-pause'));
console.log(iconSet.resolve('debug-pause', true));

// Resolve variation (partial and full)
console.log(iconSet.resolve('triangle-right'));
console.log(iconSet.resolve('triangle-right', true));

// Resolve alias (partial and full)
console.log(iconSet.resolve('plus'));
console.log(iconSet.resolve('plus', true));
Results for "debug-pause":
{
   "body": "<g fill=\"currentColor\"><path d=\"M4.5 3H6v10H4.5V3zm7 0v10H10V3h1.5z\"/></g>",
   "hidden": true
}
{
   "left": 0,
   "top": 0,
   "width": 16,
   "height": 16,
   "rotate": 0,
   "vFlip": false,
   "hFlip": false,
   "body": "<g fill=\"currentColor\"><path d=\"M4.5 3H6v10H4.5V3zm7 0v10H10V3h1.5z\"/></g>",
   "hidden": true
}
Results for "triangle-right":
{
   "body": "<g fill=\"currentColor\"><path d=\"M10.44 2l.56.413v11.194l-.54.393L5 8.373v-.827L10.44 2z\"/></g>",
   "hFlip": true
}
{
   "left": 0,
   "top": 0,
   "width": 16,
   "height": 16,
   "rotate": 0,
   "vFlip": false,
   "hFlip": true,
   "body": "<g fill=\"currentColor\"><path d=\"M10.44 2l.56.413v11.194l-.54.393L5 8.373v-.827L10.44 2z\"/></g>"
}
Results for "plus":
{
   "body": "<g fill=\"currentColor\"><path d=\"M14 7v1H8v6H7V8H1V7h6V1h1v6h6z\"/></g>"
}
{
   "left": 0,
   "top": 0,
   "width": 16,
   "height": 16,
   "rotate": 0,
   "vFlip": false,
   "hFlip": false,
   "body": "<g fill=\"currentColor\"><path d=\"M14 7v1H8v6H7V8H1V7h6V1h1v6h6z\"/></g>"
}