Skip to content
shadcn.io

shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Area Chart with Icons

Stacked areas whose legend shows a lucide icon beside each series instead of a color square, set once in the chart's config. For Vue.

Framework
Charting library

Preview

Preview width

About

Icons help when the series are things people recognize at a glance (devices, channels, teams) or when the legend has to work without telling colors apart. If a color key is enough, the Area Chart with Legend is lighter.

The bands are the stacked area's, mobile under desktop. The legend under the plot shows a trending-up icon for mobile and a trending-down one for desktop, and the tooltip uses the same icons in place of its color marks.

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 ChartAreaIcons from "@/components/charts/chart-area-icons.vue";
</script>
<template>
  <ChartAreaIcons />
</template>

Customize

  • Each chartConfig entry has an icon: lucide's TrendingDown for desktop and TrendingUp for mobile.
  • ChartLegend draws the icon in place of the swatch when an entry has one; hideIcon brings the swatches back.
  • ChartTooltipContent reads the same icon, so each tooltip row starts with it instead of the line indicator.
  • The marks don't change: one areaY with z, stacked mobile under desktop, painted with var(--color-<key>).

FAQ

How do I give a series an icon?

Import the icon from your framework's lucide package and set it as icon on the series' chartConfig entry, next to its label and color. The legend and the tooltip pick it up; nothing else changes.

Why does the tooltip show the icons too?

Both read icon from the same config, and ChartTooltipContent draws it where the color mark would go. To keep icons in the legend only, pass ChartLegend its own config with icons and leave them out of the container's.

Can the icons take the series color?

The legend draws them in muted-foreground at size-3, so the label carries the meaning. To color one, set icon to a small component of your own that renders the lucide icon with its color set to var(--color-mobile).

Can the legend show only icons?

Not with a prop: ChartLegend always prints the label. Copy its markup into your own component and drop the text, but give each icon an aria-label, or the legend means nothing to a screen reader.

How do I go back to color squares in the legend?

Set hideIcon on ChartLegend and the legend goes back to color squares while the tooltip keeps the icons.

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