Skip to content

WaterfallChart

The P&L bridge. Essential and rare.
Implemented
Status
Implemented
Family
7 of 13
Registry
@lopifi/waterfall-chart
npx shadcn@latest add @lopifi/theme @lopifi/waterfall-chart

The component, rendering

Real data, the shipped component. Switch the theme to check the claims the spec makes below.

Preview

The four-layer spec

The P&L bridge. Essential in finance, and almost nowhere in open-source charting.

Start → increases → decreases → end, with connector lines between bars. Increases --positive, decreases --negative, subtotals neutral — and all three distinguished by position and connector, not color alone.

The most useful chart in the family: it's how you answer "why did net income change?" in one image.

Lifted verbatim from Dashboard & charts. The doc and this page are the same paragraphs, so they cannot disagree.

What lands in your repository

One component is never one file. Everything below is copied into your project, where you own it.

Files

components/ledger/waterfall-chart.tsx

Lopifi dependencies · 7
chart-primitiveschart-utilscnformat-moneymoneymoney.typestooltip
npm packages
@base-ui-components/reactclass-variance-authorityclsxtailwind-merge
Registry entry
/r/waterfall-chart.json

The whole component

No compiled bundle, no black box. This is the file the registry copies, and the file you will edit.

components/ledger/waterfall-chart.tsx
"use client";

import * as React from "react";
import { axisLabel, domainFor, niceTicks } from "@/lib/ledger/chart-utils";
import { DataTableToggle, HatchDefs } from "@/components/ledger/chart-primitives";
import { Money } from "@/components/ledger/money";

export type WaterfallStep = {
  label: string;
  /** Minor units. A `subtotal` step is an absolute position, not a delta. */
  value: number;
  kind: "start" | "increase" | "decrease" | "subtotal" | "end";
};

export interface WaterfallChartProps {
  className?: string;
  currency: string;
  height?: number;
  steps: WaterfallStep[];
  title?: string;
}

const PAD = { bottom: 48, left: 72, right: 16, top: 24 };

/**
 * The P&L bridge — how you answer "why did net income change?" in one image.
 *
 * Increases, decreases and subtotals are distinguished by position and
 * connector as well as colour, so the chart survives greyscale.
 */
