Backgrounds

Background Beams

Animated SVG background with customizable beam paths and gradient colors.

The BackgroundBeams component creates an animated SVG background with customizable beam paths and gradient colors. It's perfect for creating dynamic background effects with smooth animations.

Usage

Background Beams

Animated background beams effect

<template>
  <UCard class="relative overflow-hidden">
    <template #header>
      <h2 class="text-xl font-semibold">
        Background Beams
      </h2>
    </template>
    <p class="text-muted mb-4">
      Animated background beams effect
    </p>
    <MBackgroundBeams
      class="h-64 w-full"
      :num-paths="25"
      :stroke-opacity="1"
    />
  </UCard>
</template>

Examples

Basic Background Beams

Beam Network

Connect your interface with dynamic beam effects that create a futuristic and engaging user experience

<template>
  <div class="relative h-96 rounded-xl overflow-hidden border border-default bg-gradient-to-br from-gray-900 to-black">
    <MBackgroundBeams
      class="h-full w-full"
      :num-paths="15"
      :stroke-opacity="0.7"
    />
    <div class="relative z-10 h-full flex flex-col items-center justify-center text-center p-6">
      <div class="mb-6">
        <div class="w-20 h-20 rounded-full bg-gradient-to-r from-blue-500 to-cyan-400 flex items-center justify-center mx-auto">
          <UIcon
            name="i-lucide-zap"
            class="w-10 h-10 text-white"
          />
        </div>
      </div>
      <h2 class="text-4xl font-bold text-white mb-4">
        Beam Network
      </h2>
      <p class="text-dimmed max-w-md mb-8">
        Connect your interface with dynamic beam effects that create a futuristic and engaging user experience
      </p>
      <div class="flex flex-col sm:flex-row gap-4">
        <UButton
          color="primary"
          variant="solid"
          size="lg"
        >
          Explore Features
        </UButton>
        <UButton
          color="neutral"
          variant="outline"
          size="lg"
        >
          View Documentation
        </UButton>
      </div>
    </div>
  </div>
</template>

Customize

Customize

Gradient Colors
Stroke Opacity0.4
Num Paths50

Props

Prop Type Default Description
classNamestring''CSS classes to apply to the container.
gradientColorsstring[]['#18CCFC', '#18CCFC', '#6344F5', '#AE48FF']Colors for the beam gradient. Each value accepts a Nuxt UI color token (e.g. primary) or any CSS color.
strokeOpacitynumber0.4Opacity of the beam strokes (0-1).
numPathsnumber50Number of beam paths to display.
durationarray[10, 20]Min and max duration for animations.

UI

This component's theme exposes the slots below. Override any of them per instance with the ui prop, or app-wide under ui.backgroundBeams in app.config.ts.

Prop Type Default Description
uiobject-Per-slot classes merged over the theme defaults.
Slot Props Description
root-absolute inset-0 flex h-full w-full items-center justify-center [mask-repeat:no-repeat] [mask-size:40px]
svg-pointer-events-none absolute z-0 h-full w-full
Copyright © 2026