Skip to content
GaudiGaudi Design System home

Search documentation

Search every page, heading and paragraph.

SankeyChart

Flows between stages with widths proportional to volume; each flow is a keyboard point and a table row.

Charts@gaudi/design-system/charts/SankeyChartView in StorybookSource

Installation

pnpm add github:ahmadassaf/design-system recharts

Import from @gaudi/design-system. Load @gaudi/design-system/global.css once and add transpilePackages: ['@gaudi/design-system'] in Next.js.

import { SankeyChart } from '@gaudi/design-system/charts/SankeyChart';

Copy an example into your project with the shadcn CLI: npx shadcn@latest add https://design.gaudi.site/r/sankey-chart-reader-paths.json.

Usage

import { SankeyChart } from '@gaudi/design-system/charts';
<SankeyChart ariaLabel='Support tickets from channel to outcome' links={[{ source: 'Email', target: 'Billing', value: 420 }, { source: 'Billing', target: 'Solved', value: 390 }]} />

Examples

Where readers go

Storybook

API

17 props

Accessibility

The plot is one tab stop named by ariaLabel. The arrow keys walk the points, Home and End jump to the ends, Enter or Space activates and Escape clears; the active point is drawn and read out politely. Every value is mirrored in a data table, and the SVG is hidden from assistive technology.