# Grid Scan · Pro

A floor grid in perspective with a light bar sweeping across it; cells light up in a checkered pattern as the bar passes and fade behind it. CSS only, so it costs almost nothing.

This is a Charcoal UI Pro component. Its source and examples are available with a Pro seat: https://charcoalui.com/pricing

## With a Pro seat

1. Add the registry to components.json:

```json
{
  "registries": {
    "@charcoal": {
      "url": "https://charcoalui.com/r/{name}.json",
      "headers": {
        "Authorization": "Bearer ${CHARCOAL_LICENSE_KEY}"
      }
    }
  }
}
```

2. Copy your licence key from https://charcoalui.com/dashboard and put it in .env.local as CHARCOAL_LICENSE_KEY, then:

```bash
npx shadcn@latest add @charcoal/grid-scan
```

To read Pro source through this MCP server, reconnect it with the header "Authorization: Bearer <licence key>".

## API — Grid Scan
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `cell` | `number` | `56` | Cell size in px on the plane, before perspective. |
| `speed` | `number` | `1` | Sweeps per 10 seconds. |
| `color` | `string` | `"var(--ember)"` | Any CSS colour for the bar and the lit cells. |
| `perspective` | `number` | `520` | Perspective distance in px; smaller is more dramatic. |
| `direction` | `"right" \| "left" \| "down" \| "up"` | `"right"` |  |
| `className` | `string` | — |  |

See it live: https://charcoalui.com/docs/components/grid-scan