Skip to content

shadcn.io is an independent project built on shadcn/ui

Free

Diverging bar chart

Survey answers on a Likert scale, disagreement left of the center line and agreement right. Neutral splits across the line, and the tooltip adds a net score.

Charting library: TanStack Charts

Preview

Preview width

Installation

The command adds the example above to components/charts/ and, the first time, the chart kit to components/ui/charts/. Both are source files in your project from then on: read them, change them, delete what you don't use.

Sign in to get your install command
Free with an account. It carries your token, so the CLI installs everything in one go.

Usage

One row per bar, named by yDataKey, with a count for each answer. The chart turns the counts into shares.

<script setup lang="ts">
import {
  ChartTooltip,
  DivergingBarChart,
  DivergingSegment,
  XAxis,
  YAxis,
} from "@/components/ui/charts";

// Answers from 240 employees.
const data = [
  { agree: 182, disagree: 22, neutral: 36, statement: "I know what is expected of me" },
  { agree: 126, disagree: 62, neutral: 52, statement: "I have the tools I need" },
  { agree: 100, disagree: 82, neutral: 58, statement: "Workload is sustainable" },
];
</script>

<template>
  <DivergingBarChart
    ariaLabel="Engagement survey"
    center="neutral"
    :data="data"
    y-data-key="statement"
  >
    <DivergingSegment data-key="disagree" label="Disagree" />
    <DivergingSegment data-key="neutral" label="Neutral" />
    <DivergingSegment data-key="agree" label="Agree" />
    <XAxis />
    <YAxis />
    <ChartTooltip />
  </DivergingBarChart>
</template>

Anatomy

Each DivergingSegment is one answer, written in scale order from the most negative to the most positive. The guides are the cartesian Grid, XAxis and YAxis.

<DivergingBarChart center="neutral" :data="data" y-data-key="statement">
  <Grid vertical />
  <DivergingSegment data-key="disagree" label="Disagree" />
  <DivergingSegment data-key="neutral" label="Neutral" />
  <DivergingSegment data-key="agree" label="Agree" />
  <DivergingLabels />
  <XAxis />
  <YAxis />
  <ChartTooltip />
</DivergingBarChart>
  • DivergingBarChart: One horizontal bar per row, lined up on the neutral point.
  • Grid: Vertical guides at the axis ticks.
  • DivergingSegment: One answer, read from dataKey.
  • DivergingLabels: Each segment's share inside it, where there's room.
  • XAxis: Shares, or counts, out from the center line. Both sides read as positive.
  • YAxis: Row names, cut with an ellipsis past 38% of the width.
  • ChartTooltip: The row's breakdown and its net score.

Where the center falls

Pass the neutral answer's dataKey as center and that segment is split in half across the line. Without center, an odd number of segments splits the middle one, and an even number puts the line between the two halves.

Shares or counts

By default each bar shows shares of its own row, so every bar spans 100% and the axis reads in percent. :normalize="false" plots the raw counts instead, and bar lengths then follow each row's total.

With a legend

onHoverChange reports the hovered answer's index, or null. Share one index between the chart and a ChartLegend inside ChartLegendHoverProvider, and hovering either one lights that answer in every row.

Preview width

Customization

The kit is in your project, in components/ui/charts/: your framework's components over a shared core/. Change a default there and every chart picks it up.

class goes on the chart's container, so size and spacing are utility classes.

The default tooltip lists every answer's count and share in the row, then its net score. With content, the point has the hovered series, its value and share, the row's name, its net from -1 to 1 and the whole row.

barSize sets the bar thickness as a share of its row (0.62), and radius rounds the bar ends (4 px). DivergingLabels hides a label in a segment narrower than minWidth (30 px).

<ChartTooltip>
  <template #content="{ point }">
    <TooltipContent
      :rows="[
        {
          color: String(point.color),
          label: String(point.series),
          value: `${Math.round(Number(point.share) * 100)}%`,
        },
        {
          color: 'var(--chart-positive)',
          label: 'Net score',
          value: `${Math.round(Number(point.net) * 100)} pts`,
        },
      ]"
      :title="String(point.name)"
    />
  </template>
</ChartTooltip>

Where a part renders content of its own, you pass it in. In Vue:

  • ChartTooltip: <template #content="{ point, index }">

Loading state

