Appearance

Iconify 工具 ​

Iconify Tools 是一组用于导入、导出和解析图标的可复用函数。

该库使用 TypeScript 编写。

安装 ​

要安装该库，请运行：

npm install @iconify/tools --save

CommonJS 支持 ​

最新版本不支持 CommonJS。

如果您需要使用 CommonJS，请安装版本 4：

npm install @iconify/tools@cjs --save

类 ​

在 Iconify Tools 中，所有用于解析图标的函数都基于两个主要类：

  • SVG 代表单个图标。当需要操作图标的元素时，会使用此类。
  • IconSet 代表一个图标集，提供了易于使用的函数来管理图标。

导入 ​

要开始使用图标集，您可以创建空白图标集，或从某些来源导入图标集。

导入图标的相关文档：

在使用 Iconify Tools 之前，您应了解该包具有明确的设计约定。 某些标签是不被允许的，并且会导致导入失败。 请参阅 SVG 导入限制。

清理与验证 ​

如果图标来自以下来源，导入图标后您首先应该做的就是清理和验证图标：

  • 图像编辑软件。此类软件通常会在图标中留下大量冗余代码，必须将其移除。
  • 第三方来源。您需要确保图标不包含脚本或事件。

请参阅 cleanupSVG() 文档。

图标操作 ​

Iconify Tools 提供了多个用于操作图标的函数。您可以：

  • 检查或更改调色板。
  • 优化图标。
  • 修复 <path> 元素以兼容旧版软件。

有关可用函数列表，请参阅图标操作函数。

导出 ​

操作图标后，您可以将图标集导出为各种格式。

导出图标的相关文档：

包管理函数 ​

除了管理图标外，Iconify Tools 还提供了一些用于管理包和仓库的函数：