# @cocalc/ansi-to-react 中文文档

规范地址：https://npmcn.com/package/%40cocalc/ansi-to-react/

版本：7\.0\.0
npm 元数据更新时间：2023-03-24T17:15:26.673Z
中文译文更新时间：2026-11-10T05:09:31.563Z
软件包许可：BSD-3-Clause

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

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

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

- 包体积（解压后）：9.6 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^16\.3\.2 \|\| ^17\.0\.0 \|\| ^18\.0\.0，react-dom ^16\.3\.2 \|\| ^17\.0\.0 \|\| ^18\.0\.0
- 首次发布：2022-11-01T17:49:07.685Z
- 最新版本发布：2023-03-24T17:15:26.427Z
- 近 30 天下载量：5216（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

ANSI 要反应元素

## 安装

```sh
npm install @cocalc/ansi-to-react
```

也可以使用：`pnpm add @cocalc/ansi-to-react`、`yarn add @cocalc/ansi-to-react`、`bun add @cocalc/ansi-to-react`

## README

# 异构反应

这个软件包将 ANSI 逃生代码转换为格式化的文本输出,用于 React.

## 安装

```
$ npm install ansi-to-react
```

## 使用量

### 基础

下面的例子显示了我们如何利用这个软件包来用ANSI逃生代码来制取一个字符串.

```javascript
import Ansi from "ansi-to-react";

export function () => {
  return <Ansi>
    {'\u001b[34mhello world'}
  </Ansi>;
};
```

将制作:

```javascript
<code>
  <span style="color:rgb(0, 0, 187)">hello world</span>
</code>
```

### 类

用类代替样式 `style` 属性.

```javascript
<Ansi useClasses>{"\u001b[34mhello world"}</Ansi>
```

将会使

```javascript
<code>
  <span class="ansi-blue-fg">hello world</span>
</code>
```

#### 类名称

| 字体颜色 | 背景颜色 |
| --- | --- |
| an-黑-fg | an-黑-bg |
| ansi-red-fg (英语) | ansi-red-bg (英语) |
| 反绿色fg | 反绿色bg |
| 安西黄色fg | 安西黄色bg |
| an-蓝-fg | si-蓝-bg |
| ansi-magenta-fg (英语) | ansi-magenta-bg (英语) |
| 亚西- 氰- fg | si-青-bg |
| ansi-white-fg (英语) | an-白-bg |
| (原始内容存档于2013-10-12). ansi-bright-black-fg |  |
| 短发-红发 |  |
| 反光-绿色- fg |  |
| 淡黄花 |  |
| 准蓝发 |  |
| 反右-右-右-右 |  |
| 反光- 青色- fg |  |
| 短发- 白发 |  |

## 发展

为了开发这个项目,叉子和克隆这个寄存器在您的本地机器上. 在进行修改之前,安装项目的依赖性.

```
$ npm install
```

要运行此项目的测试套件, 请运行 :

```
$ npm test
```

## 文档

我们正在努力为这个部分增加更多的文件. 注意看这个仓库!

## 支助

如果您在使用此软件包时遇到问题或有特性请求,请在 [问题板](https://github.com/nteract/ansi-to-react/issues), (中文(简体) ),

## 许可证

[BSD-3- 标签](https://choosealicense.com/licenses/bsd-3-clause/)

## 常见问题

### @cocalc/ansi-to-react 是什么？

ANSI 要反应元素

### 如何安装 @cocalc/ansi-to-react？

在项目目录运行 npm install @cocalc/ansi-to-react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.3\.2 \|\| ^17\.0\.0 \|\| ^18\.0\.0）、react-dom（^16\.3\.2 \|\| ^17\.0\.0 \|\| ^18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cocalc/ansi-to-react 支持 TypeScript 吗？

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

### @cocalc/ansi-to-react 支持 ESM 还是 CommonJS？

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

### @cocalc/ansi-to-react 可以商用吗？

@cocalc/ansi-to-react 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @cocalc/ansi-to-react 的下载量有多少？

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

### @cocalc/ansi-to-react 还在维护吗？

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