# Yard map

> Every dock door and what is at it. Sample data: 12 dock doors and the yard, loading, loaded, reefer and waiting 2 h+.

- Type 058 · Space and place
- Component: `<YardMap>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/yard-map` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/yard-map

## Installation

1. **Set up the registry once.** This chart is free in Hearth and MIT licensed: no token. Add @chartory to components.json once (the URL alone, no headers), or skip this when another chart is already installed. [Installation guide](https://usechartory.com/docs/installation)

2. **Add the chart.** One command adds the Yard map component to your project.

```bash
npx shadcn add @chartory/yard-map
```

3. **Use it.** Pass your rows. The props are the Figma properties.

usage.tsx:

```tsx
import { YardMap }
  from "@/components/chartory/yard-map"

<YardMap
  data={dockDoors}
  size="m"
  legend
/>
```

## Props

### `<YardMap>`

Every prop but data is a Figma property with the same name and values.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | YardMapData | Required | The chart's data. The tables below list every field. |
| size | "xs" \| "s" \| "m" \| "l" | "m" | The size class. Each one is laid out again from the data. |
| legend | boolean | true | Shows the legend row under the plot. |
| color | "cat-1" \| "cat-2" \| "cat-3" \| "cat-4" | "cat-1" | The data colour of the primary marks (data/primary). |

### YardMapData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| doors | string[] | Required | The door labels. |
| slots | string[] | Required | The slot labels. |
| toks | Record<string, string> | Required | The colour token per key. |

## Yard map: a React and Figma chart in four sizes

### What does a yard map show?

A yard map draws dock doors and yard slots as numbered places and fills each by its state: doors loading, empty or blocked, yard slots loaded, reefer, waiting too long or empty. Use it for warehouses, depots and terminals.

Chartory ships it as a Figma component and a React component with the same name. The code installs from the shadcn registry with one command and lands in your project as a file you own.

### What is the Yard map component?

It is one **<YardMap>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is a state per door or slot.

Sizes **XS**, **S**, **M** and **L** re-lay the chart out from the data instead of scaling it, so labels stay readable at every size.

### When should I use it?

- **Is it about place?** Yes means the yard map fits.
- **Is it a state per slot?** Yes means the yard map fits.
- **Is it doors, not shelves?** Yes means the yard map fits.

### When does another type fit better?

- **About timing.** Use Gantt instead.
- **A count per area.** Use Heatmap instead.
- **Shelf facings.** Use Shelf planogram instead.

## Yard map questions

### Does the Yard map chart work with shadcn/ui?

Yes. It installs through the shadcn registry with the shadcn CLI, and the file lands in your project.

### How do I install it?

It is free in Hearth and MIT licensed: add the @chartory registry URL once, no token, then run npx shadcn add @chartory/yard-map. The Installation guide has the steps.

### Can my coding agent install it?

Yes. Connect the Chartory MCP server and ask for the yard map chart; the agent runs the same command and you review the diff.

### What data does it expect?

A state per door or slot. The sample data comes with the component, and the props table lists every field.

### Which sizes does it ship in?

XS, S, M and L, in Figma and in code. Each size is laid out again from the data, so text and lines keep their size.

### Is it in the Figma file too?

Yes. chart/058-yard-map has the same properties as the component.

### Does it follow light and dark mode?

Yes. Every paint is a token, so the chart follows light and dark mode and the collection you pick.

### Which plan has the code?

None for Hearth: it is free in the public registry, no token. The Signal collection (@chartory/signal) comes with Code and Complete.