@gitgraph/react

中文文档
1.6.0发布于 2021/03/07MITTypeScriptESM + CJS近 30 天下载 2.2万

Draw pretty git graphs in the browser, with React

原始使用文档

@gitgraph/react

version Changelog

Draw pretty git graphs with React.

This is the React rendering library of GitGraph.js.

Get started

You need to have npm installed.

Install the package with npm: npm i --save @gitgraph/react

Now you can use the <GitGraph> component:

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> will render the following graph:

Example of usage

More examples

A bunch of scenarios has been simulated in our Storybook. You can give them a look 👀

版本与发布记录

@gitgraph/react 共发布 22 个版本,首次发布于 2019/02/10;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.6.0latest2021/03/075 年前
1.5.42020/04/056 年前
1.5.32020/03/226 年前
1.5.22019/11/196 年前
1.5.12019/07/297 年前
1.5.02019/07/277 年前

关于 @gitgraph/react 的常见问题

@gitgraph/react 是什么?

Draw pretty git graphs in the browser, with 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 和提交记录判断。