Skip to content

Border beam

Moves a short light around the border of a surface.

Pro

For teams that ship every week.

Popular

$24 per month

  • Unlimited projects
  • Version history
  • Priority support
border-beam-demo.tsx

Installation

The CLI adds the files, packages, theme variables, and Tailwind plugin that this component uses. Before you run it, set up your project.

Usage

Put the beam inside a positioned element with a border. It takes the radius of that element.

featured-plan.tsx

Active prompt

Set active to show the beam only while work is in progress. Also install Prompt input.

border-beam-prompt-demo.tsx

Color and width

Use the --border-beam-color and --border-beam-width CSS variables. Match the width to the border.

Sync is on

Changes upload as you work.

New in 2.4

Comments sync in real time.

border-beam-color-demo.tsx

API reference

active: boolean = true
Shows the beam. Set false to remove it.
duration: number = 6
Time in seconds for one lap around the border.
--border-beam-color: CSS color = var(--color-foreground)
Color of the beam. Set it in className.
--border-beam-width: CSS length = 1px
Width of the beam. Make it the same as the border width.