# Shimmer Sweep

Bright gradient sweeps across dim text, lighting it up.

> 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/shimmer-sweep
```

<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 { ShimmerSweep } from "@/components/framecn/shimmer-sweep";
```

```tsx
<ShimmerSweep text="value" />
```

## API Reference

### ShimmerSweep

| Prop               | Type     | Default     |
| ------------------ | -------- | ----------- |
| `text`             | `string` | `-`         |
| `baseColor`        | `string` | `"#3f3f46"` |
| `shineColor`       | `string` | `"#fafafa"` |
| `fontSize`         | `number` | `96`        |
| `fontWeight`       | `number` | `700`       |
| `speed`            | `number` | `1`         |
| `fps`              | `number` | `30`        |
| `durationInFrames` | `number` | `90`        |
| `className`        | `string` | `-`         |

## Notes

  The shimmer effect sweeps from left to right. You can reverse this by swapping
  the gradient colors or using a custom gradient direction.