FunnelChart
Compare series and read the change behind them, with the axes, legend and tooltip already wired.
@luc/ui/chartsWhat it shows
Show an ordered conversion process in which each stage is expected to retain no more than the stage before it.
Live preview
Stages in order, each count smaller than the last; nothing is aggregated by the chart.
<FunnelChart
data={[
{ name: "Visit", value: 980 },
{ name: "Signup", value: 384 },
{ name: "Trial", value: 212 },
{ name: "Paid", value: 96 },
{ name: "Renewed", value: 61 },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Signup funnel"
/>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 { FunnelChart } from "@luc/ui/charts";
<FunnelChart
data={[
{ name: "Visit", value: 980 },
{ name: "Signup", value: 384 },
{ name: "Trial", value: 212 },
{ name: "Paid", value: 96 },
{ name: "Renewed", value: 61 },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Signup funnel"
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 `FunnelChart` 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 { FunnelChart } 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="Signup funnel"`.
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
<FunnelChart
data={[
{ name: "Visit", value: 980 },
{ name: "Signup", value: 384 },
{ name: "Trial", value: 212 },
{ name: "Paid", value: 96 },
{ name: "Renewed", value: 61 },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Signup funnel"
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 { FunnelChart } from "@luc/ui/charts";<FunnelChart
data={[
{ name: "Visit", value: 980 },
{ name: "Signup", value: 384 },
{ name: "Trial", value: 212 },
{ name: "Paid", value: 96 },
{ name: "Renewed", value: 61 },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Signup funnel"
/>Data contract
`data` rows are ordered `{ name, value }` stage counts. The component draws the supplied stages and does not aggregate or infer conversions.
Important configuration
Keep the stage order explicit in the array, format counts with `format`, and provide the conversion context in the surrounding caption.
Guidelines
When not to use
Do not use a funnel for unordered categories or for stages that can legitimately increase; the narrowing shape would assert a process the data does not have.
Configuration
| Export | Kind | Signature |
|---|---|---|
FunnelChart | 12 documented props | ({ data, format, showValues, title, description, state, height, className, ariaLabel, ariaDescription, onReady, onEvent, }: FunnelChartProps) => import("@types/react").JSX.Element |
FunnelChart props
Type: FunnelChartProps
Values the compiler reads from the declaration.
| Prop | Type | Default | Notes |
|---|---|---|---|
ariaDescription? | string | undefined | — | |
ariaLabel? | string | undefined | — | |
className? | string | undefined | — | |
data | readonly CategoryValue[] | — | |
description? | string | undefined | — | |
format? | ChartFormat | undefined | — | |
height? | string | number | undefined | — | |
onEvent? | ((event: EChartEvent) => void) | undefined | — | |
onReady? | ((chart: EChartsInstance) => void) | undefined | — | |
showValues? | boolean | undefined | — | Value printed next to each stage name inside the funnel. |
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