# @cometchat/cards 中文文档

规范地址：https://npmcn.com/package/%40cometchat/cards/

版本：1\.0\.0
npm 元数据更新时间：2026-10-09T14:01:09.040Z
中文译文更新时间：2026-11-10T11:44:02.670Z
软件包许可：https://www\.cometchat\.com/legal-terms-of-service

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

原始 npm 页面：https://www.npmjs.com/package/%40cometchat/cards
原文对照：https://npmcn.com/package/%40cometchat/cards/?lang=original
项目主页：https://www.cometchat.com/

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

- 包体积（解压后）：94 kB，79 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-05-27T09:41:10.860Z
- 最新版本发布：2026-05-27T09:41:11.178Z
- 近 30 天下载量：11684（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

彗星Chat Card Schema JSON 渲染器-香草类型Script核心

## 安装

```sh
npm install @cometchat/cards
```

也可以使用：`pnpm add @cometchat/cards`、`yarn add @cometchat/cards`、`bun add @cometchat/cards`

## README

# 彗星聊天卡渲染器

用于彗星Chat Card Schema的香草TypeScript渲染器. 传出JSON卡,拿回一棵本地DOM元素树. 交互式元素的磁带通过一个回调程序向您的应用程序发射——软件包从不执行动作本身.

## 它会做什么

-   将卡片 Schema JSON 切入打入型号
-   渲染20个元素类型(文本、图像、图标、相机、徽章、分隔器、空间器、芯片、进步栏、代码Block、标记下、行、列、网格、手风琴、分页、按钮、图标按钮、链接、表格)
-   决定认识到主题颜色和图像 URL `auto`, (中文(简体) ), `light`,以及 `dark` 模式,可选主题覆盖
-   点击按钮、图标按钮, 并按键链接回调 `CometChatCardActionEvent`编号

包裹是一个纯粹的渲染器. 它不与"彗星Chat SDK"对话,不管理信息生命周期,也不知道你的应用的路由. 每个动作都由你决定.

## 安装

```bash
npm install @cometchat/cards
```

## 使用量

```ts
import { renderCard } from "@cometchat/cards";

const { element, containerStyle, destroy } = renderCard({
  cardJson,
  themeMode: "auto",
  onAction: (event) => {
    console.log("action:", event.action.type, "from", event.elementId);
  },
});

document.getElementById("card-root")!.appendChild(element);

// Later, when unmounting:
destroy();
```

这个 `destroy` 函数清理所使用的系统主题媒体查询倾听器 `auto` 模式.

## 反应收发器

对于反应项目, 使用 [`@cometchat/cards-react`](https://www.npmjs.com/package/@cometchat/cards-react) 提供 `CometChatCardView` 包件组件.

## 开始

参见 [一体化步骤](https://www.cometchat.com/docs/sdk/javascript/campaigns) 将卡片整合到您的应用程序中.

## 先决条件

-   节点.js
-   npm 第7页

## 帮助和支持

关于一体化问题,建立一个 [支持票](https://help.cometchat.com/hc/en-us) 或通过 [彗星聊天板](http://app.cometchat.com/)。 。 。 .

## 常见问题

### @cometchat/cards 是什么？

彗星Chat Card Schema JSON 渲染器-香草类型Script核心

### 如何安装 @cometchat/cards？

在项目目录运行 npm install @cometchat/cards，或使用 pnpm add / yarn add / bun add。

### @cometchat/cards 支持 TypeScript 吗？

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

### @cometchat/cards 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cometchat/cards 可以商用吗？

@cometchat/cards 使用 https://www\.cometchat\.com/legal-terms-of-service 许可。声明的许可为 https://www\.cometchat\.com/legal-terms-of-service，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @cometchat/cards 的下载量有多少？

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

### @cometchat/cards 还在维护吗？

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