# @figma/widget-typings 中文文档

规范地址：https://npmcn.com/package/%40figma/widget-typings/

版本：1\.13\.0
npm 元数据更新时间：2026-09-10T19:34:33.512Z
中文译文更新时间：2026-11-14T17:30:28.928Z
软件包许可：MIT License

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40figma/widget-typings
原文对照：https://npmcn.com/package/%40figma/widget-typings/?lang=original
项目主页：https://github.com/figma/widget-typings#readme
源码仓库：https://github.com/figma/widget-typings

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：134 kB，10 个文件
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@figma/plugin-typings 1\.x
- 首次发布：2021-10-06T20:24:56.305Z
- 最新版本发布：2026-08-06T20:17:39.257Z
- 近 30 天下载量：34183（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 1 个）

## 中文简介

Figma 部件 API 的打字

## 安装

```sh
npm install @figma/widget-typings
```

也可以使用：`pnpm add @figma/widget-typings`、`yarn add @figma/widget-typings`、`bun add @figma/widget-typings`

## README

# Figma 部件 API 输入

[![npm](https://img.shields.io/npm/v/@figma/widget-typings?logo=npm&cacheSeconds=1800)](https://www.npmjs.com/package/@figma/widget-typings)

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

## 使用量

1.  安装
    
    注意部件 api 是插件 api 的缩放, 所以您应该同时安装 `@figma/plugin-typings` 财务报告和审定财务报表 `@figma/widget-typings`
    
    ```sh
    npm i --save-dev @figma/plugin-typings @figma/widget-typings
    ```
    
2.  配置 _tsconfig.json (英语)_
    
    ```js
    {
        "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 更改,有些只是错误修正. 因此,一些打字版本被跳过.

## 常见问题

### @figma/widget-typings 是什么？

Figma 部件 API 的打字

### 如何安装 @figma/widget-typings？

在项目目录运行 npm install @figma/widget-typings，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@figma/plugin-typings（1\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @figma/widget-typings 支持 TypeScript 吗？

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

### @figma/widget-typings 可以商用吗？

@figma/widget-typings 使用 MIT License 许可。声明的许可为 MIT License，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @figma/widget-typings 的下载量有多少？

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

### @figma/widget-typings 还在维护吗？

最新版本 1\.13\.0 发布于 2026/08/07（3 个月前）；至今共发布 19 个版本，其中过去 12 个月发布了 1 个；首次发布于 2021/10/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。