# Directional Wipe

Slide one scene in while pushing the other out.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).

## Installation

<TabsTrigger value="cli">Command</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>

```bash
npx shadcn@latest add @framecn/directional-wipe
```

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

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

## Usage

```tsx
import { DirectionalWipe } from "@/components/framecn/directional-wipe";
```

```tsx
<DirectionalWipe />
```

## API Reference

### DirectionalWipe

| Prop                 | Type                                  | Default   |
| -------------------- | ------------------------------------- | --------- |
| `from`               | `ReactNode`                           | `-`       |
| `to`                 | `ReactNode`                           | `-`       |
| `direction`          | `"left" \| "right" \| "up" \| "down"` | `"left"`  |
| `transitionStart`    | `number`                              | `36`      |
| `transitionDuration` | `number`                              | `20`      |
| `speed`              | `number`                              | `1`       |
| `fps`                | `number`                              | `30`      |
| `durationInFrames`   | `number`                              | `90`      |
| `width`              | `number`                              | `1280`    |
| `height`             | `number`                              | `720`     |
| `background`         | `string`                              | `"black"` |
| `className`          | `string`                              | `-`       |

## Notes

  One scene slides in while pushing the other out in the specified direction.
  The duration controls the transition speed.