export function WaterfallChart({ steps, currency, height = 300, className, title }: WaterfallChartProps) {
  const uid = React.useId().replace(/:/g, "");
  const width = 720;

  // Running positions, computed here for layout only — the caller owns the numbers.
  let running = 0;
  const bars = steps.map((s) => {
    if (s.kind === "start" || s.kind === "subtotal" || s.kind === "end") {
      const bar = { from: 0, to: s.value, ...s };
      running = s.value;
      return bar;
    }
    const from = running;
    running += s.value;
    return { from, to: running, ...s };
  });

  const allValues = bars.flatMap((b) => [b.from, b.to]);
  const { min, max } = domainFor(allValues);
  const ticks = niceTicks(min, max);
  const domainMin = Math.min(min, ticks[0]);
  const domainMax = Math.max(max, ticks[ticks.length - 1]);

  const plotW = width - PAD.left - PAD.right;
  const plotH = height - PAD.top - PAD.bottom;
  const y = (v: number) => PAD.top + plotH - ((v - domainMin) / (domainMax - domainMin || 1)) * plotH;
  const slot = plotW / bars.length;
  const barW = slot * 0.6;

  return (
    <DataTableToggle
      className={className}
      table={
        <table className="w-full text-body">
          <caption className="sr-only">{title ?? "Waterfall data"}</caption>
          <thead>
            <tr className="border-b border-border-subtle">
              <th className="py-2 text-left text-label text-text-secondary" scope="col">
                Step
              </th>
              <th className="py-2 text-right text-label text-text-secondary" scope="col">
                Amount
              </th>
              <th className="py-2 text-right text-label text-text-secondary" scope="col">
                Running
              </th>
            </tr>
          </thead>
          <tbody>
            {bars.map((b) => (
              <tr className="border-b border-border-subtle" key={b.label}>
                <th className="py-2 text-left font-normal" scope="row">
                  {b.label}
                </th>
                <td className="py-2 text-right">
                  <Money accounting value={{ amount: b.value, currency }} />
                </td>
                <td className="py-2 text-right">
                  <Money accounting value={{ amount: b.to, currency }} />
                </td>
              </tr>
            ))}
          </tbody>
        </table>
      }
    >
      <svg
        aria-label={title ?? "Waterfall chart"}
        className="w-full"
        role="img"
        style={{ height }}
        viewBox={`0 0 ${width} ${height}`}
      >
        <HatchDefs id={`hatch-${uid}`} />

        {ticks.map((t) => (
          <g key={t}>
            <line stroke="var(--border-subtle)" x1={PAD.left} x2={width - PAD.right} y1={y(t)} y2={y(t)} />
            <text
              className="numeric"
              fill="var(--text-tertiary)"
              fontSize="12"
              textAnchor="end"
              x={PAD.left - 8}
              y={y(t) + 4}
            >
              {axisLabel(t, currency)}
            </text>
          </g>
        ))}
        <line stroke="var(--border-strong)" x1={PAD.left} x2={width - PAD.right} y1={y(0)} y2={y(0)} />

        {bars.map((b, i) => {
          const x = PAD.left + i * slot + (slot - barW) / 2;
          const top = y(Math.max(b.from, b.to));
          const h = Math.max(2, Math.abs(y(b.from) - y(b.to)));
          const neutral = b.kind === "start" || b.kind === "subtotal" || b.kind === "end";
          const fill = neutral
            ? "var(--text-secondary)"
            : b.kind === "increase"
              ? "var(--positive)"
              : `url(#hatch-${uid})`;

          return (
            <g key={b.label}>
              {/* The connector is a non-chromatic cue for direction. */}
              {i > 0 ? (
                <line
                  stroke="var(--border-strong)"
                  strokeDasharray="3 3"
                  x1={PAD.left + (i - 1) * slot + (slot + barW) / 2}
                  x2={x}
                  y1={y(bars[i - 1].to)}
                  y2={y(bars[i - 1].to)}
                />
              ) : null}
              <rect
                fill={fill}
                height={h}
                rx={barW < 12 ? 0 : 4}
                stroke={b.kind === "decrease" ? "var(--negative)" : "none"}
                width={barW}
                x={x}
                y={top}
              />
              <text
                className="numeric"
                fill="var(--text-secondary)"
                fontSize="11"
                textAnchor="middle"
                x={x + barW / 2}
                y={top - 6}
              >
                {b.kind === "increase" ? "+" : b.kind === "decrease" ? "−" : ""}
                {axisLabel(Math.abs(b.value), currency)}
              </text>
              <text
                fill="var(--text-secondary)"
                fontSize="11"
                textAnchor="middle"
                x={x + barW / 2}
                y={height - 28}
              >
                {b.label.length > 14 ? `${b.label.slice(0, 13)}…` : b.label}
              </text>
            </g>
          );
        })}
      </svg>
    </DataTableToggle>
  );
}

The accounting it encodes

Concepts this component renders. Each one is defined once, in the lexicon, and used identically in the code and the copy.

Also in Dashboard & charts

See also

A component is specified in one place, defined in another, and running in a third. All three, from here.

Elsewhere in the system

Where WaterfallChart sits in the rest of the system — the live section it renders in, the calculators that compute what it displays, and the ledger payloads it is fed from.

Components are copied into your repository and meant to be edited — rounding policy, fiscal calendar and compliance copy differ per company.

Told when Dashboard & charts changes

Components are copied into your repo, so a fix here does not reach you on its own. One email when a component in this family changes in a way that needs a migration — and nothing when it does not.

One address, no list rental, unsubscribe in one click.

Works in your QuickBooks Online or Xero file

Get your books closed every month

Lopifi is building AI bookkeeping that keeps your books closed on US GAAP as transactions happen, with a CPA review every quarter, for $200 a month. We’re not open yet.

$200/month when we open. No card now.