index

title: Importing icons
types:
  IconSet: '../icon-set/index.md'
  SVG: '../svg/index.md'
  IconifyJSON: '/docs/types/iconify-json.md'
functions:
  forEach: '../icon-set/for-each.md'
  cleanupSVG: '../icon/cleanup.md'
  runSVGO: '../icon/svgo.md'
  parseColors: '../icon/colors.md'
  deOptimisePaths: '../icon/paths.md'
  importDirectory: './directory.md'
  importDirectorySync: './directory.md'
  importFromFigma: './figma/index.md'

Importing icons

Iconify Tools can import icons from several sources.

Usage

All functions listed below are asynchronous. Most functions create [type]IconSet instances.

Before using Iconify Tools, you should be aware that package is opinionated. Certain SVG elements are not allowed and will cause import to fail. See SVG import limitations.

Async

Most functions are asynchronous.

include libraries/tools/async

Cleanup

After importing icons, make sure you validate them. See [func]cleanupSVG() function.

Import functions

There are several functions for importing icons:

importDirectory()

Functions [func]importDirectory() and [func]importDirectorySync() import SVG files from directory.

importFromFigma()

Function [func]importFromFigma() imports icons from Figma document.

Importing single icon {#svg}

Making a function for importing a single file is redundant. All you have to do is read file and create [type]SVG instance.

See importing SVG documentation.

Importing Iconify icon set {#json}

Making a function for importing [type]IconifyJSON data is also redundant. All you have to do is read file and create [type]IconSet instance.

See importing Iconify icon set documentation.