# @forumone/throughline-design-system 中文文档

规范地址：https://npmcn.com/package/%40forumone/throughline-design-system/

版本：2\.7\.1
npm 元数据更新时间：2026-11-11T03:45:28.355Z
中文译文更新时间：2026-11-15T10:37:19.288Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40forumone/throughline-design-system
原文对照：https://npmcn.com/package/%40forumone/throughline-design-system/?lang=original
项目主页：https://github.com/forumone/throughline/tree/main/packages/design-system#readme
源码仓库：https://github.com/forumone/throughline

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

- 包体积（解压后）：425 kB，150 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，vitest ^3\.0\.0 \|\| ^4\.0\.0，payload ^3\.89\.0，typescript ^5\.0\.0，@payloadcms/ui ^3\.0\.0
- 首次发布：2026-10-03T02:13:41.794Z
- 最新版本发布：2026-11-11T03:45:27.872Z
- 近 30 天下载量：2308（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：104（近 12 个月 104 个）

## 中文简介

Liveline的设计-系统侧:组件合同并显示一个出版的设计系统、其linter,以及由此产生的有效载荷块、渲染和处理组件.

## 安装

```sh
npm install @forumone/throughline-design-system
```

也可以使用：`pnpm add @forumone/throughline-design-system`、`yarn add @forumone/throughline-design-system`、`bun add @forumone/throughline-design-system`

## README

# @ forumone/ throughline-design- system (英语)

特通线的设计-系统侧. 一个设计系统用一个显示器来描述它的组件;这个包定义了显示器,涂上它,并将其变成一个通线站点的活负荷块,渲染和管理员组件.

> **来自0.x?** 这个软件包是 `@forumone/throughline-design-contract` 财务报告和审定财务报表 `@forumone/throughline-design-system-payload` 一起; [从 0.x 升级](https://github.com/forumone/throughline/blob/main/docs/guides/upgrading.md) 将 0.x 站点移动到它上.

| 子路径 | 持有 |
| --- | --- |
| `/contract` | `ComponentContractSchema`, (中文(简体) ), `ManifestSchema`, (中文(简体) ), `loadManifest`:合同中每一部分都申报,并列出其清单;见 [文件/合同.md](https://github.com/forumone/throughline/blob/main/docs/reference/design-system/contract.md) |
| `/lint` | `lintManifest`, (中文(简体) ), `formatLintIssues`, (中文(简体) ), `assertManifestClean` |
| `/generate` | `generateBlocks` 和朋友,显示在有效载荷块 `fieldOverride` (b) 网站的例外情况 [文件/载荷](https://github.com/forumone/throughline/blob/main/docs/reference/design-system/generate.md) |
| `/render` | `RenderBlocks` 财务报告和审定财务报表 `coerceBlock`: 存储块返回React |
| `/client` | `BlockSummary`, (中文(简体) ), `BlockGuidance`, (中文(简体) ), `RowSummary`: 在有效载荷导入图中命名的管理员组件 |
| `/testing` | `describeBlockInvariants`, (中文(简体) ), `checkUntouchedBlocks`, (中文(简体) ), `checkBlockProps`: 变化无常的,一个场地在它的地块上运行 |
| 选项 | `check-block-props <manifest.json> <components-dir>…`:每份合同是否都生产其部件所需的道具? |

```bash
pnpm add @forumone/throughline-design-system
```

`/contract` 财务报告和审定财务报表 `/lint` 没有同伴,所以设计系统 仅仅发布一个表 不需要别的。 其他人都期待着 `payload` 财务报告和审定财务报表 `react`, (中文(简体) ), `/client` 预期 `@payloadcms/ui`, (中文(简体) ), `/generate` 将组件源读取为 `typescript`,以及 `/testing` 是一个维特套房.

**参考: [`docs/reference/design-system.md`](https://github.com/forumone/throughline/blob/main/docs/reference/design-system.md)。 。 。 .**

## 常见问题

### @forumone/throughline-design-system 是什么？

Liveline的设计-系统侧:组件合同并显示一个出版的设计系统、其linter,以及由此产生的有效载荷块、渲染和处理组件\.

### 如何安装 @forumone/throughline-design-system？

在项目目录运行 npm install @forumone/throughline-design-system，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 check-block-props，可以用 npx check-block-props 直接运行。

### @forumone/throughline-design-system 支持 TypeScript 吗？

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

### @forumone/throughline-design-system 支持 ESM 还是 CommonJS？

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

### @forumone/throughline-design-system 可以商用吗？

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

### @forumone/throughline-design-system 的下载量有多少？

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

### @forumone/throughline-design-system 还在维护吗？

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