# Candlestick

> Open, high, low and close, per period. Sample data: spot price in four-hour candles, Sep 30 to Oct 9.

- Type 036 · Change over time
- Component: `<Candlestick>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/candlestick` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/candlestick

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

```bash
npx shadcn add @chartory/candlestick
```

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

usage.tsx:

```tsx
import { Candlestick }
  from "@/components/chartory/candlestick"

<Candlestick
  data={fourHourCandles}
  size="m"
/>
```

## Props

### `<Candlestick>`

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

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

### CandlestickData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| c | [number, number, number, number, number][] | Required | One candle per period: [open, high, low, close, volume]. |
| min | number | Required | The bottom of the value scale. |
| max | number | Required | The top of the value scale. |
| ticks | string[] | Required | The axis tick labels. |
| xl | Record<number, string> | Required | The x axis labels, by index. |
| vmax | number | Required | The top of the volume scale. |

## Candlestick chart: a React and Figma chart in four sizes

### What does a candlestick chart show?

A candlestick chart draws each period as a body from open to close with wicks to the high and low. Up periods and down periods take different colours. Use it for prices where the range inside each day matters as much as the close.

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 Candlestick component?

It is one **<Candlestick>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is open, high, low, close and volume per period.

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?

- **Do open, high, low and close matter?** Yes means the candlestick fits.
- **Is time spaced evenly?** Yes means the candlestick fits.
- **Is it the price itself?** Yes means the candlestick fits.

### When does another type fit better?

- **One value per period is enough.** Use Area chart instead.
- **Only moves of a set size count.** Use Renko instead.
- **The depth of the order book.** Use Order book depth instead.

## Candlestick questions

### Does the Candlestick 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/candlestick. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

Open, high, low, close and volume per period. 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/036-candlestick 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.