# @chatkitty/core 中文文档

规范地址：https://npmcn.com/package/%40chatkitty/core/

版本：2\.106\.2
npm 元数据更新时间：2025-10-10T22:21:43.795Z
中文译文更新时间：2026-11-09T11:36:02.869Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40chatkitty/core
原文对照：https://npmcn.com/package/%40chatkitty/core/?lang=original

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

- 包体积（解压后）：733 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.14
- 运行依赖：0 个
- peer 依赖：@stomp/rx-stomp ^2\.2\.0，axios ^1\.12\.2，lit-html ^3\.3\.1
- 首次发布：2022-07-28T14:06:27.249Z
- 最新版本发布：2025-10-10T22:21:43.591Z
- 近 30 天下载量：6872（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：54（近 12 个月 0 个）

## 中文简介

一个将聊天功能集成到您的网络应用程序的强大工具.

## 安装

```sh
npm install @chatkitty/core
```

也可以使用：`pnpm add @chatkitty/core`、`yarn add @chatkitty/core`、`bun add @chatkitty/core`

## README

# @ chatkitty/ core (中文(简体) )

## 安装

```bash
npm install @chatkitty/core
```

## 基本用途

看看这个 [HTML 示例](https://npmcn.com/package/examples/html-example) 是一个完整的范例.

```bash
npx chatkitty html-example:serve
```

### 正在装入聊天UI

```javascript
import { loadChatUi } from '@chatkitty/core';

await loadChatUi({
  widgetId: 'YOUR_WIDGET_ID',
  username: 'USER_USERNAME',
  container: {
    id: 'chat-ui',
    height: '100%',
  },
});

// Define the container in your HTML
// <div id="chat-ui"></div>
```

### 手动连接到 ChatKitty

要手动连接到 ChatKitty API,请使用您的 API 键和正在连接的用户名 。 如果您想要在程序上扩展功能, 或者需要访问 SDK 客户端, 这将会有所帮助 .

```javascript
import { connectApi } from '@chatkitty/core';

const apiKey = 'YOUR_CHATKITTY_API_KEY';
const username = 'USER_USERNAME';

const connection = await connectApi({
  apiKey: apiKey,
  username: username,
});

const { user, notifications, updateUser } = connection;

console.log('Connected as user:', user.value);

// Set event listeners if needed
user.watch((user) => console.log('User updated:', user));

// optional: get SDK client
const client = connection.getSdkClient();

// Load Chat UI using existing connection
await loadChatUi({
    widgetId: 'YOUR_WIDGET_ID',
    container: {
        id: 'chat-ui',
        height: '100%',
    }, { connection }
);

// Don't forget to disconnect when done
await connection.dispose();
```

### 自定义聊天体验

ChatKitty允许通过主题、本地化、音频通知和更多内容来广泛定制聊天UI和行为。 例如,要自定义主题并提供自定义用户配置:

```javascript
await loadChatUi({
  widgetId: 'YOUR_WIDGET_ID',
  theme: 'dark',
  profile: {
    displayName: 'John Doe',
    displayPicture: 'https://example.com/user-avatar.jpg',
  },
  // Other options...
});
```

看看这个 [ChatKitty 用户界面文档](https://chatkitty.com/docs/ui) 用于完整定制选项清单.

## 常见问题

### @chatkitty/core 是什么？

一个将聊天功能集成到您的网络应用程序的强大工具\.

### 如何安装 @chatkitty/core？

在项目目录运行 npm install @chatkitty/core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@stomp/rx-stomp（^2\.2\.0）、axios（^1\.12\.2）、lit-html（^3\.3\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @chatkitty/core 支持 TypeScript 吗？

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

### @chatkitty/core 支持 ESM 还是 CommonJS？

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

### @chatkitty/core 需要什么版本的 Node\.js？

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

### @chatkitty/core 可以商用吗？

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

### @chatkitty/core 的下载量有多少？

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

### @chatkitty/core 还在维护吗？

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