Skip to content
shadcn.io

shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Area Chart

One series as a smooth filled curve across six months: the plainest way to show a single metric's trend in Vue, drawn with TanStack Charts.

Framework
Charting library

Preview

Preview width

About

Reach for it when one number moves over time and the shape matters more than each value: visitors, revenue, signups. With two series, the stacked or gradient versions read better. When people compare exact months, a bar chart is easier.

The curve passes through six monthly values with a 40% fill under a solid edge. The month axis keeps only its labels, cut to three letters, and the value axis only its grid lines, so the shape carries the chart.

Installation

Sign in to get your install command
Free with an account. It carries your token, so the CLI installs everything in one go.
GoogleGitHub
Use email insteadNo credit card

Usage

<script setup lang="ts">
import ChartAreaSimple from "@/components/charts/chart-area-simple.vue";
</script>
<template>
  <ChartAreaSimple />
</template>

Customize

  • The data is one row per month, { month, desktop }. areaY reads x: "month" and y: "desktop", and so does the decorative lineY that draws the edge; point both at your own fields.
  • chartConfig.desktop sets the label and var(--chart-1). The area's fill and the edge's stroke are var(--color-desktop), the variable ChartContainer writes from that entry.
  • curve: d3Curve(curveNatural) on both marks draws the natural curve. Drop it for straight segments or pass d3Curve(curveStep).
  • fillOpacity: 0.4 keeps the grid visible through the fill. The y scale draws its grid (grid: true) and no axis (axis: false).
  • ChartContainer is aspect-video by default and the chart follows its width. For a fixed height, add aspect-auto h-[250px] to its class.

FAQ

How do I change the area's color?

Change color in chartConfig.desktop, to another --chart-N token or any CSS color. The area's fill and the line on its edge both paint with var(--color-desktop), so both follow. For a different color in dark mode, give the entry theme: { light, dark } instead.

How do I change the curve?

Change curve on areaY and on the decorative lineY that draws its edge. d3Curve(curveNatural) passes through every point and bends smoothly between them. Remove curve for straight segments, as the linear version does, or pass d3Curve(curveStep) to hold each value flat between months.

How do I plot my own data?

Replace chartData with your rows and point both marks at your fields: x for the category or date, y for the value. Rename the desktop key in chartConfig, the area's id and the var(--color-desktop) paints to match: the tooltip looks the label up by the mark's id.

How do I show the values on the side?

The y scale has axis: false and grid: true: grid lines, no labels. Replace axis: false with axis: { line: false, ticks: { size: 0 } } and the value labels come back without a line or tick stubs, then widen the margin's left so they fit (40 in the Area Chart with Axes).

What does the tooltip show?

The hovered month and its value, marked with a line in the series color: ChartContainer's tooltip prop passes { indicator: "line" } to ChartTooltipContent. Focus snaps to the nearest month, so the pointer doesn't need to touch the curve, and chartTooltip({ focusRing: true }) puts a dot on the focused point.

Can I read it with the keyboard?

Yes. Tab into the chart and the arrow keys move from month to month, with the tooltip following and read out as a live region. The chart is named by its card title through ariaLabel.

API Reference

ChartContainer

<div> data-slot="chart"

PropType
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.

EventType
@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
CSS variableType
--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>

PropType
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>

PropType
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

KeyType
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

ExportType
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 }
All 70 charts