Funnel chart

Usage

Import the component and the stylesheet once. See Getting started to install the package.

import { FunnelChartCard } from '@lilt-ui/charts';
import '@lilt-ui/charts/styles.css';

<FunnelChartCard
  title="Sign-up funnel"
  data={signupFunnel}
  category="stage"
  value="people"
/>

Omit title to leave out the visible title. Set header={false} to remove the whole header, and use aria-label to name a chart inside your own card. legend={false} removes the legend independently. surface="ghost" controls only the visual frame. See Card composition.

Data

Rows are stages in order: category names each one and value counts who reached it; TypeScript rejects anything else. Every percentage is a share of the first stage, and the headline is the first stage’s count. A stage that is null says “No data” and draws no band. A later stage with more people than an earlier one shows an error, because a funnel can only narrow.

// One row per stage, in funnel order. Counts only stay level or fall.
const signupFunnel = [
  { stage: 'Link opened', people: 197 },
  { stage: 'Started', people: 110 },
  { stage: 'Completed', people: 77 },
  { stage: 'Converted', people: 38 },
];

<FunnelChartCard
  title="Sign-up funnel"
  data={signupFunnel}
  category="stage" // a text field
  value="people"   // a numeric field
/>

For a working period select, pass ranges. Each range brings its own data and delta.

<FunnelChartCard
  title="Sign-up funnel"
  category="stage"
  value="people"
  ranges={[
    { id: 'week', label: 'Last 7 days', data: lastWeek, delta: 0.052 },
    { id: 'month', label: 'Last 30 days', data: lastMonth, delta: 0.031 },
  ]}
/>

Comparative funnel

Two cohorts pass through the same stages on one absolute scale. Every stage reports its count and conversion from its own entry cohort. All three loading styles share the skeleton exit, entrance, pointer/keyboard pinning, touch glide, reduced motion, and accessible readings table. Aggregate marks report null as their original datum.

import { ComparativeFunnelCard } from '@lilt-ui/charts';

<ComparativeFunnelCard
  title="Onboarding conversion"
  data={cohortConversion}
  stage="stage"
  cohorts={[
    { "key": "experiment", "label": "Experiment" },
    { "key": "control", "label": "Control" },
  ]}
/>

Prop	Type	Description
`title`	`string`	Optional visible title. Omit to render no title. Also supplies the accessible name unless aria-label is set.
`header`	`boolean`	Defaults to true. False removes the whole header: title, headline, delta and period controls, with no reserved space. Pass data directly when your app owns period selection.
`aria-label`	`string`	Accessible chart name, independent of the visible title. Falls back to title, then a generic chart name.
`data`	`Row[]`	One row per observation. Omit when using ranges.
`height`	`number`	Minimum plot height, default 260. Dense lanes expand to keep every mark visible.
`depth`	`boolean`	Lit tiles, solid bars, or spheres. Data positions remain exact; loading keeps the same depth treatment.
`color`	`string`	Override the palette with one CSS color.
`aggregate`	`'sum' \| 'mean' \| 'max'`	Resting headline summary; Strip defaults to mean, the others to sum.
`headline`	`number`	Override the resting headline.
`delta`	`number`	Fractional change shown alongside the headline.
`deltaTone`	`'default' \| 'inverse' \| 'neutral'`	Use inverse when a decrease is good.
`range`	`string`	Static period label.
`ranges`	`{ id, label, data, headline?, delta? }[]`	Period choices with their own data.
`defaultRange`	`string`	Initial period id.
`locale`	`string`	Locale for numbers and dates; defaults to en-US.
`formatValue`	`(value: number) => string`	Custom value formatter.
`badge`	`ReactNode`	Content for the glass tab above the card.
`className`	`string`	Class on the card frame.
`style`	`CSSProperties \| ChartStyle`	Inline styles and scoped chart variables.
`onSelectionChange`	`(selection \| null) => void`	Reports id, original row (or null for an absent day), value, and pinned state.
`renderReadout`	`(selection \| null) => ReactNode`	Consumer-owned readout, including when the header is hidden.
`valueFormat`	`Intl.NumberFormatOptions`	Formats the headline, tiles, and axis, e.g. currency.
`surface`	`'elevated' \| 'outline' \| 'ghost'`	Card treatment. Ghost removes the visual frame only; header and legend are independent controls.
`palette`	`'iris' \| 'cobalt' \| 'emerald'`	Series colors. Iris by default; explicit series colors still win.
`numberStyle`	`'count' \| 'pop' \| 'slide' \| 'roll' \| 'flow' \| 'scramble'`	How the headline animates when its value changes. Count (default) counts to the new value.
`loading`	`boolean`	Shows a neutral loading skeleton, not data.
`loadingStyle`	`'shimmer' \| 'draw' \| 'breathe'`	Shimmer sweeps a highlight over still shapes; draw reveals them in order; breathe lets them settle. Follows the selected look, including depth, and respects reduced motion.
`empty`	`'dots' \| 'shape' \| ReactElement \| null`	What the card shows when the period has no data. Dots (default) gathers a quiet dot field around the message; shape lays the chart’s own outline behind it. Pass `<ChartEmpty>` with your own words, any element of your own, or null for nothing. Both looks stay still, so empty never reads as loading, and the headline reads a dash, never zero.
`motion`	`'auto' \| 'none'`	None turns off decorative motion; reduced motion does this automatically.
`legend`	`false \| 'tiles' \| 'inline' \| 'list' \| 'pills' \| 'bars'`	Legend layout; false hides it. Correlation defaults to false.
`legendSwatch`	`'square' \| 'dot' \| 'line'`	Legend marker, square by default.
`stage`	`text key of Row`	Unique stages in input order.
`cohorts`	`readonly [CardSeries<Key>, CardSeries<Key>]`	Two distinct nonnegative, nonincreasing series. Missing stages remain unknown.
`onKeyDown`	`KeyboardEventHandler<HTMLElement>`	Keyboard handler on the card frame. Chart inspection also has its own keyboard handling.

