@gitgraph/core
这是核心包 GitGraph.js (英语)。它包含用于操纵像 git 的 API 的主要逻辑,并计算应当渲染的图表.
如果你想使用GitGraph.js,你可能正在寻找一个渲染库. 他们全都被列入名单了 单雷波根层。 。 。 .
如果你是一个渲染库的贡献者,你会依赖于这个软件包. 在 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
为什么是这个包裹?
我们想通过不同的图书馆提供GitGraph.js,以适应不同的用法(如React,Angular,Vanilla JS,Node.js.
想法是提取共同的逻辑,而不用渲染部分.
所有GitGraph.js API在此定义:承诺,分支,合并等. 它包含git语义.
开发一个渲染库
一个渲染库是一个包装器周围 @gitgraph/core。 。 。 .
它应当:
- 向用户曝光 GitGraph.js API
- 订阅图表更新以重报
它如何使图表由您决定(例如画布,svg,HTML元素. ).
使用实例
香草联署材料的执行:
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));
}
反应执行:
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() 方法.