# Clip Wipe

Words reveal left-to-right via clip-path; keywords turn gold on speak; the group exits with a wipe.

> 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/caption-clip-wipe
```

  <Step>Copy and paste the following code into your project.</Step>
  <ComponentSource
    name="caption-clip-wipe"
    title="components/ui/caption-clip-wipe.tsx"
  />
  <Step>Update the import paths to match your project setup.</Step>

## Usage

```tsx
import { CaptionClipWipe } from "@/components/framecn/caption-clip-wipe";
```

```tsx
<CaptionClipWipe keywords={["single", "code."]} />
```

## API Reference

### CaptionClipWipe

| Prop               | Type               | Default               |
| ------------------ | ------------------ | --------------------- |
| `words`            | `CaptionWord[]`    | (demo words)          |
| `keywords`         | `string[]`         | `["single", "code."]` |
| `color`            | `string`           | `"#ffffff"`           |
| `keywordColor`     | `string`           | `"#FFD700"`           |
| `fontSize`         | `number`           | `72`                  |
| `fontWeight`       | `number \| string` | `700`                 |
| `background`       | `string`           | `"#0a0a0a"`           |
| `speed`            | `number`           | `1`                   |
| `fps`              | `number`           | `30`                  |
| `durationInFrames` | `number`           | `180`                 |
| `width`            | `number`           | `1280`                |
| `height`           | `number`           | `720`                 |
| `className`        | `string`           | `-`                   |

## Notes

  The `start` and `end` fields on each `CaptionWord` are in seconds.