FunnelChart

Shows how many remain at each step of a process.

SourcePackage @kerf-js/veneer

Preview

tsx

import { FunnelChart } from '@kerf-js/veneer'export function Signup() {  return (  <FunnelChart    title="From pricing page to paid"    description="Last 90 days"    data={SIGNUP_FUNNEL}    unit="Teams"  />  )}const SIGNUP_FUNNEL = [  { name: 'Visited pricing', value: 12400 },  { name: 'Signed up', value: 2232 },  { name: 'First deploy', value: 1410 },  { name: 'Invited a teammate', value: 760 },  { name: 'Paid', value: 508 },]

Installation

npm install @kerf-js/veneer

Usage

tsx

import { FunnelChart } from '@kerf-js/veneer'<FunnelChart  title="From pricing page to paid"  description="Last 90 days"  data={SIGNUP_FUNNEL}  unit="Teams"/>

Accessibility

Every chart has a text alternative and a table view of its numbers, so nothing depends on seeing the marks. See Chart for its keyboard support.

API Reference

Prop	Type	Default	Description
`title`	`string`	—	The heading.
`level`	`2 \| 3 \| 4 \| 6 \| 5`	—	The title's heading level: one below the heading the chart sits under. Default 3, a chart in a page section.
`description`	`unknown`	—	One supporting line under the title.
`toolbar`	`unknown`	—	Beside the view toggle: a layout switch, a range picker.
`state`	`"error" \| "loading" \| "empty"`	—	Replaces the plot, in the same frame. With no data the frame shows `empty` on its own.
`loading`	`string`	—	Shows that work is under way.
`empty`	`{ title: string; detail?: unknown; }`	—	The title and detail shown in place of the plot when there is no data.
`error`	`{ title: string; detail?: unknown; }`	—	A message that marks the field invalid and says why.
`action`	`unknown`	—	The next step under an empty or error state: a Retry button.
`data`	`{ name: string; value: number; }[]`	—	The series to draw.
`summary`	`string \| ((c: { data: { name: string; value: number; }[]; title: string;…`	—	One sentence for screen readers and the page; generated from the data when absent.
`format`	`Fmt`	—	Turns a value into the text shown.
`unit`	`string`	—	The word after each count, like "visitors".

RelatedSankey chart Bar chart