Props

Every prop FunnelChartCard accepts, in the order you are likely to reach for them.

Prop	Type	Description
`title`	`string`	Optional visible title. Omit to render no title. Also supplies the accessible name unless aria-label is set.
`header`	`boolean`	Defaults to true. False removes the whole header: title, headline, delta and period controls, with no reserved space. Pass data directly when your app owns period selection.
`aria-label`	`string`	Accessible chart name, independent of the visible title. Falls back to title, then a generic chart name.
`data`	`Row[]`	One row per stage, in order. Omit when using ranges.
`category`	`text key of Row`	Names each stage. Must be unique.
`value`	`numeric key of Row`	How many reached the stage. Never rises from one stage to the next.
`curve`	`'smooth' \| 'linear'`	Smooth (default) eases each stage into the next; linear tapers straight.
`colors`	`'stages' \| 'single'`	A palette color per stage (default), or one color for every stage.
`tracks`	`boolean`	A quiet full-height lane behind each stage, marking where 100% sits.
`height`	`number`	Plot height in pixels. Defaults to 180.
`headline`	`number`	Resting headline. Defaults to the first stage.
`delta`	`number`	Fractional change for the chip.
`deltaTone`	`'default' \| 'inverse' \| 'neutral'`	Use inverse when a decrease is good.
`range`	`string`	Static period label in the header.
`selected`	`string \| null`	The pinned stage, by name, when you own the selection, so outside filters and a click on the chart share it. `null` pins nothing; omit it and the card keeps its own pin.
`onSelectedChange`	`(stage: string \| null) => void`	Asked when a click, tap, or Escape pins or releases a stage.
`ranges`	`{ id, label, data, delta?, headline? }[]`	Turns the period label into a select. Each range swaps the stages.
`color`	`string`	Any CSS color for `colors="single"`.
`depth`	`boolean`	Draws the funnel as a pipe: each stage shaded as a cylinder of its own thickness, with curved seams and rounded ends.
`legend`	`false \| 'tiles' \| 'inline' \| 'list' \| 'pills' \| 'bars'`	False removes the legend without changing the data. How the stage legend lays out: value tiles (default), a compact inline key, list rows, tinted pills, or bars against the largest.
`legendSwatch`	`'square' \| 'dot' \| 'line'`	The mark beside each legend label. Defaults to a rounded square.
`valueFormat`	`Intl.NumberFormatOptions`	Formats the headline, tiles, and axis, e.g. currency.
`surface`	`'elevated' \| 'outline' \| 'ghost'`	Card treatment. Ghost removes the visual frame only; header and legend are independent controls.
`palette`	`'iris' \| 'cobalt' \| 'emerald'`	Series colors. Iris by default; explicit series colors still win.
`numberStyle`	`'count' \| 'pop' \| 'slide' \| 'roll' \| 'flow' \| 'scramble'`	How the headline animates when its value changes. Count (default) counts to the new value.
`loading`	`boolean`	Shows a neutral loading skeleton, not data.
`loadingStyle`	`'shimmer' \| 'draw' \| 'breathe'`	Shimmer sweeps a highlight over still shapes; draw reveals them in order; breathe lets them settle. Follows the selected look, including depth, and respects reduced motion.
`empty`	`'dots' \| 'shape' \| ReactElement \| null`	What the card shows when the period has no data. Dots (default) gathers a quiet dot field around the message; shape lays the chart’s own outline behind it. Pass `<ChartEmpty>` with your own words, any element of your own, or null for nothing. Both looks stay still, so empty never reads as loading, and the headline reads a dash, never zero.
`motion`	`'auto' \| 'none'`	None turns off decorative motion; reduced motion does this automatically.
`defaultRange`	`string`	Initial range id; defaults to the first supplied range.
`locale`	`string`	Locale used for number formatting. Defaults to en-US.
`formatValue`	`(value: number) => string`	Custom value text, taking precedence over valueFormat.
`badge`	`ReactNode`	Content in the tab above the card. A comparison badge can replace this while a comparison is active.
`className`	`string`	Additional class on the card frame.
`style`	`CSSProperties \| ChartStyle`	Inline styles and scoped --lilt-* chart variables.

