Components

Github Button

A github button component with animated stars display effects.

Loading

Installation

pnpm dlx shadcn@latest add @restrictui/github-button

Examples

Outline

Loading

Separator

Loading

Sizes

Loading

API Reference

This component is built using Radix UI Slot and Motion primitives and includes the following custom props:

GithubButton

Prop	Type	Default
`variant`	~~'default' \| 'outline'~~	~~'default'~~
`size`	~~'md' \| 'sm' \| 'lg'~~	~~'md'~~
`className`	~~string~~
`roundStars`	~~boolean~~	~~false~~
`fixedWidth`	~~boolean~~	~~true~~
`initialStars`	~~number~~	0
`starsClass`	~~string~~
`targetStars`	~~number~~
`separator`	~~boolean~~	~~false~~
`showStarIcon`	~~boolean~~	~~true~~
`animationDuration`	~~number~~	2
`animationDelay`	~~number~~	0
`autoAnimate`	~~boolean~~	~~true~~
`showGithubIcon`	~~boolean~~	~~true~~
`filled`	~~boolean~~	~~false~~
`repoUrl`	~~string~~
`label`	~~string~~	~~'Star'~~
`useInViewTrigger`	~~boolean~~	~~false~~
`inViewOptions`	~~UseInViewOptions~~	~~{ once: true }~~
`transition`	~~SpringOptions~~

Credits

Built with Radix UI Slot.
Inspired by Animate UI.

PreviouseMarquee NextAvatar Group

On This Page

Installation
Examples
API Reference
- GithubButton
Credits

Github Button - ReStrictUI