shadcn.io is not affiliated with official shadcn/ui
About
Pick it for a compact ranked list in a card: no axes to read, the name and the number sit on the bar itself. Short names suit it, since each one has to fit inside its bar. For long names, the plain horizontal chart keeps them beside the bars.
Six bars run to the right with 4px corners and faint vertical grid lines behind them. Each shows its month in the background color at the start, and its value in the foreground color just past the end.
Installation
Usage
import { ChartBarLabelCustom } from "@/components/charts/chart-bar-label-custom";<ChartBarLabelCustom />Customize
- Three marks share the rows:
barXdraws the bars, onetextmark writes the month atx: () => 0, another the value atx: "desktop". The labels sit indecorative()layers, so the pointer reads only the bars. - Both labels use
anchor: "start"anddx: 8, so the month starts 8px inside the bar and the value 8px past its end. - The month fills with
var(--color-label)(chartConfig.label, set tovar(--background)) to read on the bar, the value withvar(--foreground). - Both scales set
axis: false; the x scale keepsgrid: truefor the vertical guides, and a rightmarginleaves room for the values. - The bars fill with
var(--color-desktop), and the tooltip marks the series with thelineindicator.
FAQ
How do the month names stay readable on the bars?
They fill with var(--color-label), which chartConfig.label sets to var(--background), the page color: it stands out against a --chart-N bar in light and dark mode. Check the contrast if you switch to a light bar color.
What if a name doesn't fit inside its bar?
A short bar can't hold a long name: the text runs past its end and into the value. Make the text channel a function that shortens the names, or move them beside the bars as the Horizontal Bar Chart does.
How do I make room for longer values?
The values are drawn past the bar's end, outside the plot. Widen the right side of the definition's margin until the longest one fits.
Can I add a third label, such as a share?
Yes. Add another text mark over the same rows with its own x, anchor and dx. Marks paint in array order, so put it last to keep it on top.
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.
children?JSX.Element
What sits under the chart inside the container: a ChartLegend.
tooltip?ChartTooltipContentProps | false
ChartTooltipContent's props (indicator, hideLabel, formatter…) for the default body, or false for TanStack's own tooltip body.
- Type
ChartTooltipContentProps | false
renderTooltip?(context: ChartTooltipBodyRenderContext) => JSX.Element
A whole tooltip body of your own, in place of ChartTooltipContent: it gets the focused points (each with its datum, group and color). Read the context's fields in JSX (context.points), so Solid tracks them.
- Type
(context: ChartTooltipBodyRenderContext) => JSX.Element
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.
onFocusChange?(point: ChartPoint | null) => void
Called as the focused point changes: a pointer, a key or a tap.
- Type
(point: ChartPoint | null) => void
onFocusGroupChange?(points: readonly ChartPoint[]) => void
Called with every point at the focused category (a stacked or grouped chart's).
- Type
(points: readonly ChartPoint[]) => void
onSelect?(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?(value: number | string, name: string, item: ChartTooltipItem, index: number) => JSX.Element
A row's content in place of its indicator, name and value, as shadcn's formatter: a unit, a currency, a total row.
- Type
(value: number | string, name: string, item: ChartTooltipItem, index: number) => JSX.Element
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-solid 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
Horizontal Bar Chart
Bar chartsHorizontal bars with the categories down the side.
Bar Chart with Labels
Bar chartsEach bar's value printed above it.
Mixed Bar Chart
Bar chartsHorizontal bars, each category in a color of its own.
Line Chart with Custom Labels
Line chartsEach point labeled with its category's name, in its color.
Pie Chart with Custom Labels
Pie chartsSlice labels drawn outside the pie in the foreground color.
Bar Chart
Bar chartsOne series of rounded vertical bars, a month each.