@figit/fig-kiwi

中文文档
0.2.0发布于 2026/07/22MITTypeScriptES Module构建来源已验证近 30 天下载 3.7万

Encode Figma's Kiwi binary format and HTML clipboard envelope.

原始使用文档
文档目录3 节
  1. API
  2. Regenerating the schema
  3. License

@figit/fig-kiwi

Encode Figma's Kiwi binary format and HTML clipboard envelope.

import { encodeFigmaData, composeClipboardHtml } from "@figit/fig-kiwi";

const { figBytes, base64 } = encodeFigmaData(message);
const html = composeClipboardHtml(base64, { dataType: "scene", fileKey: "TEST", pasteID: 123 });

API

  • encodeFigmaData(message) — encode a Kiwi Message into fig-kiwi bytes (magic + version + deflated schema + deflated data) plus base64.
  • composeClipboardHtml(base64, meta?) — wrap the base64 payload in the HTML envelope Figma reads on paste, using Figma-style data-metadata and data-buffer attributes so WebKit preserves the markers during HTML clipboard sanitization. Works in any environment with btoa (no DOM).
  • toClipboardItem(html) — browser/extension helper that wraps the HTML in a ClipboardItem for navigator.clipboard.write.
  • KiwiWriter — varint write primitives (byte, bool, uint, int, float, string, …) for callers that need to emit other Kiwi structures.
  • SCHEMA — the bundled Figma Kiwi schema.

Regenerating the schema

src/schema.json is generated. To pull a fresh copy from Figma:

# In Figma: select any node, Cmd+C
pnpm extract-schema

The script reads the system clipboard's text/html, decodes the embedded Kiwi schema, and overwrites src/schema.json. macOS and Linux clipboard reads work automatically; on Windows, pipe HTML on stdin or pass a file path:

pnpm extract-schema clipboard.html       # from a file
cat clipboard.html | pnpm extract-schema -   # from stdin

License

MIT — Figit.

版本与发布记录

@figit/fig-kiwi 共发布 4 个版本,首次发布于 2026/05/19;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.0latest2026/07/223 个月前
0.1.02026/07/114 个月前
0.0.22026/05/215 个月前
0.0.12026/05/195 个月前

关于 @figit/fig-kiwi 的常见问题

@figit/fig-kiwi 是什么?

Encode Figma's Kiwi binary format and HTML clipboard envelope.

如何安装 @figit/fig-kiwi?

在项目目录运行 npm install @figit/fig-kiwi,或使用 pnpm add / yarn add / bun add。

@figit/fig-kiwi 支持 TypeScript 吗?

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

@figit/fig-kiwi 支持 ESM 还是 CommonJS?

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

@figit/fig-kiwi 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@figit/fig-kiwi 可以商用吗?

@figit/fig-kiwi 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@figit/fig-kiwi 的下载量有多少?

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

@figit/fig-kiwi 还在维护吗?

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