Skip to content

export()

此函数属于 Iconify Tools 中的 IconSet 类。

函数 export() 将图标集导出为 IconifyJSON 对象。

用法

该函数包含以下参数:

  • validateboolean 类型。可选。如果启用,将在导出前验证图标。

函数返回 IconifyJSON 对象。

结果包含所有元数据。如果图标集包含 information 属性,导出时将自动更新信息块中的图标总数。

示例

example.ts
tsimport { blankIconSet } from '@iconify/tools';

// Create icon set, add few icons
const iconSet = blankIconSet('test-prefix');
iconSet.setIcon('add', {
   body: '<path d="M14 7v1H8v6H7V8H1V7h6V1h1v6h6z"/>',
});
iconSet.setIcon('triangle-left', {
   body: '<g fill="currentColor"><path d="M10.44 2l.56.413v11.194l-.54.393L5 8.373v-.827L10.44 2z"/></g>',
});
iconSet.setVariation('triangle-right', 'triangle-left', {
   hFlip: true,
});

// Set information
iconSet.info = {
   name: 'Test',
   author: {
       name: 'Me',
   },
   license: {
       title: 'MIT',
   },
};

// Export icon set
const data = iconSet.export();
console.log(JSON.stringify(data, null, '\t'));
Result:
json{
   "prefix": "test-prefix",
   "info": {
       "name": "Test",
       "author": {
           "name": "Me"
       },
       "license": {
           "title": "MIT"
       },
       "total": 3
   },
   "icons": {
       "add": {
           "body": "<path d=\"M14 7v1H8v6H7V8H1V7h6V1h1v6h6z\"/>"
       },
       "triangle-left": {
           "body": "<g fill=\"currentColor\"><path d=\"M10.44 2l.56.413v11.194l-.54.393L5 8.373v-.827L10.44 2z\"/></g>"
       }
   },
   "aliases": {
       "triangle-right": {
           "parent": "triangle-left",
           "hFlip": true
       }
   }
}