Skip to content

sallar/github-contributions-canvas

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

Github Contributions on Canvas NPM version Build Status Dependency Status

A tool for drawing a heat-map of Github contributions on HTML Canvas.

This module is used for drawing user contributions in this project.

Install

$ npm install github-contributions-canvas

Usage

import { drawContributions } from "github-contributions-canvas";

drawContributions(canvasEl, {
  data: contributionData,
  username: "myusername",
  themeName: "standard",
  footerText: "Made by @sallar - github-contributions.now.sh"
});

Available Themes

The themes are defined in the src/themes.js file. Currently the available themes are:

  • standard
  • halloween
  • teal
  • leftPad
  • dracula
  • blue
  • panda
  • sunny
  • pink
  • YlGnBu
  • solarizedDark
  • solarizedLight

Data Format

This module accepts the output from sallar/github-contributions-api API. Check that project for more info.

License

Sallar Kaboli © MIT License

About

A tool for drawing a heat-map of Github contributions on HTML Canvas

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published