github-contributions-react

Github Contributions React

This is a react component, used for displaying a Github users contribution count with a number of customizations available.

📺 Demo

Here you can see this in action in a little demo project I've built

https://github-contributions-demo.vercel.app

📸 Screenshot

🛠 Installation

inside a React project

npm i github-contributions-react

⚡️ Import

within a React component/page

import { GithubContributions } from "github-contributions-react";

✨ Usage

within a React component/page
see all available props below

<GithubContributions username="alanmontgomery" color="#3069ba" />

⚛️ Props

These are props you can pass to the component to customize

• username - The github username whose stats you want to show.
• color - A hex color, used to style the graph, all light/dark colors are worked out automatically. defaults to #3069ba
• showTitle - Show a title with a link to the username defaults to true
• showTooltips - Shows tooltips with day counts when hovering over a square defaults to true
• showTotal - Shows a count of the total contributions in the last year above the graph defaults to true
• showToday - Shows a count of todays contributions above the graph defaults to false

🙋‍♂️ Questions

Feel free to contact me via Twitter @93alan.