@cometchat/cards

中文文档
1.0.0发布于 2026/05/27https://www.cometchat.com/legal-terms-of-serviceTypeScriptESM + CJS零依赖近 30 天下载 1.2万

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

中文使用文档
文档目录7 节
  1. 它会做什么
  2. 安装
  3. 使用量
  4. 反应收发器
  5. 开始
  6. 先决条件
  7. 帮助和支持

彗星聊天卡渲染器

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

它会做什么

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

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

安装

npm install @cometchat/cards

使用量

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 提供 CometChatCardView 包件组件.

开始

参见 一体化步骤 将卡片整合到您的应用程序中.

先决条件

  • 节点.js
  • npm 第7页

帮助和支持

关于一体化问题,建立一个 支持票 或通过 彗星聊天板。 。 。 .

版本与发布记录

@cometchat/cards 共发布 1 个版本,首次发布于 2026/05/27;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.0.0latest2026/05/275 个月前

关于 @cometchat/cards 的常见问题

@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 和提交记录判断。