shadcn.io is not affiliated with official shadcn/ui
About
Pick it when the question is direction: is the metric going up, down or nowhere. A line uses less ink than an area, so it suits small cards and pages with several charts. Add the dots version when each month is a reading people should see, or a bar chart when they compare months.
A smooth curve runs through six monthly values, with horizontal grid lines behind it and three-letter months underneath. There's no value axis and no fill, and the tooltip shows the value without the month above it.
Installation
Usage
<script setup lang="ts">
import ChartLineSimple from "@/components/charts/chart-line-simple.vue";
</script><template>
<ChartLineSimple />
</template>Customize
- One row per month,
{ month, desktop }.lineYreadsx: "month"andy: "desktop"; rename both to plot your own fields. - The line's
strokeisvar(--color-desktop), whichChartContainersets fromchartConfig.desktop(var(--chart-1)).strokeWidth: 2matches shadcn/ui's weight. - The
curveoption gives the natural shape. Leave it out andlineYdraws straight segments, which is the linear version. - The y scale is
chartLinearScale, Recharts' domain and ticks (0 to 320 here), withgrid: trueandaxis: false. To fix its range, pass a configured scale such asscaleLinear().domain([0, 400]). chartTooltip({ focusRing: true })turns on focus by month and an active dot on the focused point;ChartContainer'stooltipprop passes{ hideLabel: true }, so the tooltip shows the value alone.
FAQ
How do I make the line thicker or dashed?
strokeWidth on lineY sets the weight, 2 here. strokeDasharray: "4 4" dashes it, a common way to set a forecast apart from measured months.
Should I use this or the area chart?
Use the line when the direction matters and the chart sits next to others: it adds the least ink. Use the area when the amount matters, since the fill reads as volume. Both take the same { month, desktop } rows, so switching means swapping lineY for areaY.
Why doesn't the tooltip show the month?
ChartContainer's tooltip prop sets hideLabel: true, as shadcn/ui's example does: the month is already printed under the point. Remove it and the tooltip shows the month above the value.
How do I plot dates instead of month names?
Put a date string in each row and keep x on it. Format the labels with the x axis's ticks: { format } and thin them with tickLabels: { thin: { minGap: 32 } }, as the interactive line chart does for its Apr 10 labels; ticks: { values } picks exact dates instead.
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
Linear Line Chart
Line chartsStraight segments between points, no smoothing.
Line Chart with Dots
Line chartsA line with a dot on every data point.
Multiple Line Chart
Line chartsTwo series as lines on the same axes.
Area Chart
Area chartsOne series as a smooth filled curve over six months.
Bar Chart
Bar chartsOne series of rounded vertical bars, a month each.
Step Line Chart
Line chartsA stepped line for values that hold until they change.