Figma 部件 API 输入

此寄存器包含 Figma 部件 API 的打字功能 .

使用量

1. 安装

   注意部件 api 是插件 api 的缩放, 所以您应该同时安装 @figma/plugin-typings 财务报告和审定财务报表 @figma/widget-typings

   npm i --save-dev @figma/plugin-typings @figma/widget-typings
   

2. 配置 tsconfig.json (英语)

   {
       "compilerOptions": {
           "typeRoots": [
               "./node_modules/@types",
               "./node_modules/@figma"
           ]
       }
   }
   

TypeScript 编译器需要上面的配置来使用两种类型的定义 ./node_modules/@types 财务报告和审定财务报表 ./node_modules/@figma。通常,大多数外部类型定义来自绝对Typed并安装在 /@types,默认情况下由 TypeScript 包含。 由于我们单独托管了插件和部件打字,它们被安装在外部 /@figma 换句话说.

类型应在全球范围内提供,而无需使用进口说明。 我们这样做是因为部件 API 是主机环境的一部分, 而不是一个插件包含的软件包 .

关于

部件 API 发布有"Version X, Update Y"的格式. 在此寄存器中创建等同标记为 v<x>.<y>。请注意,并非所有的API发布都包含 API 更改,有些只是错误修正. 因此,一些打字版本被跳过.