# @gitgraph/core 中文文档

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

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

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

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

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

- 包体积（解压后）：441 kB，101 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2019-02-09T16:12:51.514Z
- 最新版本发布：2021-03-06T19:40:40.228Z
- 近 30 天下载量：29336（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 0 个）

## 中文简介

图形核心, 一个 JavaScript 库来绘制漂亮的图形

## 安装

```sh
npm install @gitgraph/core
```

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

## README

# `@gitgraph/core`

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

这是核心包 [GitGraph.js (英语)](https://github.com/nicoespeon/gitgraph.js/)。它包含用于操纵像 git 的 API 的主要逻辑,并计算应当渲染的图表.

如果你想使用GitGraph.js,你可能正在寻找一个渲染库. 他们全都被列入名单了 [单雷波根层](https://github.com/nicoespeon/gitgraph.js/)。 。 。 .

如果你是一个渲染库的贡献者,你会依赖于这个软件包. 在 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

## 为什么是这个包裹?

我们想通过不同的图书馆提供GitGraph.js,以适应不同的用法(如React,Angular,Vanilla JS,Node.js.

想法是提取共同的逻辑,而不用渲染部分.

所有GitGraph.js API在此定义:承诺,分支,合并等. 它包含git语义.

## 开发一个渲染库

一个渲染库是一个包装器周围 `@gitgraph/core`。 。 。 .

它应当:

-   向用户曝光 GitGraph.js API
-   订阅图表更新以重报

它如何使图表由您决定(例如画布,svg,HTML元素. ).

### 使用实例

香草联署材料的执行:

```js
import { GitgraphCore } from "@gitgraph/core";

export function createGitgraph(options) {
  const $target = options.$target || document.getElementId("#gitgraph");

  const graphOptions = {
    // Build relevant GitgraphCore options.
  };

  // Instantiate the graph.
  const gitgraph = new GitgraphCore(graphOptions);

  // Subscribe to graph updates.
  const gitgraph.subscribe((data) => {
    render($target, data);
  });

  // Return the GitGraph.js API to the user.
  return gitgraph.getUserApi();
}

function render($target, data) {
  // Do the rendering…
  $target.appendChild(renderGraph(data));
}
```

反应执行:

```jsx
import React from "react";
import { GitgraphCore } from "@gitgraph/core";

export class Gitgraph extends React.Component {
  constructor(props) {
    super(props);

    this.state = {
      // Init state.
    };

    // Instantiate the graph.
    this.gitgraph = new GitgraphCore(props.options);

    // Subscribe to graph updates.
    this.gitgraph.subscribe((data) => {
      this.setState(data);
    });
  }

  render() {
    // Do the rendering…
    return <svg>{this.renderGraph()}</svg>;
  }

  componentDidMount() {
    // Pass the GitGraph.js API to the user.
    this.props.children(this.gitgraph.getUserApi());
  }
}
```

## 怎么会这样?

最终用户将使用渲染库。 我们回来的时候 `gitgraph.getUserApi()`,用户将能够执行类似 git 的动作(创建分支,承诺,合并...).

每个动作都会更新内部图. 核心库计算出应该被渲染出代表新状态的新图表. 当它出现时,它会通过 `subscribe()` 方法.

## 常见问题

### @gitgraph/core 是什么？

图形核心, 一个 JavaScript 库来绘制漂亮的图形

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

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

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

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

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

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

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

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

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

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

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

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

