shadcn.io is not affiliated with official shadcn/ui
About
Pick it when people compare separate periods or categories and the heights matter: one month's sales against the next. For the shape of a trend, an area or line chart says more. For two series, the multiple or stacked versions keep them together.
Each month is one bar with 8px rounded corners, over horizontal grid lines. The month labels sit under the bars, cut to three letters, with no axis line and no value axis. The tooltip shows the value without the month.
Installation
Usage
<script setup lang="ts">
import ChartBarSimple from "@/components/charts/chart-bar-simple.vue";
</script><template>
<ChartBarSimple />
</template>Customize
- The data is one row per month,
{ month, desktop }.barYreadsx: "month"for the band andy: "desktop"for the height. fillisvar(--color-desktop), fromchartConfig.desktopand itsvar(--chart-1).radius: 8rounds every corner.- The x scale is a band scale with
paddingInner(0.2)andpaddingOuter(0.1). Raise the inner padding for thinner bars, or cap them with the mark'smaxThickness. - The y scale draws
grid: truewithaxis: false. The x axis keeps its labels withticks: { size: 0, padding: 10 }and aformatthat cuts each month to three letters. ChartContainer'stooltipprop passes{ hideLabel: true }, so the tooltip shows the series and value alone.
FAQ
How do I change the bar corners?
Set radius on barY: one number rounds every corner, a tuple [topLeft, topRight, bottomRight, bottomLeft] rounds them one by one, and { end: 8 } rounds only the end the value points to. 0 gives square bars.
How do I make the bars thinner or wider?
Bars fill the band the x scale gives each month, minus its padding. Raise the band scale's paddingInner for more space between them, or set maxThickness on barY to cap their width in pixels as the chart grows.
How do I show the values on the side?
The y scale sets axis: false. Replace it with axis: { line: false, ticks: { size: 0 } } to print the values without tick stubs, and widen the definition's left margin so they fit.
How do I plot my own categories?
Replace chartData with your rows and point x and y at your fields. The band scale keeps the order of the rows, so sort them first if order matters, and rename the desktop entry in chartConfig to your value's key.
API Reference
ChartContainer
<div> data-slot="chart"
configChartConfig
Each series' label, icon and color, read by the tooltip and the legend.
definitionChartDefinition
The chart: defineChart(spec, chartTooltip()), its data, marks, scales and axes, and the tooltip's focus.
ariaLabelstring
The chart's accessible name: the card's title.
ariaDescription?string
The chart's accessible description.
class?string
The container's size: aspect-auto h-[250px] w-full, mx-auto aspect-square max-h-[250px]. It's aspect-video by default.
#default?slot
What sits under the chart inside the container: a ChartLegend.
tooltip?(ChartTooltipContentOptions & { class?: string }) | false
ChartTooltipContent's options (indicator, hideLabel, labelFormatter…) for the default body, or false for TanStack's own tooltip body.
- Type
(ChartTooltipContentOptions & { class?: string }) | false
#tooltip?slot (ChartTooltipBodySlotContext)
A whole tooltip body of your own, in place of ChartTooltipContent: it gets the focused points (each with its datum, group and color). A scoped slot.
- Type
slot (ChartTooltipBodySlotContext)
defaultIndex?number
The category whose tooltip shows before any pointer, as Recharts' defaultIndex.
height?number
A fixed height in pixels for the chart, in place of the container's.
aspectRatio?number
A width-to-height ratio for the chart, in place of the container's height.
initialWidth?number
The width the chart renders at before it's measured.
@focus-change?(point: ChartPoint | null) => void
Called as the focused point changes: a pointer, a key or a tap.
- Type
(point: ChartPoint | null) => void
@focus-group-change?(points: readonly ChartPoint[]) => void
Called with every point at the focused category (a stacked or grouped chart's).
- Type
(points: readonly ChartPoint[]) => void
@select?(point: ChartPoint | null) => void
Called when a point is clicked or picked with Enter.
- Type
(point: ChartPoint | null) => void
--color-<key>?color
Each config key's color (its theme color in light and dark), set on the container: the marks paint with var(--color-<key>).
ChartTooltipContent
<div>
pointsreadonly ChartPoint[]
The focused points, from the tooltip's context. ChartContainer passes them to its default body; a body of your own passes its context's.
indicator?"dot" | "line" | "dashed"
The indicator's shape beside each row.
- Type
"dot" | "line" | "dashed"- Default
"dot"
hideLabel?boolean
Hides the label above the rows (the focused category).
- Default
false
hideIndicator?boolean
Hides each row's color indicator.
- Default
false
label?string
The label's text in place of the focused category, looked up in config.
labelKey?string
The datum field (or config key) the label is read from, looked up in config.
nameKey?string
The datum field (or config key) each row's series is read from: a pie's browser.
valueKey?string
The datum field each row's value is read from, for points that carry geometry rather than values (a pie's, from pie()).
color?string
One indicator color for every row, in place of each series' own.
labelFormatter?(label: string, points: readonly ChartPoint[]) => string
Formats the label (the config's label or the category), with the rows' points: a date written out, a unit.
- Type
(label: string, points: readonly ChartPoint[]) => string
#formatter?slot ({ value, item, index })
A row's content in place of its indicator, name and value, as shadcn's formatter: a unit, a currency, a total row. A scoped slot; the row's series key is item.key.
class?string
Classes for the tooltip's card.
ChartLegend
<div>
config?ChartConfig
The series to list: the container's config by default.
keys?readonly string[]
The series keys to list, in order: every key with a color by default.
hideIcon?boolean
Hides each series' icon (from config), leaving its color swatch.
- Default
false
verticalAlign?"top" | "bottom"
Above the chart or under it.
- Type
"top" | "bottom"- Default
"bottom"
class?string
Classes for the legend's row.
ChartConfig
label?string
The series' name in the tooltip and the legend.
icon?Component
An icon beside its name in the legend and the tooltip (a lucide-vue-next icon).
color?string
Its color in both themes: a token (var(--chart-1)) or any CSS color.
theme?{ light: string; dark: string }
A color for each theme, in place of color.
Helpers
chartTooltip?(settings?: ChartTooltipSettings) => ChartDefinitionOptions
defineChart's second argument for a chart with a tooltip: what a pointer or a key focuses (group-x, each category's series, by default), the focus ring, and the host ChartContainer draws its body in.
- Type
(settings?: ChartTooltipSettings) => ChartDefinitionOptions
chartTheme?ChartTheme
defineChart's theme in the site's tokens: the text, the grid and the palette (--chart-1 to --chart-5).
chartColors?(config: ChartConfig, keys?: readonly string[]) => { domain: string[]; range: string[] }
defineChart's color: each series key (in config order, or keys') painted var(--color-<key>), for marks with a color channel.
- Type
(config: ChartConfig, keys?: readonly string[]) => { domain: string[]; range: string[] }
chartLinearScale?() => LinearScale
A value axis drawn as Recharts draws its default one: zero in the domain, five nice ticks. Pass it as a factory: y: { scale: chartLinearScale }.
- Type
() => LinearScale
curveNatural?CurveFactory
D3's natural curve, for a smooth line or area: curve: d3Curve(curveNatural).
curveStep?CurveFactory
D3's step curve, for a line or area that holds each value: curve: d3Curve(curveStep).
curveMonotoneX?CurveFactory
D3's monotone curve, smooth without overshooting a point: curve: d3Curve(curveMonotoneX).
curveLinearClosed?CurveFactory
D3's closed linear curve: a radar's polygon (curve: curveLinearClosed on radialLine and radialArea).
useChart?() => { config: ChartConfig }
The config of the ChartContainer around a component of your own (a custom tooltip body or legend).
- Type
() => { config: ChartConfig }
Related
Bar Chart with Labels
Bar chartsEach bar's value printed above it.
Horizontal Bar Chart
Bar chartsHorizontal bars with the categories down the side.
Multiple Bar Chart
Bar chartsTwo series grouped side by side for each month.
Bar Chart with Active Bar
Bar chartsOne bar drawn as active, outlined and dashed, the rest plain.
Area Chart
Area chartsOne series as a smooth filled curve over six months.
Line Chart
Line chartsOne series as a smooth line over six months.