# @cosmicdrift/kumiko-document-designer 中文文档

规范地址：https://npmcn.com/package/%40cosmicdrift/kumiko-document-designer/

版本：0\.419\.0
npm 元数据更新时间：2026-11-10T16:28:50.246Z
中文译文更新时间：2026-11-10T20:13:03.768Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cosmicdrift/kumiko-document-designer
原文对照：https://npmcn.com/package/%40cosmicdrift/kumiko-document-designer/?lang=original
项目主页：https://kumiko.rocks/
源码仓库：https://github.com/CosmicDriftGameStudio/kumiko-framework

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

- 包体积（解压后）：483 kB，194 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-10-16T19:03:46.630Z
- 最新版本发布：2026-11-10T16:28:49.440Z
- 近 30 天下载量：13308（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：63（近 12 个月 63 个）

## 中文简介

库米科的文档设计师:模板概览,布局编辑器(邮件布局,PDF信头)和PDF模板编辑器.

## 安装

```sh
npm install @cosmicdrift/kumiko-document-designer
```

也可以使用：`pnpm add @cosmicdrift/kumiko-document-designer`、`yarn add @cosmicdrift/kumiko-document-designer`、`bun add @cosmicdrift/kumiko-document-designer`

## README

# @cosmicdrift/kumiko-文档设计师

Kumiko的文档设计师:模板概览,邮件布局和PDF信头的版式编辑器,PDF模板编辑器.

```ts
import { createTemplateResolverFeature } from "@cosmicdrift/kumiko-bundled-features/template-resolver";
import { createDocumentDesignerFeature } from "@cosmicdrift/kumiko-document-designer";
import { documentDesignerClient } from "@cosmicdrift/kumiko-document-designer/web";

// server feature list
createTemplateResolverFeature();
createDocumentDesignerFeature();

createKumikoApp({
  clientFeatures: [documentDesignerClient({ appLocales: ["de", "en"] })],
});
```

## 概览和布局编辑器

挂载 `createDocumentDesignerFeature()` 之后 `template-resolver` (和 `managed-pages` 如果品牌铁路应当与品牌屏幕连接).

-   屏幕 : `templates` (TenantAdmin, SystemAdmin), (中文(简体) ), `platform-templates` (系统阿德明,增加"定制"一栏), `layout-editor` (从布局的"编辑"行动作打开), `mail-editor` (从邮件模板的"编辑"行动作打开;主题,内容,资源,预览和测试邮件).
-   导航 : `document-designer:nav:templates` 财务报告和审定财务报表 `document-designer:nav:platform-templates`。 。 。 . `createAdminShellFeature({ includeDocumentDesigner: true })` 在管理工作空间中列出它们.
-   `TEMPLATE_EDITOR_SCREENS` 将模板类型映射到编辑它的屏幕上; 添加一个类型并添加“ 编辑” 行动作.
-   `PreviewRecordPickerProvider` (web导出)在邮件预览中添加了"选择记录"动作;没有它,动作就被隐藏. 仅显示取出值, 预览端点不需要覆盖 .
-   布局编辑器的MJML标签只显示给SystemAdmin,并且只有在系统布局为MJML时才会显示.

## PDF 模板编辑器

该功能宣布 `pdf-template-editor` 屏幕 (`PDF_TEMPLATE_EDITOR_SCREEN_ID`和 `documentDesignerClient()` 注册其组件; PDF 行的“编辑”行动作打开。 屏幕从 URL 读取模板 : `?slug=invoice&locale=de`。 。 。 . `PdfTemplateEditor` (道具数) `slug`, (中文(简体) ), `locale`, (中文(简体) ), `onLocaleChange`也可以直接挂载.

所需经费: `template-resolver` 财务报告和审定财务报表 `renderer-puppeteer-client` 服务器上的特性. A 系统admin( 通过 `UserRolesProvider`)编辑系统模板,其他人都采用租户自定义. PDF 预览使用 `pdfjs-dist` 主线条中(没有工人或CDN请求).

## 常见问题

### @cosmicdrift/kumiko-document-designer 是什么？

库米科的文档设计师:模板概览,布局编辑器\(邮件布局,PDF信头\)和PDF模板编辑器\.

### 如何安装 @cosmicdrift/kumiko-document-designer？

在项目目录运行 npm install @cosmicdrift/kumiko-document-designer，或使用 pnpm add / yarn add / bun add。

### @cosmicdrift/kumiko-document-designer 支持 TypeScript 吗？

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

### @cosmicdrift/kumiko-document-designer 支持 ESM 还是 CommonJS？

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

### @cosmicdrift/kumiko-document-designer 可以商用吗？

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

### @cosmicdrift/kumiko-document-designer 的下载量有多少？

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

### @cosmicdrift/kumiko-document-designer 还在维护吗？

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