asafefe.dev

Shimmer Button

A button with a light sweep on hover, with variant and size options.

class-variance-authorityutils

Variants

Installation

$ pnpm dlx shadcn@latest add @soultel/shimmer-button

No namespace set up? npx shadcn@latest add https://asafefe.dev/r/shimmer-button.json works too.

Manual installation
  1. 1. Install the dependencies.
    terminal1 lines
    npm install class-variance-authority
  2. 2. Copy the source from the Code tab into ui/shimmer-button.tsx.
  3. 3. Add the keyframes it uses (shimmer-sweep) to your global CSS. The CLI does this for you.

Usage

example.tsx5 lines
import { ShimmerButton } from "@/components/ui/shimmer-button"

export function Example() {
  return <ShimmerButton>Get started</ShimmerButton>
}

Props

PropTypeDefaultDescription
variant"default" | "outline" | "ghost""default"Visual style.
size"sm" | "default" | "lg""default"Height and padding.

Notes

The shimmer runs once on hover, so it reads as a response to the user rather than constant motion. Everything is a plain <button> underneath, so onClick, disabled, type, and the rest of the native props pass straight through.

Props

PropTypeDefault
variantdefault outline ghostdefault
sizesm default lgdefault
Any className you pass is merged after the variant classes, so you can override colors, width, or radius without fighting specificity.

Notes

The sweep is a single absolutely positioned layer with mix friendly opacity, so it works on any background. For a reduced-motion pass, drop the group-hover:animate-* class and the button stays fully functional.