@design-parity/adapter-figma

中文文档
1.18.0发布于 2026/11/07Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 1.1万

Figma ReferenceAdapter:通过代码连接解决一个Figma节点的组件,在REST API上取出参考图像+变量,并正常化为设计参考.

中文使用文档
文档目录4 节
  1. 它会做什么
  2. 认证
  3. 使用量
  4. 标注

@ design- parity/ adapter- figma

图片 ReferenceAdapter法格玛是关键点来源——唯一一个拥有 机器可溶解设计-编码链接(代码连接) (中文(简体) ). 此适配器使用 REST API + 代码连接,从不使用 Dev Mode MCP 服务器(即 面向本地/桌面会议,对主机错误).

它会做什么

resolve(componentId, ref, ctx)数字 :

  1. 解取结. 若为 ref 是一个手柄( e)figma:<fileKey>/<nodeId> 或一个 figma.com URL)直接解析. 否则适配器会读Repo的 代码连接输出( C)figma.code-connect.json,或 FIGMA_CODE_CONNECT_FILE(中文(简体) ) 将组件映射到节点.
  2. 获取结构 —— 说 GET /v1/files/:key/nodes (铺设,角半径, 填充,文本样式).
  3. 获取变量 —— 说 GET /v1/files/:key/variables/local绘图 收藏模式(Light/Dark)为主题颜色。 优雅地贬低 当变量不合格时,只使用结构符号.
  4. 渲染参考图像 —— 说 GET /v1/images,下载和写入 下级 outDir。 。 。 .
  5. 规范化 改为 DesignReference 与 linkMethod: "code-connect", (中文(简体) ), 包括 layout - 节点树的 absoluteBoundingBox平分为a SemanticTree (root-relative dp,框于根上)所以结构布局 diff可以比较元素放置. 文本节点被其可见的标签 characters,这是符合候选人语义标签的;其他 节点回落到它们的相克图层名称 所以一般没有匹配到 层命名被调和。 节点没有边框时缺席.

认证

从 AdapterContext.env数字 :

  • FIGMA_OAUTH_TOKEN → Authorization: Bearer (首选),或
  • FIGMA_TOKEN 编号 : FIGMA_PAT 编号 : FIGMA_ACCESS_TOKEN → X-Figma-Token。 。 。 .

证书缺失, 401/403, (中文(简体) ), 429 (费率限额,与 Retry-After页:1 缺少节点, 每个节点会升起一个键入 FigmaError 子类.

使用量

import { createFigmaAdapter } from "@design-parity/adapter-figma";

const adapter = createFigmaAdapter({
  // optionally render one image per theme from separate frames
  resolveTargets: (ref) => [
    { nodeId: ref.nodeId, theme: "light", size: "compact" },
    { nodeId: "1:43", theme: "dark", size: "compact" },
  ],
});

const reference = await adapter.resolve(
  "ui/Button.kt#PrimaryButton",
  "figma:AbCdEf123456/1:42",
  { repoRoot: process.cwd(), env: process.env },
);

网络可注射( E)fetch),客户端可被取笑,所以单位测试运行 全线下行( 见 test/) (中文(简体) ).

标注

Figma 的图像渲染使用节点默认可变模式; REST API 无法 切换模式 。 所以他们 符号 来自变量(所有模式), 时 图像 来自通过 resolveTargets。 。 。 .

版本与发布记录

@design-parity/adapter-figma 共发布 102 个版本,首次发布于 2026/06/14;过去 12 个月发布了 102 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.18.0latest2026/11/074 天前
1.17.02026/10/2617 天前
1.16.12026/10/1824 天前
1.16.02026/10/1726 天前
1.15.02026/10/1528 天前
1.14.12026/10/1230 天前

关于 @design-parity/adapter-figma 的常见问题

@design-parity/adapter-figma 是什么?

Figma ReferenceAdapter:通过代码连接解决一个Figma节点的组件,在REST API上取出参考图像+变量,并正常化为设计参考.

如何安装 @design-parity/adapter-figma?

在项目目录运行 npm install @design-parity/adapter-figma,或使用 pnpm add / yarn add / bun add。

@design-parity/adapter-figma 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@design-parity/adapter-figma 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@design-parity/adapter-figma 可以商用吗?

@design-parity/adapter-figma 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@design-parity/adapter-figma 的下载量有多少?

根据 npm 官方下载统计,@design-parity/adapter-figma 在 2026/10/12 – 2026/11/10 这 30 天内被下载 10,615 次,日均约 354 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@design-parity/adapter-figma 还在维护吗?

最新版本 1.18.0 发布于 2026/11/07(4 天前);至今共发布 102 个版本,其中过去 12 个月发布了 102 个;首次发布于 2026/06/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。