Skip to content
shadcn.io

shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Bar Chart with Negative Values

Monthly bars above and below zero, colored by their sign and labeled with the month. For gains and losses, or any value that swings, in Vue.

Framework
Charting library

Preview

Preview width

About

Use it for values that cross zero: profit and loss, change from last month, a net score. The baseline splits up from down and the color says it twice. When nothing goes below zero, the plain bar chart is enough.

Six square bars rise from or drop below zero. Positive months use the first chart color and the two negative months the second, and each bar carries its month's name at its outer end. There are no axes, only grid lines.

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 ChartBarNegative from "@/components/charts/chart-bar-negative.vue";
</script>
<template>
  <ChartBarNegative />
</template>

Customize

  • The rows are { month, visitors }, two of them negative. The y scale reads its domain from the bars, so it reaches below zero without any setting.
  • fill is a function of the row: var(--chart-1) for positive values, var(--chart-2) below zero.
  • A decorative text mark writes the month at each bar's end in the bar's color, with a dy that depends on the sign: above positive bars, below negative ones.
  • Both scales set axis: false and the y scale keeps grid: true. chartConfig only labels visitors, since the colors come from the sign.
  • The tooltip sets hideLabel and hideIndicator: the value and its label, nothing else.

FAQ

How are the bars colored by sign?

fill takes a function of the row, signColor: it returns var(--chart-1) when visitors is positive and var(--chart-2) when it's below zero, and the labels use it too. Return any color, or a third one for zero.

How do I draw a line at zero?

Add ruleY([0], { stroke: "var(--border)" }) to the marks. It draws one horizontal rule at zero across the plot.

How do I center zero in the chart?

Give the y scale an instance with its own domain in place of the chartLinearScale factory: take the largest absolute value and use [-max, max], such as scale: scaleLinear().domain([-250, 250]). Zero then sits in the middle.

Where do the labels go on negative bars?

Below them. The text mark's dy is a function of the row: negative for a positive bar, positive for a negative one, so every label clears its bar's end.

Does the chart rely on color alone?

No, and you don't have to: the direction of each bar already says its sign, and the color repeats it. If you switch to red and green, keep that cue and check the pair for color-blind readers.

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