# @gitgraph/react 中文文档

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

版本：1\.6\.0
npm 元数据更新时间：2022-04-05T14:21:58.503Z
中文译文更新时间：2026-11-16T10:42:05.811Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：600 kB，56 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>= 16\.8\.0
- 首次发布：2019-02-09T16:13:28.822Z
- 最新版本发布：2021-03-06T19:40:45.524Z
- 近 30 天下载量：21662（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 0 个）

## 中文简介

在浏览器中绘制漂亮的 Git 图形, 带有 React

## 安装

```sh
npm install @gitgraph/react
```

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

## README

# `@gitgraph/react`

[![version](https://img.shields.io/npm/v/@gitgraph/react.svg?logo=npm)](https://www.npmjs.com/package/@gitgraph/react) [![Changelog](https://img.shields.io/badge/%F0%9F%93%94-changelog-CD9523.svg)](https://github.com/nicoespeon/gitgraph.js/blob/master/packages/gitgraph-react/CHANGELOG.md)

与 React 一起绘制漂亮的图 .

> 这是反应渲染库 [GitGraph.js (英语)](https://github.com/nicoespeon/gitgraph.js/)。 。 。 .

## 开始吧

> 你必须要有 [无](https://www.npmjs.com/get-npm) 已安装.

用 npm 安装软件包 : `npm i --save @gitgraph/react`

现在你可以使用 `<GitGraph>` 组件 :

```jsx
const { Gitgraph } = require("@gitgraph/react");

function MyComponent() {
  return (
    <Gitgraph>
      {(gitgraph) => {
        // Simulate git commands with Gitgraph API.
        const master = gitgraph.branch("master");
        master.commit("Initial commit");

        const develop = master.branch("develop");
        develop.commit("Add TypeScript");

        const aFeature = develop.branch("a-feature");
        aFeature
          .commit("Make it work")
          .commit("Make it right")
          .commit("Make it fast");

        develop.merge(aFeature);
        develop.commit("Prepare v1");

        master.merge(develop).tag("v1.0.0");
      }}
    </Gitgraph>
  );
}
```

`<MyComponent>` 将制作下图:

![Example of usage](https://github.com/nicoespeon/gitgraph.js/blob/master/packages/gitgraph-react/assets/example-usage.png?raw=true)

## 更多实例

[一堆场景](https://github.com/nicoespeon/gitgraph.js/tree/master/packages/stories/src/gitgraph-react/) 我们的故事书里已经模拟过了 你可以给他们看看

## 常见问题

### @gitgraph/react 是什么？

在浏览器中绘制漂亮的 Git 图形, 带有 React

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

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

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

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

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

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

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

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

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

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

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

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

