Sparkles
Decorative twinkling sparkles scattered behind content. Install Sparkles from the VLLNT UI registry with the shadcn CLI.
Decorative twinkling sparkles scattered behind content. Part of the utility family in VLLNT UI, it ships as a machine-readable registry entry — copy the source directly into your app with the shadcn CLI and own it, no runtime dependency on a component library.
Preview
Switch between light and dark to inspect the embedded Storybook preview.
Installation
Add Sparkles to your project with the shadcn CLI. The source lands in your codebase, ready to adapt:
pnpm dlx shadcn@latest add https://ui.vllnt.ai/r/sparkles.jsonSource
"use client";
import * as React from "react";
import { cn } from "../../lib/utils";
/** Props for {@link Sparkles}. */
export type SparklesProps = React.ComponentPropsWithoutRef<"div"> & {
/** Count of twinkling sparkle squares to scatter. Defaults to `20`. */
count?: number;
};
type Sparkle = {
delay: number;
duration: number;
left: number;
size: number;
top: number;
};
function createSparkles(count: number): Sparkle[] {
return Array.from({ length: count }, () => ({
delay: Math.random() * 2,
duration: 1 + Math.random() * 1.5,
left: Math.random() * 100,
size: 4 + Math.random() * 8,
top: Math.random() * 100,
}));
}
/**
* Decorative field of twinkling sparkles layered behind optional content.
*
* Respects `prefers-reduced-motion`: the sparkles hold still.
*
* @example
* ```tsx
* <Sparkles count={30}>
* <h1>Magic</h1>
* </Sparkles>
* ```
*/
export const Sparkles = ({
children,
className,
count = 20,
ref,
...props
}: SparklesProps & { ref?: React.Ref<HTMLDivElement> }) => {
const [sparkles] = React.useState(() => createSparkles(count));
return (
<div className={cn("relative", className)} ref={ref} {...props}>
<div
aria-hidden="true"
className="pointer-events-none absolute inset-0 overflow-hidden"
>
{sparkles.map((sparkle, index) => (
<span
className="absolute rotate-45 rounded-[1px] bg-foreground motion-reduce:animate-none"
key={index}
style={{
animation: `vllnt-sparkle ${sparkle.duration}s linear infinite`,
animationDelay: `${sparkle.delay}s`,
height: `${sparkle.size}px`,
left: `${sparkle.left}%`,
top: `${sparkle.top}%`,
width: `${sparkle.size}px`,
}}
/>
))}
</div>
{children ? <div className="relative">{children}</div> : null}
</div>
);
};
Sparkles.displayName = "Sparkles";
Stories
Explore every variant and state in the interactive Storybook:
Preview
Switch between light and dark to inspect the embedded Storybook preview.