# Returns Calendar

> A monthly returns heatmap for funds, strategies and backtests, with a compounded yearly column and spans you select to compound returns.

A React component for shadcn/ui and Tailwind CSS, from ssych ui (https://ssych.com). Free, MIT licensed, the source lands in your repo.

## Install

```bash
npx shadcn@latest add @ssych/returns-calendar
```

npm dependencies: clsx, motion, tailwind-merge

## Props

`<ReturnsCalendar />`

- `title?`: `string`
- `hint?`: `string`
- `years?`: `number[]`
- `returns?`: `number[][]`

## Where it belongs

- Calendars: React calendar heatmap components: a contribution style heat calendar and a monthly returns calendar for performance data. (https://ssych.com/library/s/calendar)

## Related

- Heat Calendar: https://ssych.com/library/heat-calendar.md

## Links

- Live preview and code: https://ssych.com/library/returns-calendar
- Source: https://github.com/savvasicevs/ssych-ui
- All components: https://ssych.com/llms-full.txt
