# Shelf planogram

> Shelves, facing by facing, with stock levels. Sample data: three dairy shelves, 15 products from OAT to MOZZ, healthy, low and out of stock.

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

## 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 Shelf planogram component to your project.

```bash
npx shadcn add @chartory/shelf-planogram
```

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

usage.tsx:

```tsx
import { ShelfPlanogram }
  from "@/components/chartory/shelf-planogram"

<ShelfPlanogram
  data={dairyShelves}
  size="m"
  legend
/>
```

## Props

### `<ShelfPlanogram>`

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

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | ShelfPlanogramData | 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). |

### ShelfPlanogramData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| shelves | ShelfPlanogramShelf[][] | Required | The shelves, top to bottom; one entry per product. |
| low | number | Required | The low-stock threshold. |
| out | number | Required | The out-of-stock count. |

### ShelfPlanogramShelf

One object per entry in shelves.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| name | string | Required | The name shown on the chart. |
| w | number | Required | The product's width on the shelf, relative to the others on it. |
| pct | number | Required | The share, in percent. |

## Shelf planogram: a React and Figma chart in four sizes

### What does a shelf planogram show?

A shelf planogram draws shelves with each product's facings in place and colours them by stock level, so gaps and low stock show where they are. Use it for store shelves, vending and any fixed layout of products.

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 Shelf planogram component?

It is one **<ShelfPlanogram>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is products in position with a stock level.

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?

- **Does position matter?** Yes means the shelf planogram fits.
- **Is it products, not doors?** Yes means the shelf planogram fits.
- **Is it a level now?** Yes means the shelf planogram fits.

### When does another type fit better?

- **Stock per item, no layout.** Use Horizontal bars instead.
- **Dock doors.** Use Yard map instead.
- **Stock over time.** Use Stock sawtooth instead.

## Shelf planogram questions

### Does the Shelf planogram 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/shelf-planogram. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

Products in position with a stock level. 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/059-shelf-planogram 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.