GitHub Stars

1import { Button } from "@/components/ui/button"
2import {
3  Tooltip,
4  TooltipContent,
5  TooltipTrigger,
6} from "@/components/ui/tooltip"
7 
8export type GitHubStarsProps = {
9  /** GitHub repository in `owner/repo` format. */
10  repo: string
11  /** Number of stars to display. */
12  stargazersCount: number
13  /**
14   * Optional locales for number formatting.
15   * See [MDN - Intl - locales argument](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument).
16   * @defaultValue "en-US"
17   */
18  locales?: Intl.LocalesArgument
19}
20 
21export function GitHubStars({
22  repo,
23  stargazersCount,
24  locales = "en-US",
25}: GitHubStarsProps) {
26  return (
27    <Tooltip>
28      <TooltipTrigger asChild>
29        <Button className="gap-1.5 pr-1.5 pl-2" variant="ghost" asChild>
30          <a href={`https://github.com/${repo}`} target="_blank" rel="noopener">
31            <svg className="-translate-y-px" viewBox="0 0 24 24">
32              <path
33                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"
34                fill="currentColor"
35              />
36            </svg>
37            <span className="text-[0.8125rem] text-muted-foreground tabular-nums">
38              {new Intl.NumberFormat(locales, {
39                notation: "compact",
40                compactDisplay: "short",
41              })
42                .format(stargazersCount)
43                .toLowerCase()}
44            </span>
45          </a>
46        </Button>
47      </TooltipTrigger>
48 
49      <TooltipContent className="font-sans">
50        {new Intl.NumberFormat(locales).format(stargazersCount)} stars
51      </TooltipContent>
52    </Tooltip>
53  )
54}