shadcn.io is not affiliated with official shadcn/ui
About
Turn bars sideways when the category names are long, when there are many of them, or when the list reads as a ranking. Names stay on one line and the longest bar stands out. For a time series, the vertical version reads more naturally.
Six bars with 5px corners extend from the left edge, one per month, with the month's name beside each. There's no value axis and no grid: the lengths and the tooltip carry the values.
Installation
Usage
<script lang="ts">
import ChartBarHorizontal from "@/components/charts/chart-bar-horizontal.svelte";
</script><ChartBarHorizontal />Customize
barXis the horizontal bar:x: "desktop"is the length andy: "month"the band.- The y scale is a band scale with
paddingInner(0.2)andpaddingOuter(0.1). Its axis keeps the labels and drops the line and the tick stubs. - The x scale is linear with
axis: false, so the lengths have no labels and no grid behind them. fillisvar(--color-desktop)fromchartConfig, andradius: 5rounds each bar.- The bars follow the order of
chartData. Sort the rows by value to turn the chart into a ranking.
FAQ
How are the bars turned sideways?
With barX in place of barY: the value goes on x and the category on y, and the band scale moves to the y axis. chartTooltip({ focus: "group-y" }) then focuses by row instead of by column.
How do I fit longer category names?
The y axis tick format cuts each month to three letters: drop the slice for full names. The definition fixes margin.left at 40, so widen it until they fit, or remove margin and the chart measures the labels for you.
How do I sort the bars by value?
Sort chartData before the chart reads it, for example [...chartData].sort((a, b) => b.desktop - a.desktop). The bars follow the order of the rows.
How do I print each value at the end of its bar?
Add a text mark over the same rows with x: "desktop", y: "month", anchor: "start" and a small dx, in a decorative() layer, as the Bar Chart with Custom Labels does, and leave room on the right.
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?Snippet
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
renderTooltip?Snippet<[ChartTooltipBodySnippetContext]>
A whole tooltip body of your own, in place of ChartTooltipContent: it gets the focused points (each with its datum, group and color). A snippet.
- Type
Snippet<[ChartTooltipBodySnippetContext]>
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?Snippet<[{ index, item, name, value }]>
A row's content in place of its indicator, name and value, as shadcn's formatter: a unit, a currency, a total row. A snippet.
- Type
Snippet<[{ index, item, name, value }]>
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-svelte 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 Custom Labels
Bar chartsHorizontal bars with the name inside each bar and the value after it.
Mixed Bar Chart
Bar chartsHorizontal bars, each category in a color of its own.
Bar Chart
Bar chartsOne series of rounded vertical bars, a month each.
Bar Chart with Labels
Bar chartsEach bar's value printed above it.
Radial Chart with Labels
Radial chartsRadial bars with each browser's name written at its start.
Multiple Bar Chart
Bar chartsTwo series grouped side by side for each month.