With status="loading", muted bars stretch out on both sides of the center line, one per row (six with no data). The grid stays, the labels become placeholders, and the pointer is ignored until "ready".

<DivergingBarChartLoading /> is the placeholder before you have any rows. It takes aspectRatio or height.

Preview width

Animation

Segments grow out from the center line, the nearest first, each row starting 60 ms after the one above. The motion is a spring, so there's no duration prop. Pass :animate="false" to skip it.

New data redraws the bars in place. With reduced motion turned on, the chart appears at once.

Theming

Every color in the kit is one of your theme's tokens or a mix of them, except --chart-positive, a fixed green. A preset or the .dark class restyles the chart, and overriding a token in your CSS changes it everywhere.

Without a fill, segments get a scale from --chart-negative to --chart-positive, strongest at the ends, with the neutral answer in --chart-foreground-muted. A fill of your own is mixed 82% into --chart-background, which keeps the share labels readable.

TokenDefaultPaints
--chart-negative--destructivevalues below the baseline in profit and loss
--chart-positivea fixed greenvalues above the baseline in profit and loss
--chart-foreground-muted--muted-foreground mixed toward --backgroundskeletons and faded marks
--chart-background--carddot halos, the gaps between stacked marks
--chart-grid--bordergrid lines
--chart-label--muted-foregroundtick labels
--chart-tooltip-background--popoverthe tooltip panel
globals.css
:root {
  --chart-background: var(--background);
  --chart-grid: var(--muted);
}

Accessibility

The chart is an image named by ariaLabel ("Diverging bar chart" by default). Name the survey and its scale there, and put the headline result, such as the best and worst net score, in ariaDescription.

Tab
Moves focus to the chart and the first answer in the top row.
Arrow Right
Moves to the next answer, then on to the next row. ArrowDown does the same.
Arrow Left
Moves back one answer. ArrowUp does the same.
Home
Jumps to the first answer in the top row.
End
Jumps to the last answer in the bottom row.

API reference

