# WeekStrip

Seven columns with the series stacked inside each and the current day in bold, for a week at a glance.

- **Use it for**: A week of counts, stacked by kind, with a goal.
- **Not for**: More than a couple of weeks. Try [Chart](https://unseenui.com/components/chart/).

## Installation

```bash
npm install @stackunseen/ui
```

## Usage

```tsx
import { WeekStrip } from '@stackunseen/ui';
import { Stat, Progress } from '@stackunseen/ui';
import '@stackunseen/ui/styles.css';

<WeekStrip label="This week" days={week} series={[{ id: "summarize", label: "Summarize" }, { id: "rewrite", label: "Rewrite", swatch: "var(--ai-secondary)" }]} current={4} />
```

## All props

| Prop | Type | Description |
| --- | --- | --- |
| `current` | `number` | Index of the current day, printed in bold. |
| `days` (required) | `readonly WeekStripDay[]` | Seven days, or any short run of columns. |
| `label` (required) | `string` | Names the figure for assistive technology and the hidden table. |
| `legend` | `boolean` | Hide the series legend when the card prints its own. |
| `max` | `number` | The total that fills a column; defaults to the largest day total. |
| `series` (required) | `readonly WeekStripSeries[]` |  |
| `unit` | `string` | Unit for the hidden table, such as "runs". |

## Keyboard

Inert content; the hidden table is read in order.

## Works with

[Card](https://unseenui.com/components/card/), [Table](https://unseenui.com/components/table/), [Tag](https://unseenui.com/components/tag/), [DiffStat](https://unseenui.com/components/diff-stat/), [ElapsedTime](https://unseenui.com/components/elapsed-time/), [Numeric](https://unseenui.com/components/numeric/), [Kbd](https://unseenui.com/components/kbd/), [DotRing](https://unseenui.com/components/dot-ring/), [DotBars](https://unseenui.com/components/dot-bars/), [HeatKeys](https://unseenui.com/components/heat-keys/), [Sparkline](https://unseenui.com/components/sparkline/), [BarList](https://unseenui.com/components/bar-list/)

Page: https://unseenui.com/components/week-strip/