# @chatra/chatra 中文文档

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

版本：1\.0\.3
npm 元数据更新时间：2026-06-18T14:36:34.868Z
中文译文更新时间：2026-11-09T16:00:49.803Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：6.3 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2021-05-20T15:50:10.730Z
- 最新版本发布：2021-05-21T17:29:05.798Z
- 近 30 天下载量：2287（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

正式的Chatra模块

## 安装

```sh
npm install @chatra/chatra
```

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

## README

![Chatra logo](https://app.chatra.io/static/win-tile.png)

: 三角形 flag on 站点: **此软件包针对开发者.** 如果你想在你的网站上加入Chatra, 请检查我们 [安装指南](https://chatra.com/help/cms/?utm_source=npm&utm_medium=readme&utm_campaign=npm) 为大众电子商务平台和内容管理系统或 [添加一个小代码片段](https://chatra.com/help/?utm_source=npm&utm_medium=readme&utm_campaign=npm#install) 进入您的网站.

# 公务 [查特拉语Name](https://chatra.com/) 模块

此模块加载了 Chatra 部件, 并将方法调用到 [Javascript API (简体中文)](https://chatra.com/help/api/?utm_source=npm&utm_medium=readme&utm_campaign=npm#methods)。 。 。 .

关键特性 :

-   容易与您的网站或网络应用程序整合
-   与React、Angular、Vue和其他框架完美地工作
-   使用ES5实现最大相容性.

## 安装

要将聊天部件添加到您的网站或网络应用程序中, [与 Chatra 签约](https://app.chatra.io/?utm_source=npm&utm_medium=readme&utm_campaign=npm&enroll=)。 。 。 .

如果您已经有账户, 请使用您最喜欢的软件包管理器安装此软件包 :

```bash
$ npm install @chatra/chatra
```

```bash
$ yarn add @chatra/chatra
```

## 配置

**步骤1.** 转到 [首选项一节](https://app.chatra.io/settings/preferences?utm_source=npm&utm_medium=readme&utm_campaign=npm#apiKeys) 并复制 _公用钥匙_。 。 。 .

**步骤二.** 初始化索引.js或根控制器中的部件

_指数.js_

```js
let Chatra = require('chatra')

let config = {
    ID: 'Paste your Public key here'
}

Chatra('init', config)
```

:triangular flag on post:您可以通过路过来自定义聊天和按钮的外观,本地化,以及其他很多设置 `setup` 到初始化配置。 请检查一下 [Javascript API 文档](https://chatra.com/help/api/?utm_source=npm&utm_medium=readme&utm_campaign=npm#api-reference) 详细情况.

_指数.js_

```js
let config = {
    setup: {
        buttonSize: 75
    },
    ID: 'Paste your ChatraID here'
}
```

此外,你还可以 [通过任意访问者信息](https://chatra.com/help/api/#passing-arbitrary-info) 使用 `integration` 键 :

_指数.js_

```js
let config = {
    integration: {
        name: 'Cowardly Lion',
        email: 'cowardly_lion@gmail.com',

        /* any number of custom properties */
        'What does he do': 'Goes to Oz with his friends'
    },
    ID: 'Paste your ChatraID here'
}
```

**步骤3 _(可选)_。 。 。 .** 打电话 `PageView` 启用 [目标聊天和触发](https://app.chatra.io/settings/actions/?utm_source=npm&utm_medium=readme&utm_campaign=npm)。 。 。 .

如果您的网站或网络应用程序动态地加载页面,并更新文档的URL而不需要完整页面加载,则在页面更改以跟踪这些视图并在Chatra仪表板上看到时,请使用以下方法:

```js
Chatra('pageView')
```

我们建议在您的路由器或页面控制器中调用这种方法.

## 高级使用

### 更新设置

您可以通过调用更新初始化后的设置 `Chatra('init', config)` ,它将随着应用的新设置重新启动 Chatra .

### 方法

[方法](https://chatra.com/help/api/?utm_source=npm&utm_medium=readme&utm_campaign=npm#methods) 用于动态改变聊天部件的行为。 方法可以在部件初始化后的任何地方调用,例如:

```js
Chatra('expandWidget')
```

在Chatra装入完成前所做的所有方法调用被放入队列并等Chatra准备好后执行.

## 联系我们

如果你有任何问题 请随意 [联系我们](https://chatra.com/contact-us/)。 。 。 .

## 常见问题

### @chatra/chatra 是什么？

正式的Chatra模块

### 如何安装 @chatra/chatra？

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

### @chatra/chatra 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/chatra\_\_chatra 是否存在。

### @chatra/chatra 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @chatra/chatra 可以商用吗？

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

### @chatra/chatra 的下载量有多少？

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

### @chatra/chatra 还在维护吗？

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