# Retention cut

> What a retention window keeps and frees. Sample data: stored traces by age, a 60-day cut keeps 222 GB and frees 90 GB, against today's 90 days.

- Type 130 · Distribution
- Component: `<RetentionCut>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/retention-cut` (Code and Complete plans)
- Type page: https://usechartory.com/charts/retention-cut

## Installation

1. **Set up the registry once.** Your token in .env and @chartory in components.json. Skip this when another chart is already installed. [Installation guide](https://usechartory.com/docs/installation)

2. **Add the chart.** One command adds the Retention cut component to your project.

```bash
npx shadcn add @chartory/retention-cut
```

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

usage.tsx:

```tsx
import { RetentionCut }
  from "@/components/chartory/retention-cut"

<RetentionCut
  data={traceStorage}
  size="m"
  legend
/>
```

## Props

### `<RetentionCut>`

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

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

### RetentionCutData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| vals | number[] | Required | The values, in order. |
| cut | number | Required | Where the cut is. |
| now | number | Required | Where now is on the axis. |
| ymax | number | Required | The top of the y scale. |
| yt | [number, string][] | Required | The y axis ticks: [value, label] pairs. |
| xt | [number, string][] | Required | The x axis ticks: [value, label] pairs. |
| pins | RetentionCutPin[] | Required | One entry per pin. |
| kept | string | Required | The kept share as shown. |
| freed | string | Required | The freed share as shown. |
| gone | string | Required | The lost share as shown. |

### RetentionCutPin

One object per entry in pins.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| d | number | Required | The point it marks (index into vals). |
| text | string | Required | The label as shown. |
| short | string | Required | The short form of the label, for the small sizes. |
| open | boolean | Required | Marks it as open. |

## Retention cut chart: a React and Figma chart in four sizes

### What does a retention cut chart show?

A retention cut chart shows stored data by age with a cut line at the retention window, so you see what would be kept, what would be freed and which items fall on each side. Use it for logs, traces and backups.

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 Retention cut component?

It is one **<RetentionCut>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is size by age, a retention window.

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 there a retention window?** Yes means the retention cut fits.
- **Is it by age?** Yes means the retention cut fits.
- **Do named items matter?** Yes means the retention cut fits.

### When does another type fit better?

- **Plain storage by item.** Use Treemap instead.
- **Usage against plan limits.** Use Limit tracks instead.
- **Just the total by age.** Use Area chart instead.

## Retention cut questions

### Does the Retention cut 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?

Add your token and the @chartory registry once, then run npx shadcn add @chartory/retention-cut. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

Size by age, a retention window. 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/130-retention-cut 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?

Code and Complete. Figma has the Figma file only.