Composed chart
Bars, lines and areas together, with a second value axis. Same props on both engines.
Install
Pick one engine. Both builds take the same props, so switching later changes only the import path.
Recharts
npx shadcn@latest add https://beautifulcharts.dev/r/instrument-composed-chart-recharts.jsonimport { ComposedChart } from "@/components/beautiful-charts/themes/instrument/recharts/composed-chart";
npm dependencies: recharts@^3.10.1
Apache ECharts
npx shadcn@latest add https://beautifulcharts.dev/r/instrument-composed-chart-echarts.jsonimport { ComposedChart } from "@/components/beautiful-charts/themes/instrument/echarts/composed-chart";
npm dependencies: echarts@^6.1.0
Example
A complete client module. Paste it into your app after installing the Recharts build; for ECharts, change recharts to echarts in the import. To pick options visually and copy the matching code, use the Customizer.
"use client";
import { ComposedChart } from "@/components/beautiful-charts/themes/instrument/recharts/composed-chart";
import type { ChartConfig } from "@/components/beautiful-charts/core/contracts";
const data = [
{ quarter: "Q1", revenue: 420, margin: 0.31 },
{ quarter: "Q2", revenue: 510, margin: 0.34 },
{ quarter: "Q3", revenue: 480, margin: 0.29 },
{ quarter: "Q4", revenue: 620, margin: 0.36 },
];
// Bars on the left axis, a line on the right axis with its own formatter.
const config = {
revenue: { label: "Revenue", type: "bar", axis: "left", color: "var(--chart-1)", format: (v: number) => `$${v}k` },
margin: { label: "Margin", type: "line", axis: "right", color: "var(--chart-2)", format: (v: number) => `${Math.round(v * 100)}%` },
} satisfies ChartConfig;
export function RevenueAndMargin() {
return <ComposedChart data={data} xKey="quarter" config={config} title="Revenue and margin" />;
}
Composed chart props
Generated from ComposedChartProps in the installed source, so this table and your editor's hints always agree. * marks a required prop.
| Prop | Type | Description |
|---|---|---|
| xKey* | keyof TDatum & string | The category or time key on each row, e.g. "month". |
| grid | boolean | Draw grid lines behind the plot. On by default. |
| xAxis | AxisOptions | Category axis: hide it, format ticks, or add a label. |
| yAxis | AxisOptions | Value axis: hide it, format ticks, or add a label. |
| references | ReferenceLine[] | Target or threshold lines, fixed or computed from a series (average, median, max, min). |
| series | (keyof TDatum & string)[] | Series keys to draw, in order. Defaults to the keys in config, then numeric keys in the data. |
| stack | StackMode | "none" groups bars side by side and overlays areas. "stacked" stacks them. "percent" splits each row by its absolute total: positive parts stack up from zero, negative parts down, and the parts' sizes add to 100%. |
| orientation | "vertical" | "horizontal" | "vertical" (default) draws columns; "horizontal" draws bars along the value axis. |
| curve | Curve | Line and area interpolation. "monotone" (default) never overshoots the data. |
| radius | number | Bar corner radius in px. A series' own radius in config wins. |
| barGap | number | Space between bars in one category, in px. |
| barCategoryGap | number | Share of each category left empty around its bars, 0–0.9. |
| maxBarSize | number | Widest a bar can get, in px. |
| showValues | boolean | Draw each value on its mark. Labels that don't fit are left out; the table and tooltip keep every value. |
| highlight | "max" | "none" | Emphasise the largest category and dim the rest. Ties, and rows with no positive total, emphasise nothing. |
| forecastFrom | number | Rows from this index on (inclusive) are a forecast: hatched bars, dashed lines and hatched areas. |
| polarity | "up" | "down" | Whether a rise is good ("up", the default) or bad ("down", e.g. costs or churn). Tints the delta by meaning. |
| brush | boolean | BrushOptions | An overview strip under the plot with a draggable window. Indexes in callbacks stay indexes into data. |
| readout | boolean | The big number in the header: the total for bars, the latest value for trends. Pass false to hide it (e.g. when a stat row says it better, or when a total means nothing, like a sum of percentages). |
| background | "none" | "rule" | "dots" | "grid" | "crosshair" | A quiet pattern behind the plot, drawn by the theme. |
| backgroundSlot | (plot: { x: number; y: number; width: number; height: number }) => ReactNode | Draw your own SVG behind the plot (any pattern or artwork). Receives the plot rectangle in px. |
Recharts build only
Native Recharts children render inside the chart with your original rows, so ReferenceArea, Label or a custom Customized layer work as they do in any Recharts chart.
| Prop | Type | Description |
|---|---|---|
| children | ReactNode | Recharts children render inside the chart: reference areas, custom labels, anything Recharts accepts. |
Apache ECharts build only
Escape hatches into the engine. Your option is deep-merged over the generated one, so you can change one nested setting without replacing a whole section.
| Prop | Type | Description |
|---|---|---|
| renderer | EChartsRenderer | "canvas" (default, best for large data) or "svg". |
| option | OptionOverride | Deep-merged over the generated ECharts option (plain objects merge; arrays and class instances replace), or a function that receives the generated option and returns the final one. See the chart docs. |
Series config
One entry per series key in config. shadcn's ChartConfig entries work as they are. Give a series at most one of color, theme or colors; TypeScript rejects more than one.
| Prop | Type | Description |
|---|---|---|
| label | ReactNode | Name shown in the legend, tooltip and table. Defaults to the key, humanised. |
| ariaLabel | string | Plain text for tables, summaries and announcements when label is not a string. |
| icon | ComponentType<{ className?: string }> | An icon component (e.g. from lucide-react) shown in place of the swatch in the legend and tooltip. |
| format | (value: number) => string | Formats this series' values everywhere: tooltip, legend, table, readout. |
| fill | FillVariant | Body fill: gradient (default for bars and areas), solid, a pattern, unit blocks or thin bars, or "none". |
| stroke | StrokeVariant | Line style for lines and area edges. |
| strokeWidth | number | Line width in px. |
| marker | MarkerVariant | Marker on each point of a line or area at rest. The active point always gets a ring. |
| glow | boolean | A soft glow on this series at rest, not only when it's active. |
| radius | number | Bar corner radius for this series, in px. Overrides the chart's radius. |
| connectNulls | boolean | Join the line across missing values instead of leaving a gap. Off by default: a gap is honest. |
| type | "bar" | "line" | "area" | For composed charts: how this series is drawn, and which value axis it uses. |
| axis | "left" | "right" | Which value axis the series uses (composed charts). A right axis gets its own scale. |
| stackId | string | Bars with the same stack id stack together (composed charts). Defaults to one stack per axis. |
| color | ColorValue | One colour: any CSS colour or var(--chart-1), or { light, dark }. |
| theme | never | shadcn's per-theme colours, { light, dark }. |
| colors | never | Gradient stops from base to value end, per theme. The last stop is the series' single colour. |
Events
Every callback, and the payload types it receives. Indexes always point into the data you passed, even when a brush or grouping shows a subset.
| Prop | Type | Description |
|---|---|---|
| onSelectedChange | (selection: Selection<TDatum> | null) => void | Called when a row is selected or cleared, by pointer, keyboard or the data table. |
| onSelectedSeriesChange | (key: string | null) => void | Called when the selected series changes (legend "select" action, or a click on a series). |
| onHiddenChange | (hidden: string[]) => void | Called when the legend hides or shows a series. |
| onActiveChange | (index: number | null) => void | Called as the hovered or focused row changes, or null when it leaves. |
| onReady | (chart: EChartsType) => void | Called once with the ECharts instance, e.g. to add event listeners. |
export type Selection<TDatum> = {
/** Index into the data you passed in, even when a brush shows a subset. */
dataIndex: number;
datum: TDatum;
seriesKey: string | null;
source: "pointer" | "keyboard" | "table";
/** For a grouped segment (a donut's "Other"): the indexes of every row it stands for. `dataIndex` is the largest. */
members?: number[] | undefined;
};
/** A range of rows shown in the plot, as indexes into your data (inclusive). */
export type RangeValue = { startIndex: number; endIndex: number };
export type TooltipContext<TDatum> = {
datum: TDatum;
/** Index into the data you passed in. */
dataIndex: number;
/** Visible series at this index. `value` is your raw value; `share` is its part of the row in 100% mode. */
series: { key: string; label: ReactNode; value: number | null; share?: number | null | undefined; color: string; selected: boolean }[];
};Parts and styling hooks
Each part carries a data-slot attribute. Theme rules inside the chart are one attribute selector deep, so a selector such as .my-chart [data-slot="chart-title"] overrides them. These are the slots in the files this chart installs; parts a chart doesn't use are simply absent from its markup.
brush-handlebrush-labelbrush-windowchartchart-backgroundchart-background-slotchart-bodychart-brushchart-descriptionchart-eyebrowchart-footerchart-headerchart-headingchart-legendchart-legend-itemchart-legend-labelchart-legend-swatchchart-legend-valuechart-livechart-mainchart-plotchart-readoutchart-statchart-stat-notechart-stat-valuechart-statechart-state-boxchart-state-messagechart-statschart-tablechart-table-scrollchart-takeawaychart-titlechart-tooltipodometerodometer-digitodometer-glyphsodometer-reelodometer-signpartial-notereadout-deltareadout-unitreadout-valuesr-onlytooltip-indicatortooltip-rowtooltip-sharetooltip-titletooltip-valueProps every chart shares
Header, states, legend, tooltip, formatting, motion, sound and controlled interaction state. They work the same on every Instrument chart and both engines. The guide explains colours, controlled state and accessibility.
Show all 34 shared props
| Prop | Type | Description |
|---|---|---|
| data* | TDatum[] | Your rows, as they are. Missing values (null, undefined, NaN) stay missing and are never drawn as zero. |
| locale | string | BCP 47 locale. Defaults to "en-US" so server and client render the same text. |
| timeZone | string | IANA time zone for dates. Defaults to "UTC" so server and client agree. |
| config | ChartConfig | Per-series label, colour, icon, format and style, keyed by series key. shadcn ChartConfig works as it is. |
| eyebrow | ReactNode | Small label above the title. |
| title | ReactNode | Card title. A string also names the chart for screen readers. |
| description | ReactNode | A line under the title. |
| takeaway | ReactNode | ((summary: string) => ReactNode) | false | The sentence under the title. Computed from the data by default; pass text, a function of the computed sentence, or false to hide it. |
| ariaDescription | string | Accessible summary for screen readers. Computed from the data by default. |
| motion | MotionPreference | "full" (default), "subtle" or "off". Reduced-motion settings always win. |
| motionOptions | MotionOptions | When the entrance plays. |
| sound | boolean | Sound cues on hover, scrub and select. Plays only if the visitor has also turned sound on for the page. |
| density | Density | "comfortable" (default) or "compact" for dashboards. |
| legend | LegendOptions | false | Legend position, alignment, shape and click action, or false to hide it. |
| tooltip | TooltipOptions<TDatum> | false | Tooltip position, indicator, cursor and custom content, or false to turn it off. |
| valueFormatter | (value: number) => string | Values formatted for display. Series formatters in config win. |
| loading | boolean | Show the loading state. Over existing data, the old marks stay dimmed instead of vanishing. |
| error | string | null | An error message. Shows the error state in place of the plot. |
| emptyState | ReactNode | Shown instead of the plot when there is no data. |
| loadingState | ReactNode | Shown while loading is true and there is no data yet. |
| errorState | ReactNode | Shown when error is set. |
| selected | number | null | Controlled and uncontrolled interaction state. Point selection (selected) pins one row by its index in data. Series selection (selectedSeries) picks one series and dims the others. They are separate: picking a row doesn't pick a series. |
| defaultSelected | number | null | Initial selected row when uncontrolled. |
| selectedSeries | string | null | Controlled series selection: this series stays lit and the others dim. |
| defaultSelectedSeries | string | null | Initial series selection when uncontrolled. |
| defaultHidden | string[] | Series hidden at first when uncontrolled. |
| activeIndex | number | null | Controlled hover or focus index, for syncing several charts on one cursor. |
| palette | "theme" | "shadcn" | Series colours: "theme" (default) uses the theme's designed palette; "shadcn" uses your --chart-1..5. --bc-series-N always wins. You can also opt a whole section in with the class bc-use-shadcn-colors. |
| table | boolean | Show the "Show data table" disclosure. On by default. |
| stats | ChartStat[] | A row of figures under the title, for dashboard cards and blocks. |
| footer | ReactNode | A line or action at the bottom of the card, e.g. a source note or a link. |
| className | string | Classes on the card, for spacing and layout. |
| height | number | Height of the plot area in px. The frame sizes around it. |