Data

// One row per stage, in funnel order. Counts only stay level or fall. const signupFunnel = [ { stage: 'Link opened', people: 197 }, { stage: 'Started', people: 110 }, { stage: 'Completed', people: 77 }, { stage: 'Converted', people: 38 }, ]; <FunnelChartCard title="Sign-up funnel" data={signupFunnel} category="stage" // a text field value="people" // a numeric field />

<FunnelChartCard title="Sign-up funnel" category="stage" value="people" ranges={[ { id: 'week', label: 'Last 7 days', data: lastWeek, delta: 0.052 }, { id: 'month', label: 'Last 30 days', data: lastMonth, delta: 0.031 }, ]} />

Comparative funnel

import { ComparativeFunnelCard } from '@lilt-ui/charts'; <ComparativeFunnelCard title="Onboarding conversion" data={cohortConversion} stage="stage" cohorts={[ { "key": "experiment", "label": "Experiment" }, { "key": "control", "label": "Control" }, ]} />

Prop

Type

Description

title

string

Optional visible title. Omit to render no title. Also supplies the accessible name unless aria-label is set.

header

boolean

Defaults to true. False removes the whole header: title, headline, delta and period controls, with no reserved space. Pass data directly when your app owns period selection.

aria-label

string

Accessible chart name, independent of the visible title. Falls back to title, then a generic chart name.

data

Row[]

One row per observation. Omit when using ranges.

height

number

Minimum plot height, default 260. Dense lanes expand to keep every mark visible.

depth

boolean

Lit tiles, solid bars, or spheres. Data positions remain exact; loading keeps the same depth treatment.

color

string

Override the palette with one CSS color.

aggregate

'sum' | 'mean' | 'max'

Resting headline summary; Strip defaults to mean, the others to sum.

headline

number

Override the resting headline.

delta

number

Fractional change shown alongside the headline.

deltaTone

'default' | 'inverse' | 'neutral'

Use inverse when a decrease is good.

range

string

Static period label.

ranges

{ id, label, data, headline?, delta? }[]

Period choices with their own data.

defaultRange

string

Initial period id.

locale

string

Locale for numbers and dates; defaults to en-US.

formatValue

(value: number) => string

Custom value formatter.

badge

ReactNode

Content for the glass tab above the card.

className

string

Class on the card frame.

style

CSSProperties | ChartStyle

Inline styles and scoped chart variables.

onSelectionChange

(selection | null) => void

Reports id, original row (or null for an absent day), value, and pinned state.

renderReadout

(selection | null) => ReactNode

Consumer-owned readout, including when the header is hidden.

valueFormat

Intl.NumberFormatOptions

Formats the headline, tiles, and axis, e.g. currency.

surface

'elevated' | 'outline' | 'ghost'

Card treatment. Ghost removes the visual frame only; header and legend are independent controls.

palette

'iris' | 'cobalt' | 'emerald'

Series colors. Iris by default; explicit series colors still win.

numberStyle

How the headline animates when its value changes. Count (default) counts to the new value.

loading

boolean

Shows a neutral loading skeleton, not data.

loadingStyle

'shimmer' | 'draw' | 'breathe'

