Appearance

将图标导出到目录 ​

本教程是 Iconify Tools 中导出函数文档的一部分。

函数 exportToDirectory() 将 IconSet 实例中的所有图标写入指定目录。

用法 ​

该函数具有以下参数：

  • iconSet，IconSet。要导出的图标集。
  • options，object。选项。见下文。

函数返回已存储图标的数组。

该函数是异步的。这意味着你需要将其作为 Promise 实例进行处理，通常在函数调用前添加 await。

选项 ​

options 对象具有以下必需属性：

  • target，string。目标目录。如果目录不存在，将会自动创建。

以及以下可选属性：

  • cleanup，boolean。如果为 true，则在导出图标前会清空目标目录。默认为 false。
  • autoHeight，boolean。如果为 true，图标的尺寸将与 viewBox 匹配。如果为 false，图标的高度将设置为 "1em"。默认为 true。
  • includeAliases，boolean。为别名生成文件。默认为 true。
  • includeChars，boolean。为字符生成文件，例如为分配了字符 "f00" 的图标生成 f00.svg。默认为 false。
  • log，boolean。如果为 true，函数将记录处理过程。默认为 false。

示例 ​

example.ts
tsimport { exportToDirectory, IconSet } from '@iconify/tools';

(async () => {
   // Import icons
   const iconSet = new IconSet({
       prefix: 'test',
       icons: {
           maximize: {
               body: '<g fill="currentColor"><path d="M3 3v10h10V3H3zm9 9H4V4h8v8z"/></g>',
           },
           minimize: {
               body: '<g fill="currentColor"><path d="M14 8v1H3V8h11z"/></g>',
           },
       },
       width: 24,
       height: 24,
   });

   // Export all icons
   await exportToDirectory(iconSet, {
       target: `output/${iconSet.prefix}`,
       log: true,
   });
})();