index

title: Iconify Tools
replacements:
  - code: "@iconify/tools@2"
    value: "${tools.import-tools2}"
types:
  IconifyIcon: "/docs/types/iconify-icon.md"
  IconifyJSON: "/docs/types/iconify-json.md"
  IconifyInfo: "/docs/types/iconify-info.md"
  FullIconifyIcon: "../utils/full-iconify-icon.md"
  Color: "../utils/color.md"
  FullIconCustomisations: "../utils/icon-customisations.md"
  IconCustomisations: "../utils/icon-customisations.md"
  SVG: "./svg/index.md"
  IconSet: "./icon-set/index.md"
functions:
  mergeIconSets: "./icon-set/merge.md"
  setIcon: "./icon-set/set-icon.md"
  cleanupSVG: "./icon/cleanup.md"

Iconify Tools

Iconify Tools is a set of reusable functions for importing, exporting, and parsing icons.

Library is written in TypeScript.

Installation

To install library run:

npm install @iconify/tools@2 --save

CommonJS support

The latest version does not support CommonJS.

If you need to use CommonJS, install version 4:

npm install @iconify/tools@cjs --save

Classes

include libraries/tools/main-classes

Import

To start working with an icon set, you can either create blank icon set or import icon set from some source.

Documentation from importing icons:

• Importing Iconify JSON data.
• Importing SVG.
• Importing all SVG in directory.
• Importing icons from Figma.

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

Cleanup and validation

Cleaning up and validating icons is the first thing you should do after importing icons if icons come from:

• Image editing software. Often software leaves a lot of junk code in icons, which must be removed.
• Third party. You need to make sure icons do not contain scripts, events.

See [func]cleanupSVG() documentation.

Manipulation

Iconify Tools offer several functions for manipulating icons. You can:

• Check or change color palette.
• Optimise icon.
• Fix [tag]path elements to support old software.

See icon manipulation functions for list of available functions.

Export

After manipulating icons, you can export icon set to various formats.

Documentation from exporting icons:

• Exporting Iconify JSON data.
• Exporting SVG to directory (simplified version).
• Exporting SVG.
• Exporting icon packages.
• Exporting Iconify JSON packages.

Package functions {#package}

In addition to managing icons, Iconify Tools has several functions to manage packages and repositories:

• Download Git repository
• Download GitHub repository using GitHub API
• Download NPM package
• Compare directories
• Manage versions of packages or repositories