# @sme\.up/ketchup2 中文文档

规范地址：https://npmcn.com/package/%40sme.up/ketchup2/

版本：3\.0\.0-SNAPSHOT-20261102110247
npm 元数据更新时间：2026-11-02T11:29:10.569Z
中文译文更新时间：2026-11-02T12:24:07.952Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40sme.up/ketchup2
原文对照：https://npmcn.com/package/%40sme.up/ketchup2/?lang=original
项目主页：https://smeup.github.io/ketchup2/
源码仓库：https://github.com/smeup/ketchup2

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

- 包体积（解压后）：13.4 MB，923 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：22
- 运行依赖：9 个
- peer 依赖：react ^19\.2\.8，i18next ^26\.3\.6，react-dom ^19\.2\.8
- 首次发布：2025-03-25T11:38:00.490Z
- 最新版本发布：2026-11-02T11:29:10.359Z
- 已发布版本数：893（近 12 个月 506 个）

## 中文简介

中小企业。UP web组件库

## 安装

```sh
npm install @sme.up/ketchup2
```

也可以使用：`pnpm add @sme.up/ketchup2`、`yarn add @sme.up/ketchup2`、`bun add @sme.up/ketchup2`

## README

# 新一代番茄酱

番茄酱是一种 **TypeScript-first React组件库** 专门为Smeup业务应用程序设计的。它提供了:

-   **预构建UI组件** 按领域组织（基本组件、功能组件和复杂组件）
-   **数据驱动架构** 与Smeup数据结构无缝协作
-   **设计系统集成** 使用一致的颜色、间距和排版标记
-   **全面的文档** 通过故事书和MDX指南
-   **完整的测试覆盖** 使用单元和视觉回归测试

**重点:** 使用特定于smeup的数据模式和可访问性构建企业级业务ui。

## 开始

看到 [先决条件](https://npmcn.com/package/%40sme.up/ketchup2/docs/PREREQUISITES.md) 和 [初始文档页面](https://npmcn.com/package/%40sme.up/ketchup2/docs/INIT.md) 开始图书馆的工作。

## 开发

看到 [项目结构](https://npmcn.com/package/%40sme.up/ketchup2/docs/PROJECT-STRUCTURE.md) 了解项目的结构。 看到 [格式指南](https://npmcn.com/package/%40sme.up/ketchup2/docs/STYLEGUIDE.md) 学习我们的惯例。 看到 [第一个例子](https://npmcn.com/package/%40sme.up/ketchup2/docs/FIRST-EXAMPLE.md) 以获得创建第一个组件的信心

## 验证

看到 [开发过程](https://npmcn.com/package/%40sme.up/ketchup2/docs/DEVPROCESS.md)

## 视觉回归测试

-   Canonical VRT环境为Docker （Linux +剧作家镜像）。
-   使用与CI中相同的设置运行本地VRT：
    -   `docker compose run --rm vrt`
    -   `npm run test:vrt`
-   本地更新快照：
    -   `npm run test:vrt:update`
-   当PR有标签时，CI也可以重新生成快照 `update snapshots` （或通过手动调度输入）。

## 形状和组件

如果你想知道当前支持哪些形状/组件，你可以在这里查看： [形状状态](https://npmcn.com/package/%40sme.up/ketchup2/docs/SHAPES.md)  
[组件状态](https://npmcn.com/package/%40sme.up/ketchup2/docs/COMPONENTS.md)

## 允许的组件数据格式

该组件库被设计为严格使用一组预定义的数据格式。这确保了库内部及其所有消费者的一致性、可靠性和完全互操作性。 [数据格式](https://npmcn.com/package/%40sme.up/ketchup2/docs/DATAFORMATS.md)

## 常见问题

### @sme\.up/ketchup2 是什么？

中小企业。UP web组件库

### 如何安装 @sme\.up/ketchup2？

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

### @sme\.up/ketchup2 支持 TypeScript 吗？

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

### @sme\.up/ketchup2 支持 ESM 还是 CommonJS？

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

### @sme\.up/ketchup2 需要什么版本的 Node\.js？

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

### @sme\.up/ketchup2 可以商用吗？

@sme\.up/ketchup2 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @sme\.up/ketchup2 还在维护吗？

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