Appearance

importFromFigma() 中使用的类型 ​

本文是 importFromFigma() 文档的一部分。

FigmaImportResult ​

成功时，importFromFigma() 会返回 FigmaImportResult 对象，该对象包含以下属性：

  • name，string。文档名称。
  • version，string。文档版本。
  • lastModified，string。上次修改的时间（字符串格式）。你可以将其传递给 ifModifiedSince，以检查文档自上次解析后是否发生过修改。
  • iconSet，IconSet。图标集实例。
  • nodesCount，number。找到的图标数量（即被 iconNameForNode 标记为图标的节点）。
  • generatedIconsCount，number。Figma API 生成的图标数量。如果与 nodesCount 不一致，说明某些图层被错误地标记为了图标。
  • downloadedIconsCount，number。已下载的图标数量。如果与 generatedIconsCount 不一致，说明发生了一些错误，通常是由网络连接不佳引起的。
  • missing，FigmaIconNode。未能获取的图标列表。详见下文。

FigmaIconNode ​

类型 FigmaIconNode 用于回调函数以及 FigmaImportResult 的 missing 属性中。

它代表一个图标，包含以下属性：

  • id，string。Figma 文档中的节点 ID。
  • name，string。节点名称。
  • keyword，string。图标的关键词，由 iconNameForNode 回调函数返回。

在解析图标的不同阶段，会向该对象添加以下属性：

  • url，string。生成图像的 URL。如果缺失，说明 Figma API 无法导出该图标。
  • content，string。从 url 下载的图标内容。如果缺失，说明导入函数无法获取已导出的图标数据。

FigmaImportNodeData ​

类型 FigmaImportNodeData 用作 iconNameForNode 回调函数的第一个参数。

它是一个简单的对象，包含以下属性：

  • id，string。节点 ID。
  • type，string。节点类型："FRAME"、"COMPONENT" 或 "INSTANCE"。
  • name，string。节点名称。
  • width 和 height，number。节点的尺寸。
  • parents，FigmaParentNodeData[]。父节点列表（第一项为页面，最后一项为图标的直接父节点）。

传递给回调函数的节点数据示例：

json{
   "id": "12:724",
   "type": "FRAME",
   "name": "arrow-down",
   "width": 32,
   "height": 32,
   "parents": [
       { "id": "0:1", "type": "CANVAS", "name": "Icons" },
       { "id": "12:479", "type": "FRAME", "name": "Regular" }
   ]
}

FigmaParentNodeData ​

类型 FigmaParentNodeData 用于 FigmaImportNodeData 中，以及作为 filterParentNode 回调函数的第一个参数。

它是一个简单的对象，包含以下属性：

  • id，string。节点 ID。
  • type，string。节点类型："CANVAS"、"FRAME" 或 "GROUP"。
  • name，string。节点名称。

示例：

json{
   "id": "0:1",
   "type": "CANVAS",
   "name": "Icons"
}
json{
   "id": "12:479",
   "type": "FRAME",
   "name": "Regular"
}