Docs/Github Calendar

Github Calendar

A premium, customizable visualization of GitHub contribution graphs with multiple color schemes and display variants.

Installation

$pnpm dlx shadcn@latest add @componentry/github-calendar

Usage

API Reference

PropTypeDefault
usernameThe GitHub username to fetch contributions for. (Required)
string—
variantThe visual style variant of the calendar.
"default" | "city-lights" | "minimal""default"
colorSchemaThe color scheme for the contribution cells.
"green" | "blue" | "purple" | "orange" | "gray""green"
showTotalWhether to show the total contributions count header.
booleantrue

Click on the icon in the top right of the example preview to view the source code for specific variants.

Keep in mind

This component is inspired by various open-source projects and patterns. Please verify licenses and implementation details before using in production.

Have any questions?
Contact on@harshjdhv
import { GithubCalendar } from "@/components/ui/github-calendar"

<GithubCalendar username="harshjdhv" />