Shine Border
Install: npx shadcn@latest add https://jiguang132.com/r/magic-ui/shine-border.json
Use case
Overlay an animated multicolor shine border.
Native props used by the examples
Extracted from all local examples for this entry, grouped by imported module and native owner, including other Magic components used by compound demos. This is not an exhaustive API or a universal host variant. Inspect spread object declarations and the source types/defaults below.
| Owning component prop | Explanation | Example source |
|---|---|---|
ShineBorder.shineColor (shine-border) | One color or an array for the shining border. | examples/shine-border-demo.tsx、examples/shine-border-demo-2.tsx |
Interaction and state checks
- Shine Border Demo —
shine-border-demo - Shine Border Demo 2 —
shine-border-demo-2
These names identify real example entries, not new component props or extra components. Check pointer/keyboard behavior, themes, small screens and failures for the selected example. Decorative effects must not invent disabled/error/submission states. Complete example installation includes the actual dependency closure.
Business integration boundary
Use a positioned parent and preserve its real controls; shineColor accepts a color or array, not a theme-provider object.
Host and motion setup
Initialize Tailwind CSS v4, semantic CSS variables and the dark variant; import the independent local Registry namespace. Reuse an existing next-themes Provider without substituting JGuang UI/Base UI/HeroUI APIs. Mount effects in view and unmount offscreen; provide static alternatives for unavailable Canvas/WebGL or failed remote media. Respect prefers-reduced-motion and verify timer/RAF/observer/listener cleanup: stopping CSS alone does not prove the engine stopped. Examples provide no backend, login, payment or real AI stream. This practical guide is bilingual; detailed upstream references and demo text retain their original language.
Available examples
shine-border-demo, shine-border-demo-2
Demo state and mock data do not provide a backend service. Inspect the component props before wiring real data.
Installation
<Tabs defaultValue="cli"> <TabsList> <TabsTrigger value="cli">CLI</TabsTrigger> <TabsTrigger value="manual">Manual</TabsTrigger> </TabsList> <TabsContent value="cli">npx shadcn@latest add @magicui/shine-border
</TabsContent>
<TabsContent value="manual">
<Steps>
<Step>Copy and paste the following code into your project.</Step>
<Step>Update the import paths to match your project setup.</Step>
<Step>Add the required CSS animations</Step>
Add the following animations to your global CSS file.
@theme inline {
--animate-shine: shine var(--duration) infinite linear;
@keyframes shine {
0% {
background-position: 0% 0%;
}
50% {
background-position: 100% 100%;
}
to {
background-position: 0% 0%;
}
}
}
</Steps>
</TabsContent>
</Tabs>
Examples
Monotone
Usage
import { ShineBorder } from "@/components/ui/shine-border"
<div className="relative h-[500px] w-full overflow-hidden">
<ShineBorder />
</div>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | - | The class name to be applied to the component. |
duration | number | 14 | Defines the animation duration to be applied on the shining border. |
shineColor | string | string[] | "#000000" | Color of the border, can be a single color or an array of colors. |
borderWidth | number | 1 | Width of the border in pixels. |
style | React.CSSProperties | - | Additional styles to be applied to the component. |
Complete example installation
The component command installs the component. Each example command also includes its actual imported components, native support UI, utilities and pinned dependencies. Helpers are not additional catalog components.
Shine Border Demo
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/shine-border/shine-border-demo.json
Default import: @/components/magicui/examples/shine-border-demo
Dependencies: @radix-ui/react-label@2.1.11, @radix-ui/react-slot@1.3.0, class-variance-authority@0.7.1, clsx@2.1.1, tailwind-merge@3.6.0
Shine Border Demo 2
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/shine-border/shine-border-demo-2.json
Default import: @/components/magicui/examples/shine-border-demo-2
Dependencies: @radix-ui/react-label@2.1.11, @radix-ui/react-slot@1.3.0, class-variance-authority@0.7.1, clsx@2.1.1, next-themes@0.4.6, tailwind-merge@3.6.0
Minimal usage and theme
import Demo from '@/components/magicui/examples/shine-border-demo';
import { ThemeProvider } from 'next-themes';
export default function Example() {
return <ThemeProvider attribute="class" defaultTheme="system" enableSystem><Demo /></ThemeProvider>;
}
Initialize Tailwind CSS v4, semantic color variables and the dark variant first. Reuse an existing next-themes provider rather than nesting another. Next Link examples require a Next.js environment; in static Vite projects adapt the demo links to your router without changing the native component API. Some media and tweets require network access. Examples do not supply authentication or backend services.
Source-backed parameter reference
Implementation signatures and types are generated from the pinned local source. Optional props, native inherited types, union branches and never exclusions are preserved. A forwardRef implementation's ref is a React reference, not an additional business prop.
ShineBorder({
borderWidth = 1,
duration = 14,
shineColor = "#000000",
className,
style,
...props
}: ShineBorderProps)
interface ShineBorderProps extends React.HTMLAttributes<HTMLDivElement> {
/**
* Width of the border in pixels
* @default 1
*/
borderWidth?: number
/**
* Duration of the animation in seconds
* @default 14
*/
duration?: number
/**
* Color of the border, can be a single color or an array of colors
* @default "#000000"
*/
shineColor?: string | string[]
}
Destructuring defaults in source
Only defaults written directly in parameter/props destructuring are listed. Conditional expressions, runtime theme and computed values require source inspection; this is not an exhaustive behavior-default list.
// ShineBorder
borderWidth = 1
// ShineBorder
duration = 14
// ShineBorder
shineColor = "#000000"
Native and external types
External types remain defined by React or native dependencies, not manually expanded into guessed props. The installed version's TypeScript definitions are authoritative.
React.HTMLAttributes<HTMLDivElement>
HTMLDivElement