Shimmer sweeps a highlight over still shapes; draw reveals them in order; breathe lets them settle. Follows the selected look, including depth, and respects reduced motion.

empty

'dots' | 'shape' | ReactElement | null

What the card shows when the period has no data. Dots (default) gathers a quiet dot field around the message; shape lays the chart’s own outline behind it. Pass `<ChartEmpty>` with your own words, any element of your own, or null for nothing. Both looks stay still, so empty never reads as loading, and the headline reads a dash, never zero.

motion

'auto' | 'none'

None turns off decorative motion; reduced motion does this automatically.

legend

Legend layout; false hides it. Correlation defaults to false.

legendSwatch

'square' | 'dot' | 'line'

Legend marker, square by default.

stage

text key of Row

Unique stages in input order.

cohorts

readonly [CardSeries<Key>, CardSeries<Key>]

Two distinct nonnegative, nonincreasing series. Missing stages remain unknown.

onKeyDown

KeyboardEventHandler<HTMLElement>

Keyboard handler on the card frame. Chart inspection also has its own keyboard handling.

Prop

Type

Description

title

string

Optional visible title. Omit to render no title. Also supplies the accessible name unless aria-label is set.

header

boolean

Defaults to true. False removes the whole header: title, headline, delta and period controls, with no reserved space. Pass data directly when your app owns period selection.

aria-label

string

Accessible chart name, independent of the visible title. Falls back to title, then a generic chart name.

data

Row[]

One row per stage, in order. Omit when using ranges.

category

text key of Row

Names each stage. Must be unique.

value

numeric key of Row

How many reached the stage. Never rises from one stage to the next.

curve

'smooth' | 'linear'

Smooth (default) eases each stage into the next; linear tapers straight.

colors

'stages' | 'single'

A palette color per stage (default), or one color for every stage.

tracks

boolean

A quiet full-height lane behind each stage, marking where 100% sits.

height

number

Plot height in pixels. Defaults to 180.

headline

number

Resting headline. Defaults to the first stage.

delta

number

Fractional change for the chip.

deltaTone

'default' | 'inverse' | 'neutral'

Use inverse when a decrease is good.

range

string

Static period label in the header.

selected

string | null

The pinned stage, by name, when you own the selection, so outside filters and a click on the chart share it. `null` pins nothing; omit it and the card keeps its own pin.

onSelectedChange

(stage: string | null) => void

Asked when a click, tap, or Escape pins or releases a stage.

ranges

{ id, label, data, delta?, headline? }[]

Turns the period label into a select. Each range swaps the stages.

color

string

Any CSS color for `colors="single"`.

depth

boolean

Draws the funnel as a pipe: each stage shaded as a cylinder of its own thickness, with curved seams and rounded ends.

legend

False removes the legend without changing the data. How the stage legend lays out: value tiles (default), a compact inline key, list rows, tinted pills, or bars against the largest.

legendSwatch

'square' | 'dot' | 'line'

The mark beside each legend label. Defaults to a rounded square.

valueFormat

Intl.NumberFormatOptions

Formats the headline, tiles, and axis, e.g. currency.

surface

'elevated' | 'outline' | 'ghost'

Card treatment. Ghost removes the visual frame only; header and legend are independent controls.

palette

'iris' | 'cobalt' | 'emerald'

Series colors. Iris by default; explicit series colors still win.

numberStyle

How the headline animates when its value changes. Count (default) counts to the new value.

loading

boolean

Shows a neutral loading skeleton, not data.

loadingStyle

'shimmer' | 'draw' | 'breathe'

Shimmer sweeps a highlight over still shapes; draw reveals them in order; breathe lets them settle. Follows the selected look, including depth, and respects reduced motion.

empty

'dots' | 'shape' | ReactElement | null

motion

'auto' | 'none'

None turns off decorative motion; reduced motion does this automatically.

defaultRange

string

Initial range id; defaults to the first supplied range.

locale

string

Locale used for number formatting. Defaults to en-US.

formatValue

(value: number) => string

Custom value text, taking precedence over valueFormat.

badge

ReactNode

Content in the tab above the card. A comparison badge can replace this while a comparison is active.

className

string

Additional class on the card frame.

style

CSSProperties | ChartStyle

Inline styles and scoped --lilt-* chart variables.

Chart style

Palette

Theme

Appearance

Reading & motion

Usage

Data

Comparative funnel

Props

Chart style

Palette

Theme

Appearance

Reading & motion

Funnel chart

Usage

Data

Comparative funnel

Props