Skip to Content
šŸŽ‰Introducing Pumki UI

GitHub Star Button

A button component that displays the number of stars a GitHub repository has, with a dynamic animation effect.

Pumki UIPumki UI

Installation

Usage


1import { GitHubStarsButton } from '@/components/pumki-ui/buttons/github-star';

1<GitHubStarsButton username="AnshSinghSonkhia" repo="pumki-ui" />

Props

PropTypeDefaultDescription
inViewOnce?booleantrueAnimate only the first time the button enters the viewport
inViewMargin?string0pxMargin for viewport detection
inView?booleanfalseEnable viewport-based animation
formatted?booleanfalseShow compact number format (e.g. 1.2k)
transition?object{ stiffness: 90, damping: 50 }Spring animation config
repostring-GitHub repository name
usernamestring-GitHub username or organization
Last updated on