@gitgraph/js
Advanced tools
@gitgraph/jsDraw pretty git graphs with vanilla JS.
This is the vanilla JS rendering library of GitGraph.js.
gitgraph.js packageHere's a guide to help you migrate to @gitgraph/js.
You need to have npm installed.
Install the package with npm: npm i --save @gitgraph/js
Now you can use createGitgraph to render your graph in a DOM element:
<!DOCTYPE html>
<html>
<head>
<!-- … -->
</head>
<body>
<!-- DOM element in which we'll mount our graph -->
<div id="#graph-container"></div>
</body>
</html>
const { createGitgraph } = require("@gitgraph/js");
// Get the graph container HTML element.
const graphContainer = document.getElementById("graph-container");
// Instantiate the graph.
const gitgraph = createGitgraph(graphContainer);
// Simulate git commands with Gitgraph API.
const master = gitgraph.branch("master");
master.commit("Initial commit");
const develop = gitgraph.branch("develop");
develop.commit("Add TypeScript");
const aFeature = gitgraph.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");
This code will render the following graph:
A bunch of scenarios has been simulated in our Storybook. You can give them a look 👀
FAQs
Draw pretty git graphs in the browser
The npm package @gitgraph/js receives a total of 176 weekly downloads. As such, @gitgraph/js popularity was classified as not popular.
We found that @gitgraph/js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.