# @farm-junction/design-library 中文文档

规范地址：https://npmcn.com/package/%40farm-junction/design-library/

版本：1\.0\.8
npm 元数据更新时间：2026-11-05T10:35:08.387Z
中文译文更新时间：2026-11-14T10:28:21.597Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/%40farm-junction/design-library
原文对照：https://npmcn.com/package/%40farm-junction/design-library/?lang=original

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

- 包体积（解压后）：721 kB，687 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^19\.0\.0，postcss \>=8，react-dom ^19\.0\.0
- 首次发布：2026-06-05T09:49:39.605Z
- 最新版本发布：2026-11-05T10:35:08.207Z
- 近 30 天下载量：2700（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：100（近 12 个月 100 个）

## 中文简介

农场枢纽 反应设计系统——代号、组件和Tailwind 4预设

## 安装

```sh
npm install @farm-junction/design-library
```

也可以使用：`pnpm add @farm-junction/design-library`、`yarn add @farm-junction/design-library`、`bun add @farm-junction/design-library`

## README

# @farm-junction/设计-图书馆

农场枢纽 反应设计系统——设计代号,组件,"故事书"docs,以及用于消费应用的Tailwind 4预设.

## 堆栈

-   反应 19 + 类型脚本 5
-   尾风 CSS 4 (`@theme` 符号)
-   故事本 第8册 (Vite)
-   虚拟库构建(ESM+类型+CSS)

## 脚本

| 命令 | 说明 |
| --- | --- |
| `npm run dev` | 在端口启动故事书 6006 |
| `npm run build` | 类型检查和构建 `dist/` |
| `npm run build-storybook` | 静态故事书构建 |
| `npm run lint` | ESLint 语录 |

## 发展

```bash
npm install
npm run dev
```

打开 [http://localhost:6006 (英语)](http://localhost:6006/) 浏览组件和符号表.

## 软件包出口

| 导入路径 | 说明 |
| --- | --- |
| `@farm-junction/design-library` | 反应组件, `cn`, (中文(简体) ), `tokens` |
| `@farm-junction/design-library/styles.css` | 编译组件样式 |
| `@farm-junction/design-library/tailwind-preset` | Tailwind 4主题+应用集成基础 |

## Next.js 应用程序中的使用

### 1\. 安装

或公布到您的注册簿上,并按常规安装.

```bash
npm install @farm-junction/design-library
```

\` , \`

### 2\. 在您的应用 CSS 中扩展尾风 4

单位 `app/globals.css` (或您的主要CSS条目):

```css
@import 'tailwindcss';
@source "../node_modules/@farm-junction/design-library/dist";
@import '@farm-junction/design-library/theme.css';
```

调整 `@source` 路径,如果您的应用程序生活在单列或使用不同的 `node_modules` 设置.

### 3\. 使用组件

```tsx
import { Button } from '@farm-junction/design-library';

export default function Page() {
    return <Button variant="primary">Get started</Button>;
}
```

## 项目结构

```
src/
├── tokens/          # @theme CSS + TS token mirror
├── styles/          # Tailwind entry (dev + build)
├── components/      # React components + stories
├── lib/utils.ts     # cn() helper
├── tailwind-preset.css
└── index.ts         # Public API
```

## 添加组件

1.  创建 `src/components/MyComponent/MyComponent.tsx`
2.  添加 `MyComponent.stories.tsx` 故事书
3.  导出自 `src/components/index.ts` 财务报告和审定财务报表 `src/index.ts`
4.  使用引用的 Tailwind 工具 `@theme` 标志(例如:. `bg-primary`(中文(简体) )

## 常见问题

### @farm-junction/design-library 是什么？

农场枢纽 反应设计系统——代号、组件和Tailwind 4预设

### 如何安装 @farm-junction/design-library？

在项目目录运行 npm install @farm-junction/design-library，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.0\.0）、react-dom（^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @farm-junction/design-library 支持 TypeScript 吗？

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

### @farm-junction/design-library 支持 ESM 还是 CommonJS？

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

### @farm-junction/design-library 可以商用吗？

@farm-junction/design-library 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @farm-junction/design-library 的下载量有多少？

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

### @farm-junction/design-library 还在维护吗？

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