# @characterxyz/react 中文文档

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

版本：0\.10\.1
npm 元数据更新时间：2026-11-06T11:21:48.669Z
中文译文更新时间：2026-11-09T11:06:15.298Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40characterxyz/react
原文对照：https://npmcn.com/package/%40characterxyz/react/?lang=original
项目主页：https://character.xyz/
源码仓库：https://github.com/characterxyz/characterxyz-sdk

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

- 包体积（解压后）：17.1 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react \>=17
- 首次发布：2026-10-12T05:25:19.166Z
- 最新版本发布：2026-11-06T11:21:48.285Z
- 近 30 天下载量：2825（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

React 的字符 XYZ:部件作为组件,并用钩子在无头的SDK上.

## 安装

```sh
npm install @characterxyz/react
```

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

## README

# @ characterxyz/ 反应

在 React 和 Next.js 中的您字符 XYZ 代理: 作为组件的现成部件, 以及用于 建立自己的UI。 包括 [`@characterxyz/widget`](https://www.npmjs.com/package/@characterxyz/widget) 财务报告和审定财务报表 [`@characterxyz/web`](https://www.npmjs.com/package/@characterxyz/web); 只安装此选项.

```bash
npm install @characterxyz/react
```

## 部件

```tsx
import { CharacterXYZWidget } from '@characterxyz/react';

export function Support() {
  return <CharacterXYZWidget publishableKey="cxyz_pk_live_…" accent="#e11d48" onReady={({ agent }) => console.log(agent.name)} />;
}
```

它需要每个部件设置为道具(`agentId`, (中文(简体) ), `display`, (中文(简体) ), `position`, (中文(简体) ), `mode`, (中文(简体) ), `showCall`(中文(简体) ). 工程 在 Next.js App 路由器中如出一辙: 软件包被标记 `'use client'`。 。 。 .

## 你自己的UI系统

```tsx
import { useCharacterXYZ } from '@characterxyz/react';

const { messages, busy, send, startCall, call, error } = useCharacterXYZ({ publishableKey: 'cxyz_pk_live_…' });
```

`messages` 流出作为回复; `startCall()` 必须在单击时运行(它要求 麦克风)和 `call` 带有相位、队列位置和估计值.

## 已注册访问者

将服务器上的会话擦除 [`@characterxyz/server`](https://www.npmjs.com/package/@characterxyz/server) 通过 `getSessionToken={() => fetch('/api/characterxyz/session').then((r) => r.json())}` 而不是钥匙.

创建密钥并选择它们可能在其中运行的网站 **字符 XYZ QQ 设置 QQ 开发者**。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @characterxyz/react 是什么？

React 的字符 XYZ:部件作为组件,并用钩子在无头的SDK上\.

### 如何安装 @characterxyz/react？

在项目目录运行 npm install @characterxyz/react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=17）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @characterxyz/react 支持 TypeScript 吗？

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

### @characterxyz/react 支持 ESM 还是 CommonJS？

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

### @characterxyz/react 可以商用吗？

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

### @characterxyz/react 的下载量有多少？

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

### @characterxyz/react 还在维护吗？

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