GitHub Stars

Display GitHub repo star count with formatted numbers and full-count tooltip.

Loading…

import { GitHubStars } from "@/components/github-stars"
 
export default function GitHubStarsDemo() {
  return <GitHubStars repo="ncdai/chanhdai.com" stargazersCount={1050} />
}

Features

Displays the star count of a specified GitHub repository.
Optical alignment for better visual balance with the GitHub icon.
Formats large numbers for better readability (e.g., 1.2k for 1200).
Includes a tooltip that shows the full star count on hover.

Installation

$ pnpm dlx shadcn@latest add @ncdai/github-stars

Usage

import { GithubStars } from "@/components/github-stars"

<GithubStars repo="ncdai/chanhdai.com" stargazersCount={1050} />

API Reference

GitHubStars

Prop

Type

Examples

Fetching GitHub Stars with Server Component

import {
  Tooltip,
  TooltipContent,
  TooltipTrigger,
} from "@/components/ui/tooltip"
import { Button } from "@/components/ui/button"
import { UTM_PARAMS } from "@/config/site"
import { addQueryParams } from "@/utils/url"
 
type GitHubStarsProps = {
  repo: string
  stargazersCount: number
}
 
export function GitHubStars({ repo, stargazersCount }: GitHubStarsProps) {
  return (
    <Tooltip>
      <TooltipTrigger
        render={
          <Button
            className="gap-1.5 border-none pr-1.5 pl-2"
            variant="ghost"
            size="sm"
            asChild
          >
            <a
              href={addQueryParams(`https://github.com/${repo}`, UTM_PARAMS)}
              target="_blank"
              rel="noopener noreferrer"
            >
              <svg className="-translate-y-px" viewBox="0 0 24 24">
                <path
                  d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"
                  fill="currentColor"
                />
              </svg>
              <span className="text-[0.8125rem] text-muted-foreground tabular-nums">
                {new Intl.NumberFormat("en-US", {
                  notation: "compact",
                  compactDisplay: "short",
                })
                  .format(stargazersCount)
                  .toLowerCase()}
              </span>
            </a>
          </Button>
        }
      />
      <TooltipContent className="font-sans">
        {new Intl.NumberFormat("en-US").format(stargazersCount)} stars
      </TooltipContent>
    </Tooltip>
  )
}