# @vdatacloud/cms-components 中文文档

规范地址：https://npmcn.com/package/%40vdatacloud/cms-components/

版本：0\.14\.2
npm 元数据更新时间：2026-11-02T19:41:44.597Z
中文译文更新时间：2026-11-02T19:46:50.850Z
软件包许可：UNLICENSED

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

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

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

- 包体积（解压后）：49.9 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@vdatacloud/cx-commons \>=0\.3\.0 \<1\.0\.0
- 首次发布：2026-10-13T17:05:36.075Z
- 最新版本发布：2026-11-02T19:41:44.439Z
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

用于起草和共享托管协议的可嵌入web组件(dam -escrow-cms， PLAN。md 81.4 T10)：轻dom自定义元素样式的@vdatacloud/cx-commons令牌，在页面的语言（en/fr），只与CMS API （/ API /v1/ CMS）。

## 安装

```sh
npm install @vdatacloud/cms-components
```

也可以使用：`pnpm add @vdatacloud/cms-components`、`yarn add @vdatacloud/cms-components`、`bun add @vdatacloud/cms-components`

## README

# @vdatacloud / cms-components

用于起草和共享托管协议的可嵌入web组件 [daml-escrow-cms](https://github.com/vdatacloud/daml-escrow-cms) (计划。md 81.4, T10)。

-   **Light-DOM定制元素**： `<cms-workspace-list>`， `<cms-workspace workspace-id>`， `<cms-agreement-editor workspace-id>`， `<cms-shared-agreements>`。主持人的顺风 `@vdatacloud/cx-commons` 令牌，暗模式和字体应用不变。
-   **只有CMS API** （`/api/v1/cms/...`)，直接或通过主机的代理，它传递 用户自己的令牌。他们从来不跟账本说话。
-   **英语和法语**，跟随页面 `<html lang>` 通过cx-commons。

```ts
import { configure, defineCmsElements } from '@vdatacloud/cms-components';

configure({
  base: 'https://api.example.com',                         // where /api/v1/cms is served
  headers: () => ({ Authorization: `Bearer ${token()}` }), // the user's own token; no Content-Type
});
defineCmsElements();
```

这些元素发出 `cms-open-workspace` （`{ id }`)，当用户打开工作空间时；主持人决定 在哪里展示 `<cms-workspace>`.

**顺风v4主机** 必须扫描包，以便生成元素使用的类：

```css
@source "../node_modules/@vdatacloud/cms-components/src";
```

`@vdatacloud/cx-commons` 是对等依赖：组件将它们的消息注册到宿主的 I18n注册表，并呈现其错误通知和对话框。

该包附带TypeScript源代码（如cx-commons）；主机的捆绑器（Vite/Astro）编译它们。 它的版本由dam -托管-cms发布。

## 常见问题

### @vdatacloud/cms-components 是什么？

用于起草和共享托管协议的可嵌入web组件\(dam -escrow-cms， PLAN。md 81\.4 T10\)：轻dom自定义元素样式的@vdatacloud/cx-commons令牌，在页面的语言（en/fr），只与CMS API （/ API /v1/ CMS）。

### 如何安装 @vdatacloud/cms-components？

在项目目录运行 npm install @vdatacloud/cms-components，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@vdatacloud/cx-commons（\>=0\.3\.0 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @vdatacloud/cms-components 支持 TypeScript 吗？

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

### @vdatacloud/cms-components 支持 ESM 还是 CommonJS？

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

### @vdatacloud/cms-components 可以商用吗？

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

### @vdatacloud/cms-components 还在维护吗？

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