# Kinetic Type Mask

Use giant typography as a window into the next scene.

> 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/kinetic-type-mask
```

<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 { KineticTypeMask } from "@/components/framecn/kinetic-type-mask";
```

```tsx
<KineticTypeMask />
```

## API Reference

### KineticTypeMask

| Prop                 | Type        | Default  |
| -------------------- | ----------- | -------- |
| `from`               | `ReactNode` | `-`      |
| `to`                 | `ReactNode` | `-`      |
| `text`               | `string`    | `"NEXT"` |
| `transitionStart`    | `number`    | `-`      |
| `holdFrames`         | `number`    | `12`     |
| `transitionDuration` | `number`    | `24`     |
| `maxScale`           | `number`    | `120`    |
| `speed`              | `number`    | `1`      |
| `fps`                | `number`    | `30`     |
| `durationInFrames`   | `number`    | `90`     |
| `width`              | `number`    | `1280`   |
| `height`             | `number`    | `720`    |
| `className`          | `string`    | `-`      |

## Notes

  Giant text acts as a window into the next scene. The text clips the revealing
  scene, creating an interesting reveal effect.