# Warp Background

- Page: https://jiguang132.com/resources/magic-ui/docs/warp-background
- Resource: Magic UI (https://jiguang132.com/resources/magic-ui.md)
- All guides: https://jiguang132.com/resources/magic-ui/docs.md

Install: `npx shadcn@latest add https://jiguang132.com/r/magic-ui/warp-background.json`

## Use case

Place content over perspective grid beams.

## 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 |
| --- | --- | --- |
| `WarpBackground.children` (warp-background) | Native child content; keep the owning component's text/element constraints. | `examples/warp-background-demo.tsx` |

## Interaction and state checks

- Warp Background Demo — `warp-background-demo`

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

The wrapper needs layout space; its beams are decorative and do not represent real data flow.

## 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

warp-background-demo

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">

```bash
npx shadcn@latest add @magicui/warp-background
```

</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>

</Steps>

</TabsContent>

</Tabs>

## Usage

```tsx showLineNumbers
import { WarpBackground } from "@/components/ui/warp-background"
```

```tsx showLineNumbers
<WarpBackground>
  <div className="w-80">
    <p>Warp Background</p>
    <p>This is a component that creates a warp background effect.</p>
  </div>
</WarpBackground>
```

## Props

| Prop           | Type              | Default           | Description                                     |
| -------------- | ----------------- | ----------------- | ----------------------------------------------- |
| `children`     | `React.ReactNode` | `-`               | The content to be put inside the warp animation |
| `perspective`  | `number`          | `100`             | The perspective of the warp animation           |
| `beamsPerSide` | `number`          | `3`               | The number of beams per side                    |
| `beamSize`     | `number`          | `5`               | The size of the beams                           |
| `beamDelayMax` | `number`          | `3`               | The maximum delay of the beams                  |
| `beamDelayMin` | `number`          | `0`               | The minimum delay of the beams                  |
| `beamDuration` | `number`          | `3`               | The duration of the beams                       |
| `gridColor`    | `string`          | `"var(--border)"` | The color of the grid lines                     |




## 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.

### Warp Background Demo

```bash
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/warp-background/warp-background-demo.json
```

Default import: `@/components/magicui/examples/warp-background-demo`

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

### Minimal usage and theme

```tsx
import Demo from '@/components/magicui/examples/warp-background-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.


```ts
WarpBackground({
  children,
  perspective = 100,
  className,
  beamsPerSide = 3,
  beamSize = 5,
  beamDelayMax = 3,
  beamDelayMin = 0,
  beamDuration = 3,
  gridColor = "var(--border)",
  ...props
})
```



```ts
interface WarpBackgroundProps extends HTMLAttributes<HTMLDivElement> {
  children: React.ReactNode
  perspective?: number
  beamsPerSide?: number
  beamSize?: number
  beamDelayMax?: number
  beamDelayMin?: number
  beamDuration?: number
  gridColor?: 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.


```ts
// WarpBackground
perspective = 100

// WarpBackground
beamsPerSide = 3

// WarpBackground
beamSize = 5

// WarpBackground
beamDelayMax = 3

// WarpBackground
beamDelayMin = 0

// WarpBackground
beamDuration = 3

// WarpBackground
gridColor = "var(--border)"
```


### 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.


```ts
React.FC<WarpBackgroundProps>
HTMLAttributes<HTMLDivElement>
HTMLDivElement
React.ReactNode
```

---

Index of all JGuang resources: https://jiguang132.com/llms.txt