# Simulated Cursor

A simulated cursor with click animations and movement.

> 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/simulated-cursor
```

<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 { SimulatedCursor } from "@/components/framecn/simulated-cursor";
```

```tsx
<SimulatedCursor />
```

## API Reference

### SimulatedCursor

| Prop               | Type            | Default          |
| ------------------ | --------------- | ---------------- |
| `points`           | `CursorPoint[]` | `DEFAULT_POINTS` |
| `color`            | `string`        | `"#ffffff"`      |
| `size`             | `number`        | `32`             |
| `background`       | `string`        | `"#0a0a0a"`      |
| `speed`            | `number`        | `1`              |
| `fps`              | `number`        | `30`             |
| `durationInFrames` | `number`        | `150`            |
| `className`        | `string`        | `-`              |

## Notes

  The cursor is drawn as inline SVG, so you don't need to copy anything into
  `public/`. Drop the component into any composition and it just works.