# Weekly rhythm

> A week of runs, by day and hour. Sample data: agent runs this week by weekday and hour, Monday to Sunday.

- Type 103 · Schedule and status
- Component: `<WeeklyRhythm>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/weekly-rhythm` (Code and Complete plans)
- Type page: https://usechartory.com/charts/weekly-rhythm

## 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 Weekly rhythm component to your project.

```bash
npx shadcn add @chartory/weekly-rhythm
```

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

usage.tsx:

```tsx
import { WeeklyRhythm }
  from "@/components/chartory/weekly-rhythm"

<WeeklyRhythm
  data={weeklyRuns}
  size="m"
  legend
/>
```

## Props

### `<WeeklyRhythm>`

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

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

### WeeklyRhythmData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| rows | string[] | Required | The row labels, in order. |
| vals | number[][] | Required | The values, in order. |
| now | [number, number] | Required | Where now is: [row, column]. |
| xl | [number, string][] | Required | The x axis labels: [position, label] pairs. |

## Weekly rhythm: a React and Figma chart in four sizes

### What does a weekly rhythm show?

A weekly rhythm chart lays out a week by day and hour and shades each slot from fewer to more runs, with a marker for now. You see when work happens across the week. Use it for agent runs, jobs and traffic.

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 Weekly rhythm component?

It is one **<WeeklyRhythm>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is a share of the busiest hour (0 to 1) per weekday and hour.

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 a now marker needed?** Yes means the weekly rhythm fits.
- **Is shading enough?** Yes means the weekly rhythm fits.
- **Is it a grid, not a ring?** Yes means the weekly rhythm fits.

### When does another type fit better?

- **A plain grid.** Use Heatmap instead.
- **Dots sized by value.** Use Punch card instead.
- **Hours around a clock.** Use Radial hour heatmap instead.

## Weekly rhythm questions

### Does the Weekly rhythm 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/weekly-rhythm. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

A share of the busiest hour (0 to 1) per weekday and hour. 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/103-weekly-rhythm 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.