WaterfallChart
Compare series and read the change behind them, with the axes, legend and tooltip already wired.
@luc/ui/chartsWhat it shows
Explain how signed contributions move an opening value to a closing value.
Live preview
240 + 86 + 42 − 58 − 31 = 279: the running total is arithmetically correct, and the chart only draws it.
<WaterfallChart
data={[
{ label: "Opening", value: 240, total: true },
{ label: "New", value: 86 },
{ label: "Upgrades", value: 42 },
{ label: "Churn", value: -58 },
{ label: "Downgrades", value: -31 },
{ label: "Closing", value: 279, total: true },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Movement in accounts"
/>Controls
Height
A chart measures its container, so it always needs a definite height.
State
The surface the chart is in — loading, empty and error are drawn by the component.
Accessible name
A drawing is not readable by a screen reader, so it needs a name that states what it shows.
The same fixture as the live preview above; the controls change how it is drawn, not what it measures.
Code
import { WaterfallChart } from "@luc/ui/charts";
<WaterfallChart
data={[
{ label: "Opening", value: 240, total: true },
{ label: "New", value: 86 },
{ label: "Upgrades", value: 42 },
{ label: "Churn", value: -58 },
{ label: "Downgrades", value: -31 },
{ label: "Closing", value: 279, total: true },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Movement in accounts"
state="ready"
/>Not controllable here
series / rows— The numbers are the caller's; the fixture above is the example.
Copy for an AI agentA specification an agent can act on: the import, the setup, the chosen props, the data contract and the accessibility expectation.
Implement `WaterfallChart` from Luc UI. It is: Compare series and read the change behind them, with the axes, legend and tooltip already wired.
Import it with: import { WaterfallChart } from "@luc/ui/charts";
Requires: react ^19.0.0; react-dom ^19.0.0; react-hook-form ^7.0.0 (optional, for @luc/ui/forms/react-hook-form); tailwindcss ^4.0.0; node >= 22 (repository tools). Import the stylesheet once at the app root and wrap the tree in `LucProvider`. Both come from the package that publishes @luc.
Chosen configuration: `height={340}`, `state="ready"`, `ariaLabel="Movement in accounts"`.
Accessibility: keep the component's own semantics. Do not re-implement its ARIA wiring, do not add roles it does not declare, and make sure every interactive element is reachable and operable from the keyboard with a visible focus state.
Styling: use Luc UI design tokens and the component's own props. Do not restyle with raw colour literals and do not override the component's internal structure with page CSS.
Motion: respect `prefers-reduced-motion`. The component already does, so do not disable it.
Reproduce this state:
```tsx
<WaterfallChart
data={[
{ label: "Opening", value: 240, total: true },
{ label: "New", value: 86 },
{ label: "Upgrades", value: 42 },
{ label: "Churn", value: -58 },
{ label: "Downgrades", value: -31 },
{ label: "Closing", value: 279, total: true },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Movement in accounts"
state="ready"
/>
```Usage
The values are prepared by the caller: this component draws the points it is given and computes no statistic of its own, so units, scaling and any summary have to be settled before the data reaches it.
It is drawn by the ECharts engine.
Worked examples with real data are on the family overview: General
import { WaterfallChart } from "@luc/ui/charts";<WaterfallChart
data={[
{ label: "Opening", value: 240, total: true },
{ label: "New", value: 86 },
{ label: "Upgrades", value: 42 },
{ label: "Churn", value: -58 },
{ label: "Downgrades", value: -31 },
{ label: "Closing", value: 279, total: true },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Movement in accounts"
/>Data contract
`data` rows contain `label` and signed `value`; rows marked `total: true` are placed as running totals. The chart does not reconcile the arithmetic.
Important configuration
Mark opening and closing rows with `total`, use `format` for the currency or count, and keep contribution order identical to the business explanation.
Guidelines
When not to use
Do not use a waterfall when the contributions are not additive or when the stated closing total cannot be obtained from the supplied rows.
Configuration
| Export | Kind | Signature |
|---|---|---|
WaterfallChart | 12 documented props | ({ data, format, orientation, title, description, state, height, className, ariaLabel, ariaDescription, onReady, onEvent, }: WaterfallChartProps) => import("@types/react").JSX.Element |
WaterfallChart props
Type: WaterfallChartProps
Values the compiler reads from the declaration.
| Prop | Type | Default | Notes |
|---|---|---|---|
ariaDescription? | string | undefined | — | |
ariaLabel? | string | undefined | — | |
className? | string | undefined | — | |
data | readonly WaterfallItem[] | — | |
description? | string | undefined | — | |
format? | ChartFormat | undefined | — | |
height? | string | number | undefined | — | |
onEvent? | ((event: EChartEvent) => void) | undefined | — | |
onReady? | ((chart: EChartsInstance) => void) | undefined | — | |
orientation? | "horizontal" | "vertical" | undefined | — | Horizontal waterfalls are the readable choice past ~10 steps. |
state? | ChartState | undefined | — | |
title? | string | undefined | — |
Accessibility
A chart is a picture of data, so it needs a name that states what it shows, and the numbers must exist as text somewhere on the page — in a table or a written summary — because a drawing is not readable by a screen reader and cannot be copied.
What happens on the server, and when hydration changes it.
Family
General
The shapes every product needs, on the declarative ChartSpec path.
Related