Animated Beam

Install: npx shadcn@latest add https://jiguang132.com/r/magic-ui/animated-beam.json

Use case

Connect referenced DOM elements with an animated SVG beam.

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.

Interaction and state checks

• Bento Demo — bento-demo
• Animated Beam Demo — animated-beam-demo
• Animated Beam Unidirectional — animated-beam-unidirectional
• Animated Beam Bidirectional — animated-beam-bidirectional
• Animated Beam Multiple Inputs — animated-beam-multiple-inputs
• Animated Beam Multiple Outputs — animated-beam-multiple-outputs

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

containerRef/fromRef/toRef must resolve within the same document. This visual connection neither transfers data nor invokes an integration.

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

bento-demo, animated-beam-demo, animated-beam-unidirectional, animated-beam-bidirectional, animated-beam-multiple-inputs, animated-beam-multiple-outputs

Demo state and mock data do not provide a backend service. Inspect the component props before wiring real data.

Installation

npx shadcn@latest add @magicui/animated-beam

<Step>Copy and paste the following code into your project.</Step>

<Step>Update the import paths to match your project setup.</Step>

Examples

Animated Beam Uni-Directional

Animated Beam Bi-Directional

Animated Beam Multiple Inputs

Animated Beam Multiple Outputs

Usage

import { AnimatedBeam } from "@/components/ui/animated-beam"

<AnimatedBeam containerRef={containerRef} fromRef={fromRef} toRef={toRef} />

Props

Animated Beam

Credits

• Credit to @itsarghyadas for figuring out the foundation of this!

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.

Bento Demo

npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/animated-beam/bento-demo.json

Default import: @/components/magicui/examples/bento-demo

Dependencies: @radix-ui/react-icons@1.3.2, @radix-ui/react-slot@1.3.0, class-variance-authority@0.7.1, clsx@2.1.1, lucide-react@1.24.0, motion@12.42.2, react-day-picker@9.14.0, tailwind-merge@3.6.0

Animated Beam Demo

npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/animated-beam/animated-beam-demo.json

Default import: @/components/magicui/examples/animated-beam-demo

Dependencies: clsx@2.1.1, motion@12.42.2, tailwind-merge@3.6.0

Animated Beam Unidirectional

npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/animated-beam/animated-beam-unidirectional.json

Default import: @/components/magicui/examples/animated-beam-unidirectional

Dependencies: clsx@2.1.1, motion@12.42.2, tailwind-merge@3.6.0

Animated Beam Bidirectional

npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/animated-beam/animated-beam-bidirectional.json

Default import: @/components/magicui/examples/animated-beam-bidirectional

Dependencies: clsx@2.1.1, motion@12.42.2, tailwind-merge@3.6.0

Animated Beam Multiple Inputs

npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/animated-beam/animated-beam-multiple-inputs.json

Default import: @/components/magicui/examples/animated-beam-multiple-inputs

Dependencies: clsx@2.1.1, motion@12.42.2, tailwind-merge@3.6.0

Animated Beam Multiple Outputs

npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/animated-beam/animated-beam-multiple-outputs.json

Default import: @/components/magicui/examples/animated-beam-multiple-outputs

Dependencies: clsx@2.1.1, motion@12.42.2, tailwind-merge@3.6.0

Minimal usage and theme

import Demo from '@/components/magicui/examples/bento-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.

AnimatedBeam({
  className,
  containerRef,
  fromRef,
  toRef,
  curvature = 0,
  reverse = false, // Include the reverse prop
  duration = 5,
  delay = 0,
  pathColor = "gray",
  pathWidth = 2,
  pathOpacity = 0.2,
  gradientStartColor = "#ffaa40",
  gradientStopColor = "#9c40ff",
  repeat = Infinity,
  repeatDelay = 0,
  startXOffset = 0,
  startYOffset = 0,
  endXOffset = 0,
  endYOffset = 0,
})

export interface AnimatedBeamProps {
  className?: string
  containerRef: RefObject<HTMLElement | null> // Container ref
  fromRef: RefObject<HTMLElement | null>
  toRef: RefObject<HTMLElement | null>
  curvature?: number
  reverse?: boolean
  pathColor?: string
  pathWidth?: number
  pathOpacity?: number
  gradientStartColor?: string
  gradientStopColor?: string
  delay?: number
  duration?: number
  repeat?: number
  repeatDelay?: number
  startXOffset?: number
  startYOffset?: number
  endXOffset?: number
  endYOffset?: number
}

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.

// AnimatedBeam
curvature = 0

// AnimatedBeam
reverse = false

// AnimatedBeam
duration = 5

// AnimatedBeam
delay = 0

// AnimatedBeam
pathColor = "gray"

// AnimatedBeam
pathWidth = 2

// AnimatedBeam
pathOpacity = 0.2

// AnimatedBeam
gradientStartColor = "#ffaa40"

// AnimatedBeam
gradientStopColor = "#9c40ff"

// AnimatedBeam
repeat = Infinity

// AnimatedBeam
repeatDelay = 0

// AnimatedBeam
startXOffset = 0

// AnimatedBeam
startYOffset = 0

// AnimatedBeam
endXOffset = 0

// AnimatedBeam
endYOffset = 0

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.FC<AnimatedBeamProps>
RefObject<HTMLElement | null>
HTMLElement