Vue takes the same props as React, in camelCase or kebab-case, with class for className. Render props are scoped slots (#content), and callbacks such as onHoverChange can be written as listeners (@hover-change).

DivergingBarChart

PropType
datareadonly Record<string, unknown>[]

One row per bar: its yDataKey names it, each DivergingSegment's dataKey is a count or value.

Type
readonly Record<string, unknown>[]
yDataKeystring

The key of each row's name.

center?string

The dataKey of the neutral segment, split across the centre line. Without one the centre falls between the first and second halves of the segments (an odd count splits its middle one).

normalize?boolean

Show each bar as shares of its row (every bar the same length) rather than raw values.

Default
true
barSize?number

The bars' thickness as a share of their row.

Default
0.62
radius?number

Corner radius of the bars' ends, in px.

Default
4
formatValue?(value: number) => string

Formats a value in the tooltip (the raw value; shares are shown beside it).

Type
(value: number) => string
onHoverChange?(index: number | null) => void

Called with the hovered segment's series index, and null when the pointer leaves (pair it with a ChartLegend).

Type
(index: number | null) => void
aspectRatio?string | number

Width over height: a number or a string such as "16 / 9".

Type
string | number
Default
"16 / 9"
height?number

A fixed height in px instead of an aspect ratio.

animate?boolean

Play the entrance: the segments grow out from the centre line, row by row.

Default
true
status?ChartStatus

"loading" draws a shimmering skeleton (muted bars split at the centre line) in place of the chart and ignores the pointer; switching to "ready" plays the entrance. Switching back to "loading" fades the chart out first.

Default
"ready"
loadingLabel?string

Text shown centered over the plot, with a shimmer, while status is "loading". Nothing is shown when it is unset or empty.

ariaLabel?string
ariaDescription?string
class?string

Extra class name for the chart's root element.

style?CSSProperties

Inline style for the chart's root element.

children?ReactNode

Carriers: ChartTooltip and the family's own.

DivergingSegment

PropType
dataKeystring

The key of its value in each row.

label?string

Its name in the tooltip and legend. Defaults to the dataKey.

fill?string

Its colour. Defaults to a diverging scheme from the theme: --chart-negative tints before the centre, a muted neutral at it, --chart-positive tints after it, strongest at the ends.

DivergingLabels

PropType
minWidth?number

Hide a label in a segment narrower than this, in px.

Default
30

Grid

PropType
horizontal?boolean

Show horizontal grid lines.

Default
true
vertical?boolean

Show vertical grid lines.

Default
false
numTicksRows?number

Number of horizontal grid lines. Ignored when rowTickValues is set.

Default
5
numTicksColumns?number

Number of vertical grid lines.

Default
10
rowTickValues?number[]

Explicit y values for the horizontal grid lines. Overrides numTicksRows.

stroke?string

Color of the grid lines.

Default
"var(--chart-grid)"
loadingStroke?string

Grid color while the chart is loading. Falls back to stroke.

strokeOpacity?number

Opacity of the grid lines.

Default
1
strokeWidth?number

Width of the grid lines in px.

Default
1
strokeDasharray?string

Dash pattern of the grid lines.

Default
"4,4"
highlightRowValues?number[]

Y values of horizontal lines drawn with the highlight styling, for example a zero baseline.

highlightRowStroke?string

Color of the highlighted rows.

Default
"var(--chart-foreground-muted)"
highlightRowStrokeOpacity?number

Opacity of the highlighted rows.

Default
1
highlightRowStrokeWidth?number

Width of the highlighted rows in px.

Default
1
highlightRowStrokeDasharray?string

Dash pattern of the highlighted rows.

Default
"0"
fadeHorizontal?boolean

Fade the horizontal lines toward transparent at the left and right edges.

Default
true
fadeVertical?boolean

Fade the vertical lines toward transparent at the top and bottom edges.

Default
false
hideHorizontalEdgeLines?boolean

Drop the first and last horizontal line (kept when two or fewer remain).

Default
false
hideVerticalEdgeLines?boolean

Drop the first and last vertical line (kept when two or fewer remain).

Default
false
shimmer?boolean

While the chart is loading, sweep a bright band across the grid.

Default
false
shimmerStroke?string

Color of the shimmer band.

Default
"color-mix(in oklch, var(--bkm-foreground) 68%, transparent)"
shimmerSpeed?number

Speed multiplier of the shimmer sweep. 2 is twice as fast.

Default
1

XAxis

PropType
numTicks?number | ResponsiveChartLabelCount

Target number of tick labels along the x axis, or one per chart width: { base, sm, md, lg, xl } takes the count of the widest breakpoint the chart reaches (640, 768, 1024 and 1280 px).

Type
number | ResponsiveChartLabelCount
Default
5
labels?readonly string[]

The tick text of each data row, in row order: it replaces the date formatting (pair it with ChartTooltip dateLabels).

tickerHalfWidth?number

Half-width in px of the zone around the date pill inside which tick labels are hidden. Line, area and composed charts widen it to the pill's half-width plus the widest tick label's, so no label sits half under the pill.

Default
50
tickMode?"domain" | "data"

Where ticks fall: "data" places them on evenly spaced data rows, "domain" places them at evenly spaced time values across the x domain.

Type
"domain" | "data"
Default
"data"
formatValue?(value: Readonly<Date>) => string

Formats a tick date into its label. Defaults to a short month and day such as "Jan 5".

Type
(value: Readonly<Date>) => string

YAxis

PropType
yAxisId?string | number

Id of the y scale this axis labels. Must match the yAxisId of the series that use it.

Type
string | number
Default
"left"
orientation?"left" | "right"

Side of the plot the axis sits on. The primary axis is on the left; additional axes default to the right.

Type
"left" | "right"
Default
"left"
numTicks?number

Target number of tick labels. The primary axis also sets the number of horizontal grid lines.

Default
5
formatLargeNumbers?boolean

Abbreviate values of 1000 and above as thousands, with one decimal where needed, for example 2k or 1.5k.

Default
true
formatValue?(value: number) => string

Formats a tick value into its label. Overrides formatLargeNumbers.

Type
(value: number) => string

ChartTooltip

PropType
showDatePill?boolean

Show the date pill that rides along the bottom of the plot.

Default
true
showCrosshair?boolean

Show the vertical crosshair line. Bar charts leave it off unless this is true (the dots and the category pill mark the bar).

Default
true
showDots?boolean

Show a dot on every series at the hovered position.

Default
true
dotVariant?"dot" | "ring"

Dot style: a filled "dot" or a transparent "ring" square. Read by BarChart only.

Type
"dot" | "ring"
Default
"dot"
dotSize?number

Dot radius in px.

Default
5
dotRadiusFraction?number

Corner radius of the "ring" variant as a fraction of its side (0 is square, 0.5 is a circle). Read by BarChart only.

Default
0.25
dotScale?number

Multiplier applied to the dot or ring size. Read by BarChart and LiveLineChart.

Default
1
dotStrokeWidth?number

Stroke width of the dots in px.

Default
2
indicatorColor?string | ((point: Record<string, unknown>) => string)

Color of the crosshair. Only a string is applied; the function form that bklit-ui accepts is ignored and the default is used.

Type
string | ((point: Record<string, unknown>) => string)
Default
"var(--chart-crosshair)"
#content?slot: { point, index }

Replaces the default tooltip panel body. Receives the hovered data row and its index; with pinnable, also whether the panel is pinned and a dismiss that unpins it (for a close button in a pinned panel's detail).

pinnable?boolean

A click (or Enter, or Space) on the chart pins the tooltip where it is: the panel takes the pointer, so its content can grow into detail and hold controls, until another click, Escape or dismiss lets it go.

Default
false
rows?(point: Record<string, unknown>) => { readonly color: string; readonly label: string; readonly value: string | number }[]

Replaces the default rows (one per series) with your own list of { color, label, value }.

Type
(point: Record<string, unknown>) => { readonly color: string; readonly label: string; readonly value: string | number }[]
dotColor?string | ((point: Record<string, unknown>, line: ChartLineConfig) => string)

Fill of the tooltip dots. A function receives the hovered row and the series config, and is called again each time the hovered row changes. Defaults to each series' color; a ProfitLossLine's dot takes the color of the hovered value's sign.

Type
string | ((point: Record<string, unknown>, line: ChartLineConfig) => string)
#default?slot

Extra content rendered below the rows in the default panel, for example marker details. Without it, a chart with ChartMarkers lists the markers on the hovered date there.

class?string

Extra class name for the tooltip panel.

springConfig?SpringConfig

Spring for the floating panel when matchCrosshair is on. Defaults to the chart's tooltip spring.

matchCrosshair?boolean

Make the floating panel follow the pointer with the same spring as the crosshair instead of damping.

Default
false
damping?number

Spring damping for the floating panel when matchCrosshair is off, on bklit's 0 to 100 scale: lower is bouncier, higher slower, 0 moves the panel instantly. The default, 20, is the snappy hover spring (stiffness 3600, damping 120); every other value is bklit's spring for it played six times faster.

Default
20
indicatorDasharray?string

Dash pattern of the crosshair. Omit for a solid line.

indicatorFadeEdges?IndicatorFadeEdges

Vertical fade of the crosshair: both ends, the top, the bottom, or none (solid).

Default
"both"
indicatorFadeLength?number

Size of the crosshair's fade, as a percentage of its height (2 to 40).

Default
10
indicatorEndColor?string

Bottom colour of the crosshair: it ramps from indicatorColor at the top to this at the bottom (composes with the fade).

indicatorEnd?"plot" | "point"

How far down the crosshair reaches: the whole plot, or down to the hovered point of the first series.

Type
"plot" | "point"
Default
"plot"
dotHaloBlur?number

Blur in px on the dots' halo, for a soft glow.

Default
0
topOffset?number

Extra gap in px between the top of the plot and the tooltip panel.

Default
0
dateLabels?readonly string[]

The date pill's text for each data row, in row order (pair it with XAxis labels).

boxSpringConfig?SpringConfig

Spring for the floating panel. Takes priority over matchCrosshair and damping.

indicatorWidth?IndicatorWidth

Thickness of the crosshair: a width in px, or "line" (1px), "thin" (2px), "medium" (4px) or "thick" (8px).

Default
"line"

DivergingBarChartLoading

PropType
aspectRatio?string | number

Width over height: a number or a string such as "2 / 1". Defaults to the chart's own.

Type
string | number
height?number

A fixed height in px instead of an aspect ratio.

label?string

Text shown centered over the skeleton, with a shimmer. Nothing is shown when it is unset or empty.

class?string

Extra CSS class name for the placeholder's root element.

Default
""

Examples

3 examples on Vue, each live with its code and its own install command.