# PulseBeam

> Breathing border glow that wraps any card: colour blobs drift along the edges as a crisp 1px ring, a feathered inner glow and a blurred bloom, with slow hue rotation, fade in/out on an active flag, four palettes and an outside halo variant.

- Package: `fancy-ui-react` (React 18/19 + Tailwind CSS v4)
- Category: Effects
- Tags: border, glow, pulse, gradient, mask, animation, ai, loading
- Types: `PulseBeamProps`, `PulseBeamPalette`, `PulseBeamTone`, `PulseBeamVariant`
- Docs: https://fancy-ui.rama.app/docs/components/pulse-beam
- Source: https://github.com/RamaHerbin/fancy-ui/tree/main/react/src/components/pulse-beam

## Import

```tsx
import { PulseBeam } from 'fancy-ui-react';
```

Setup (once per project): `npm install fancy-ui-react`, then put these lines in your main CSS file (the stylesheet import goes right after `@import "tailwindcss";`):

```css
@import "tailwindcss";
@import "fancy-ui-react/tailwind.css";
```

and import the component styles once in the app entry: `import "fancy-ui-react/styles.css";`. Full guide: https://fancy-ui.rama.app/llms.txt

The names below are the ones to write in React; when one differs from the Svelte name, the Svelte name follows in parentheses. `class` becomes `className`, a callback takes the name the React port declares (`onclick` becomes `onClick`), snippets become `ReactNode` props (render functions when they take arguments) and the default snippet is `children`. Divergences: https://github.com/RamaHerbin/fancy-ui/tree/main/react#divergences-from-the-svelte-api

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `active` | `boolean` | `true` | Show the glow. Turning it off fades out over 500ms and stops the animation loop; turning it on fades in over 600ms |
| `variant` | `"inner" \| "outside"` | `"inner"` | inner paints a 1px ring, a 28px feather and a bloom inside the box; outside keeps the ring and adds a blurred halo behind the content |
| `palette` | `"colorful" \| "mono" \| "ocean" \| "sunset"` | `"colorful"` | Built-in nine-slot colour set. mono halves the opacities and disables hue drift |
| `colors` | `string[]` | — | Up to nine CSS colours overriding the palette slots in order |
| `strength` | `number` | `1` | Overall intensity, 0 to 1 |
| `radius` | `number` | `16` | Corner radius in px applied to the wrapper and every layer |
| `speed` | `number` | `1` | Multiplier for the breathing and drift periods |
| `tone` | `"dark" \| "light"` | `"dark"` | Opacity, brightness and saturation preset for the surface the card sits on |
| `hueShift` | `boolean` | `true` | Slowly rotate all hues over a 14 to 16 second cycle |
| `brightness` | `number` | — | Override the preset brightness filter |
| `saturation` | `number` | — | Override the preset saturation filter |
| `onfadein` | `() => void` | — | Called once the fade-in has completed |
| `onfadeout` | `() => void` | — | Called once the fade-out has completed and the loop has stopped |
| `ref` | `HTMLDivElement \| null` | `null` | Bindable wrapper element |
| `className` (Svelte `class`) | `string` | — | Additional classes on the wrapper |

## Node props

| Prop | Description |
| --- | --- |
| `children` | Content the glow wraps; give it an opaque background and the same radius |

## Example

No React example is published for this component yet: start from the import above and the props table. The full examples are Svelte-only, on https://fancy-ui.rama.app/docs/components/pulse-beam.md.