Visualization
Combo Chart
A single or dual axis bar and line chart.
"use client"
import { ComboChart } from "@/components/ComboChart"
const chartdata = [ { date: "Jan 23", SolarPanels: 2890, Inverters: 2338, }, { date: "Feb 23", SolarPanels: 2756, Inverters: 2103, }, { date: "Mar 23", SolarPanels: 3322, Inverters: 2194, }, { date: "Apr 23", SolarPanels: 3470, Inverters: 2108, }, { date: "May 23", SolarPanels: 3475, Inverters: 1812, }, { date: "Jun 23", SolarPanels: 3129, Inverters: 1726, }, { date: "Jul 23", SolarPanels: 3490, Inverters: 1982, }, { date: "Aug 23", SolarPanels: 2903, Inverters: 2012, }, { date: "Sep 23", SolarPanels: 2643, Inverters: 2342, }, { date: "Oct 23", SolarPanels: 2837, Inverters: 2473, }, { date: "Nov 23", SolarPanels: 2954, Inverters: 3848, }, { date: "Dec 23", SolarPanels: 3239, Inverters: 3736, },]
export const ComboChartHero = () => ( <ComboChart data={chartdata} index="date" enableBiaxial={true} barSeries={{ categories: ["SolarPanels"], yAxisLabel: "Solar Panels (Bars)", }} lineSeries={{ categories: ["Inverters"], showYAxis: true, yAxisLabel: "Inverters (Line)", colors: ["amber"], yAxisWidth: 60, }} />)Installation
npm i recharts- Copy and paste the code into your project’s hooks or component directory.
// Tremor useOnWindowResize [v0.0.0] import * as React from "react" export const useOnWindowResize = (handler: { (): void }) => { React.useEffect(() => { const handleResize = () => { handler() } handleResize() window.addEventListener("resize", handleResize) return () => window.removeEventListener("resize", handleResize) }, [handler])} - Copy and paste the code into your project’s component directory. Do not forget to update the import paths. If you have not added the required chartUtils.ts, check out the add utilities and helpers section in installation.
// Tremor ComboChart [v0.0.0]/* eslint-disable @typescript-eslint/no-explicit-any */ "use client" import React from "react"import { RiArrowLeftSLine, RiArrowRightSLine } from "@remixicon/react"import { Bar, CartesianGrid, Dot, Label, Line, ComposedChart as RechartsComposedChart, Legend as RechartsLegend, ResponsiveContainer, Tooltip, XAxis, YAxis,} from "recharts"import { AxisDomain } from "recharts/types/util/types" import { AvailableChartColors, AvailableChartColorsKeys, constructCategoryColors, getColorClassName, getYAxisDomain, hasOnlyOneValueForKey,} from "@/lib/chartUtils"import { useOnWindowResize } from "@/lib/useOnWindowResize"import { cx } from "@/lib/utils" //#region Shapefunction deepEqual<T>(obj1: T, obj2: T): boolean { if (obj1 === obj2) return true if ( typeof obj1 !== "object" || typeof obj2 !== "object" || obj1 === null || obj2 === null ) { return false } const keys1 = Object.keys(obj1) as Array<keyof T> const keys2 = Object.keys(obj2) as Array<keyof T> if (keys1.length !== keys2.length) return false for (const key of keys1) { if (!keys2.includes(key) || !deepEqual(obj1[key], obj2[key])) return false } return true} const renderShape = ( props: any, activeBar: any | undefined, activeLegend: string | undefined,) => { const { fillOpacity, name, payload, value, width, x } = props let { y, height } = props if (height < 0) { y += height height = Math.abs(height) // height must be a positive number } return ( <rect x={x} y={y} width={width} height={height} opacity={ activeBar || (activeLegend && activeLegend !== name) ? deepEqual(activeBar, { ...payload, value }) ? fillOpacity : 0.3 : fillOpacity } /> )} //#region Legend interface LegendItemProps { name: string color: AvailableChartColorsKeys onClick?: (name: string, color: AvailableChartColorsKeys) => void activeLegend?: string chartType: "bar" | "line"} const LegendItem = ({ name, color, onClick, activeLegend, chartType,}: LegendItemProps) => { const hasOnValueChange = !!onClick const colorClass = getColorClassName(color, "bg") return ( <li className={cx( // base "group inline-flex flex-nowrap items-center gap-1.5 whitespace-nowrap rounded px-2 py-1 transition", hasOnValueChange ? "cursor-pointer hover:bg-gray-100 dark:hover:bg-gray-800" : "cursor-default", )} onClick={(e) => { e.stopPropagation() onClick?.(name, color) }} > <span className={cx( { "size-2 rounded-sm": chartType === "bar" }, { "h-[3px] w-3.5 shrink-0 rounded-full": chartType === "line", }, "shrink-0", colorClass, activeLegend && activeLegend !== name ? "opacity-40" : "opacity-100", )} aria-hidden={true} /> <p className={cx( // base "truncate whitespace-nowrap text-xs", // text color "text-gray-700 dark:text-gray-300", hasOnValueChange && "group-hover:text-gray-900 dark:group-hover:text-gray-50", activeLegend && activeLegend !== name ? "opacity-40" : "opacity-100", )} > {name} </p> </li> )} interface ScrollButtonProps { icon: React.ElementType onClick?: () => void disabled?: boolean} const ScrollButton = ({ icon, onClick, disabled }: ScrollButtonProps) => { const Icon = icon const [isPressed, setIsPressed] = React.useState(false) const intervalRef = React.useRef<NodeJS.Timeout | null>(null) React.useEffect(() => { if (isPressed) { intervalRef.current = setInterval(() => { onClick?.() }, 300) } else { clearInterval(intervalRef.current as NodeJS.Timeout) } return () => clearInterval(intervalRef.current as NodeJS.Timeout) }, [isPressed, onClick]) React.useEffect(() => { if (disabled) { clearInterval(intervalRef.current as NodeJS.Timeout) setIsPressed(false) } }, [disabled]) return ( <button type="button" className={cx( // base "group inline-flex size-5 items-center truncate rounded transition", disabled ? "cursor-not-allowed text-gray-400 dark:text-gray-600" : "cursor-pointer text-gray-700 hover:bg-gray-100 hover:text-gray-900 dark:text-gray-300 dark:hover:bg-gray-800 dark:hover:text-gray-50", )} disabled={disabled} onClick={(e) => { e.stopPropagation() onClick?.() }} onMouseDown={(e) => { e.stopPropagation() setIsPressed(true) }} onMouseUp={(e) => { e.stopPropagation() setIsPressed(false) }} > <Icon className="size-full" aria-hidden="true" /> </button> )} interface LegendProps extends React.OlHTMLAttributes<HTMLOListElement> { categories: { name: string; chartType: "bar" | "line" }[] barCategoryColors: Map<string, AvailableChartColorsKeys> lineCategoryColors: Map<string, AvailableChartColorsKeys> onClickLegendItem?: ( category: string, color: AvailableChartColorsKeys, ) => void activeLegend?: string enableLegendSlider?: boolean} type HasScrollProps = { left: boolean right: boolean} const Legend = React.forwardRef<HTMLOListElement, LegendProps>((props, ref) => { const { categories, barCategoryColors, lineCategoryColors, onClickLegendItem, activeLegend, enableLegendSlider = false, className, ...other } = props const scrollableRef = React.useRef<HTMLInputElement>(null) const [hasScroll, setHasScroll] = React.useState<HasScrollProps | null>(null) const [isKeyDowned, setIsKeyDowned] = React.useState<string | null>(null) const intervalRef = React.useRef<NodeJS.Timeout | null>(null) const checkScroll = React.useCallback(() => { const scrollable = scrollableRef?.current if (!scrollable) return const hasLeftScroll = scrollable.scrollLeft > 0 const hasRightScroll = scrollable.scrollWidth - scrollable.clientWidth > scrollable.scrollLeft setHasScroll({ left: hasLeftScroll, right: hasRightScroll }) }, [setHasScroll]) const scrollToTest = React.useCallback( (direction: "left" | "right") => { const element = scrollableRef?.current const width = element?.clientWidth ?? 0 if (element && enableLegendSlider) { element.scrollTo({ left: direction === "left" ? element.scrollLeft - width : element.scrollLeft + width, behavior: "smooth", }) setTimeout(() => { checkScroll() }, 400) } }, [enableLegendSlider, checkScroll], ) React.useEffect(() => { const keyDownHandler = (key: string) => { if (key === "ArrowLeft") { scrollToTest("left") } else if (key === "ArrowRight") { scrollToTest("right") } } if (isKeyDowned) { keyDownHandler(isKeyDowned) intervalRef.current = setInterval(() => { keyDownHandler(isKeyDowned) }, 300) } else { clearInterval(intervalRef.current as NodeJS.Timeout) } return () => clearInterval(intervalRef.current as NodeJS.Timeout) }, [isKeyDowned, scrollToTest]) const keyDown = (e: KeyboardEvent) => { e.stopPropagation() if (e.key === "ArrowLeft" || e.key === "ArrowRight") { e.preventDefault() setIsKeyDowned(e.key) } } const keyUp = (e: KeyboardEvent) => { e.stopPropagation() setIsKeyDowned(null) } React.useEffect(() => { const scrollable = scrollableRef?.current if (enableLegendSlider) { checkScroll() scrollable?.addEventListener("keydown", keyDown) scrollable?.addEventListener("keyup", keyUp) } return () => { scrollable?.removeEventListener("keydown", keyDown) scrollable?.removeEventListener("keyup", keyUp) } }, [checkScroll, enableLegendSlider]) return ( <ol ref={ref} className={cx("relative overflow-hidden", className)} {...other} > <div ref={scrollableRef} className={cx( "flex h-full", enableLegendSlider ? hasScroll?.right || hasScroll?.left ? "snap-mandatory items-center overflow-auto pl-4 pr-12 [scrollbar-width:none] [&::-webkit-scrollbar]:hidden" : "" : "flex-wrap", )} > {categories.map((category, index) => { const barColor = barCategoryColors.get(category.name) const lineColor = lineCategoryColors.get(category.name) return ( <LegendItem key={`item-${index}`} name={category.name} chartType={category.chartType} onClick={onClickLegendItem} activeLegend={activeLegend} color={category.chartType === "bar" ? barColor! : lineColor!} /> ) })} </div> {enableLegendSlider && (hasScroll?.right || hasScroll?.left) ? ( <> <div className={cx( // base "absolute bottom-0 right-0 top-0 flex h-full items-center justify-center pr-1", // background color "bg-white dark:bg-gray-950", )} > <ScrollButton icon={RiArrowLeftSLine} onClick={() => { setIsKeyDowned(null) scrollToTest("left") }} disabled={!hasScroll?.left} /> <ScrollButton icon={RiArrowRightSLine} onClick={() => { setIsKeyDowned(null) scrollToTest("right") }} disabled={!hasScroll?.right} /> </div> </> ) : null} </ol> )}) Legend.displayName = "Legend" const ChartLegend = ( { payload }: any, barCategoryColors: Map<string, AvailableChartColorsKeys>, lineCategoryColors: Map<string, AvailableChartColorsKeys>, setLegendHeight: React.Dispatch<React.SetStateAction<number>>, activeLegend: string | undefined, onClick?: (category: string, color: AvailableChartColorsKeys) => void, enableLegendSlider?: boolean, legendPosition?: "left" | "center" | "right", barYAxisWidth?: number, lineYAxisWidth?: number,) => { const legendRef = React.useRef<HTMLDivElement>(null) useOnWindowResize(() => { const calculateHeight = (height: number | undefined) => height ? Number(height) + 15 : 60 setLegendHeight(calculateHeight(legendRef.current?.clientHeight)) }) const filteredPayload = payload.filter((item: any) => item.type !== "none") const paddingLeft = legendPosition === "left" && barYAxisWidth ? barYAxisWidth - 8 : 0 const paddingRight = (legendPosition === "right" || legendPosition === undefined) && lineYAxisWidth ? lineYAxisWidth - 8 : 52 return ( <div style={{ paddingLeft: paddingLeft, paddingRight: paddingRight }} ref={legendRef} className={cx( "flex items-center", { "justify-center": legendPosition === "center" }, { "justify-start": legendPosition === "left", }, { "justify-end": legendPosition === "right" }, )} > <Legend categories={filteredPayload.map((entry: any) => ({ name: entry.value, chartType: entry.type === "rect" ? "bar" : entry.type, }))} barCategoryColors={barCategoryColors} lineCategoryColors={lineCategoryColors} onClickLegendItem={onClick} activeLegend={activeLegend} enableLegendSlider={enableLegendSlider} /> </div> )} //#region Tooltip type TooltipProps = Pick<ChartTooltipProps, "active" | "payload" | "label"> type PayloadItem = { category: string value: number index: string barColor: AvailableChartColorsKeys lineColor: AvailableChartColorsKeys chartType: "bar" | "line" type: string payload: any} interface ChartTooltipProps { active: boolean | undefined payload: PayloadItem[] label: string barValueFormatter?: (value: number) => string lineValueFormatter?: (value: number) => string} const ChartTooltip = ({ active, payload, label, barValueFormatter = (value: number): string => value.toString(), lineValueFormatter = (value: number): string => value.toString(),}: ChartTooltipProps) => { if (active && payload && payload.length) { const filteredPayload = payload.filter((item: any) => item.type !== "none") return ( <div className={cx( // base "rounded-md border text-sm shadow-md", // border color "border-gray-200 dark:border-gray-800", // background color "bg-white dark:bg-gray-950", )} > <div className={cx("border-b border-inherit px-4 py-2")}> <p className={cx( // base "font-medium", // text color "text-gray-900 dark:text-gray-50", )} > {label} </p> </div> <div className={cx("space-y-1 px-4 py-2")}> {filteredPayload.map( ({ value, category, barColor, lineColor, chartType }, index) => ( <div key={`id-${index}`} className="flex items-center justify-between space-x-8" > <div className="flex items-center space-x-2"> <div className="flex w-5 items-center justify-center"> <span aria-hidden="true" className={cx( { "size-2 rounded-sm": chartType === "bar" }, { "h-[3px] w-3.5 shrink-0 rounded-full": chartType === "line", }, "shrink-0", getColorClassName( chartType === "bar" ? barColor : lineColor, "bg", ), )} /> </div> <p className={cx( // base "whitespace-nowrap text-right", // text color "text-gray-700 dark:text-gray-300", )} > {category} </p> </div> <p className={cx( // base "whitespace-nowrap text-right font-medium tabular-nums", // text color "text-gray-900 dark:text-gray-50", )} > {chartType === "bar" ? barValueFormatter(value) : lineValueFormatter(value)} </p> </div> ), )} </div> </div> ) } return null} interface ActiveDot { index?: number dataKey?: string} type BaseEventProps = { eventType: "category" | "bar" | "dot" categoryClicked: string [key: string]: number | string} type ComboChartEventProps = BaseEventProps | null | undefined type ChartSeries = { categories: string[] colors?: AvailableChartColorsKeys[] valueFormatter?: (value: number) => string showYAxis?: boolean yAxisWidth?: number allowDecimals?: boolean yAxisLabel?: string autoMinValue?: boolean minValue?: number maxValue?: number} interface ComboChartProps extends React.HTMLAttributes<HTMLDivElement> { data: Record<string, any>[] index: string startEndOnly?: boolean showXAxis?: boolean xAxisLabel?: string showGridLines?: boolean intervalType?: "preserveStartEnd" | "equidistantPreserveStart" showLegend?: boolean showTooltip?: boolean onValueChange?: (value: ComboChartEventProps) => void enableLegendSlider?: boolean legendPosition?: "left" | "center" | "right" tickGap?: number enableBiaxial?: boolean tooltipCallback?: (tooltipCallbackContent: TooltipProps) => void customTooltip?: React.ComponentType<TooltipProps> barSeries: ChartSeries & { type?: "default" | "stacked" } lineSeries?: ChartSeries & { connectNulls?: boolean }} const ComboChart = React.forwardRef<HTMLDivElement, ComboChartProps>( (props, forwardedRef) => { const defaultSeries = { categories: [], colors: AvailableChartColors, valueFormatter: (value: number) => value.toString(), showYAxis: true, yAxisWidth: 56, yAxisLabel: undefined, allowDecimals: true, type: "default", autoMinValue: false, minValue: undefined, maxValue: undefined, } const defaultBarSeries = defaultSeries const defaultLineSeries = { ...defaultSeries, connectNulls: false, } const { data = [], index, startEndOnly = false, showXAxis = true, showGridLines = true, intervalType = "equidistantPreserveStart", showTooltip = true, showLegend = true, legendPosition = "right", enableLegendSlider = false, onValueChange, tickGap = 5, xAxisLabel, enableBiaxial = false, barSeries = defaultBarSeries, lineSeries = defaultLineSeries, tooltipCallback, customTooltip, className, ...other } = props const mergedBarSeries = { ...defaultBarSeries, ...barSeries } const mergedLineSeries = { ...defaultLineSeries, ...lineSeries } const CustomTooltip = customTooltip const paddingValue = (!showXAxis && !mergedBarSeries.showYAxis && enableBiaxial && !mergedLineSeries.showYAxis) || (startEndOnly && !mergedBarSeries.showYAxis && enableBiaxial && !mergedLineSeries.showYAxis) ? 0 : 20 const [legendHeight, setLegendHeight] = React.useState(60) const [activeDot, setActiveDot] = React.useState<ActiveDot | undefined>( undefined, ) const [activeLegend, setActiveLegend] = React.useState<string | undefined>( undefined, ) const prevActiveRef = React.useRef<boolean | undefined>(undefined) const prevLabelRef = React.useRef<string | undefined>(undefined) const barCategoryColors = constructCategoryColors( mergedBarSeries.categories, mergedBarSeries.colors ?? AvailableChartColors, ) const lineCategoryColors = constructCategoryColors( mergedLineSeries.categories, mergedLineSeries.colors ?? AvailableChartColors, ) const [activeBar, setActiveBar] = React.useState<any | undefined>(undefined) const barYAxisDomain = getYAxisDomain( mergedBarSeries.autoMinValue ?? false, mergedBarSeries.minValue, mergedBarSeries.maxValue, ) const lineYAxisDomain = getYAxisDomain( mergedLineSeries.autoMinValue ?? false, mergedLineSeries.minValue, mergedLineSeries.maxValue, ) const hasOnValueChange = !!onValueChange const stacked = barSeries.type === "stacked" function onBarClick(data: any, _: any, event: React.MouseEvent) { event.stopPropagation() if (!onValueChange) return if (deepEqual(activeBar, { ...data.payload, value: data.value })) { setActiveLegend(undefined) setActiveBar(undefined) onValueChange?.(null) } else { setActiveLegend(data.tooltipPayload?.[0]?.dataKey) setActiveBar({ ...data.payload, value: data.value, }) onValueChange?.({ eventType: "bar", categoryClicked: data.tooltipPayload?.[0]?.dataKey, ...data.payload, }) } } function onDotClick(itemData: any, event: React.MouseEvent) { event.stopPropagation() if (!hasOnValueChange) return if ( (itemData.index === activeDot?.index && itemData.dataKey === activeDot?.dataKey) || (hasOnlyOneValueForKey(data, itemData.dataKey) && activeLegend && activeLegend === itemData.dataKey) ) { setActiveLegend(undefined) setActiveDot(undefined) onValueChange?.(null) } else { setActiveBar(undefined) setActiveLegend(itemData.dataKey) setActiveDot({ index: itemData.index, dataKey: itemData.dataKey, }) onValueChange?.({ eventType: "dot", categoryClicked: itemData.dataKey, ...itemData.payload, }) } } function onCategoryClick(dataKey: string) { if (!hasOnValueChange) return if (dataKey === activeLegend && !activeBar && !activeDot) { setActiveLegend(undefined) onValueChange?.(null) } else if ( activeBar && activeBar.tooltipPayload?.[0]?.dataKey === dataKey ) { setActiveLegend(dataKey) onValueChange?.({ eventType: "category", categoryClicked: dataKey, }) } else { setActiveLegend(dataKey) setActiveBar(undefined) setActiveDot(undefined) onValueChange?.({ eventType: "category", categoryClicked: dataKey, }) } } return ( <div ref={forwardedRef} className={cx("h-80 w-full", className)} tremor-id="tremor-raw" {...other} > <ResponsiveContainer> <RechartsComposedChart data={data} onClick={ hasOnValueChange && (activeLegend || activeBar || activeDot) ? () => { setActiveBar(undefined) setActiveDot(undefined) setActiveLegend(undefined) onValueChange?.(null) } : undefined } margin={{ bottom: xAxisLabel ? 30 : undefined, left: mergedBarSeries.yAxisLabel ? 20 : undefined, right: mergedLineSeries.yAxisLabel ? 20 : undefined, top: 5, }} > {showGridLines ? ( <CartesianGrid className={cx("stroke-gray-200 stroke-1 dark:stroke-gray-800")} horizontal={true} vertical={false} /> ) : null} <XAxis hide={!showXAxis} tick={{ transform: "translate(0, 6)", }} fill="" stroke="" className={cx( // base "mt-4 text-xs", // text fill "fill-gray-500 dark:fill-gray-500", )} tickLine={false} axisLine={false} minTickGap={tickGap} padding={{ left: paddingValue, right: paddingValue, }} dataKey={index} interval={startEndOnly ? "preserveStartEnd" : intervalType} ticks={ startEndOnly ? [data[0][index], data[data.length - 1][index]] : undefined } > {xAxisLabel && ( <Label position="insideBottom" offset={-20} className="fill-gray-800 text-sm font-medium dark:fill-gray-200" > {xAxisLabel} </Label> )} </XAxis> <YAxis yAxisId={enableBiaxial ? "left" : undefined} width={mergedBarSeries.yAxisWidth} hide={!mergedBarSeries.showYAxis} axisLine={false} tickLine={false} fill="" stroke="" className={cx( // base "text-xs", // text fill "fill-gray-500 dark:fill-gray-500", )} tick={{ transform: "translate(-3, 0)", }} type="number" domain={barYAxisDomain as AxisDomain} tickFormatter={mergedBarSeries.valueFormatter} allowDecimals={mergedBarSeries.allowDecimals} > {mergedBarSeries.yAxisLabel && ( <Label position="insideLeft" style={{ textAnchor: "middle" }} angle={-90} offset={-15} className="fill-gray-800 text-sm font-medium dark:fill-gray-200" > {mergedBarSeries.yAxisLabel} </Label> )} </YAxis> {enableBiaxial ? ( <YAxis yAxisId="right" orientation="right" width={mergedLineSeries.yAxisWidth} hide={!mergedLineSeries.showYAxis} axisLine={false} tickLine={false} fill="" stroke="" className={cx( // base "text-xs", // text fill "fill-gray-500 dark:fill-gray-500", )} tick={{ transform: "translate(3, 0)", }} type="number" domain={lineYAxisDomain as AxisDomain} tickFormatter={mergedLineSeries.valueFormatter} allowDecimals={mergedLineSeries.allowDecimals} > {mergedLineSeries.yAxisLabel && ( <Label position="insideRight" style={{ textAnchor: "middle" }} angle={-90} offset={-15} className="fill-gray-800 text-sm font-medium dark:fill-gray-200" > {mergedLineSeries.yAxisLabel} </Label> )} </YAxis> ) : null} <Tooltip wrapperStyle={{ outline: "none" }} isAnimationActive={true} animationDuration={100} cursor={{ stroke: "#d1d5db", strokeWidth: 1 }} offset={20} position={{ y: 0, }} content={({ active, payload, label }) => { const cleanPayload: TooltipProps["payload"] = payload ? payload.map((item: any) => ({ category: item.dataKey, value: item.value, index: item.payload[index], barColor: barCategoryColors.get( item.dataKey, ) as AvailableChartColorsKeys, lineColor: lineCategoryColors.get( item.dataKey, ) as AvailableChartColorsKeys, chartType: barCategoryColors.get(item.dataKey) ? "bar" : ("line" as PayloadItem["chartType"]), type: item.type, payload: item.payload, })) : [] if ( tooltipCallback && (active !== prevActiveRef.current || label !== prevLabelRef.current) ) { tooltipCallback({ active, payload: cleanPayload, label }) prevActiveRef.current = active prevLabelRef.current = label } return showTooltip && active ? ( CustomTooltip ? ( <CustomTooltip active={active} payload={cleanPayload} label={label} /> ) : ( <ChartTooltip active={active} payload={cleanPayload} label={label} barValueFormatter={mergedBarSeries.valueFormatter} lineValueFormatter={mergedLineSeries.valueFormatter} /> ) ) : null }} /> {showLegend ? ( <RechartsLegend verticalAlign="top" height={legendHeight} content={({ payload }) => ChartLegend( { payload }, barCategoryColors, lineCategoryColors, setLegendHeight, activeLegend, hasOnValueChange ? (clickedLegendItem: string) => onCategoryClick(clickedLegendItem) : undefined, enableLegendSlider, legendPosition, mergedBarSeries.yAxisWidth, mergedLineSeries.yAxisWidth, ) } /> ) : null} {mergedBarSeries.categories.map((category) => ( <Bar yAxisId={enableBiaxial ? "left" : undefined} className={cx( getColorClassName( barCategoryColors.get(category) as AvailableChartColorsKeys, "fill", ), onValueChange ? "cursor-pointer" : "", )} key={category} name={category} type="linear" dataKey={category} stackId={stacked ? "stack" : undefined} isAnimationActive={false} fill="" shape={(props: any) => renderShape(props, activeBar, activeLegend) } onClick={onBarClick} /> ))} {/* hidden lines to increase clickable target area */} {onValueChange ? mergedLineSeries.categories.map((category) => ( <Line yAxisId={enableBiaxial ? "right" : undefined} className={cx("cursor-pointer")} strokeOpacity={0} key={category} name={category} type="linear" dataKey={category} stroke="transparent" fill="transparent" legendType="none" tooltipType="none" strokeWidth={12} connectNulls={mergedLineSeries.connectNulls} onClick={(props: any, event) => { event.stopPropagation() const { name } = props onCategoryClick(name) }} /> )) : null} {mergedLineSeries.categories.map((category) => ( <Line yAxisId={enableBiaxial ? "right" : undefined} className={cx( getColorClassName( lineCategoryColors.get( category, ) as AvailableChartColorsKeys, "stroke", ), hasOnValueChange && "cursor-pointer", )} strokeOpacity={ activeDot || (activeLegend && activeLegend !== category) ? 0.3 : 1 } activeDot={(props: any) => { const { cx: cxCoord, cy: cyCoord, stroke, strokeLinecap, strokeLinejoin, strokeWidth, dataKey, } = props return ( <Dot className={cx( "stroke-white dark:stroke-gray-950", onValueChange ? "cursor-pointer" : "", getColorClassName( lineCategoryColors.get( dataKey, ) as AvailableChartColorsKeys, "fill", ), )} cx={cxCoord} cy={cyCoord} r={5} fill="" stroke={stroke} strokeLinecap={strokeLinecap} strokeLinejoin={strokeLinejoin} strokeWidth={strokeWidth} onClick={(_, event) => onDotClick(props, event)} /> ) }} dot={(props: any) => { const { stroke, strokeLinecap, strokeLinejoin, strokeWidth, cx: cxCoord, cy: cyCoord, dataKey, index, } = props if ( (hasOnlyOneValueForKey(data, category) && !( activeDot || (activeLegend && activeLegend !== category) )) || (activeDot?.index === index && activeDot?.dataKey === category) ) { return ( <Dot key={index} cx={cxCoord} cy={cyCoord} r={5} stroke={stroke} fill="" strokeLinecap={strokeLinecap} strokeLinejoin={strokeLinejoin} strokeWidth={strokeWidth} className={cx( "stroke-white dark:stroke-gray-950", onValueChange ? "cursor-pointer" : "", getColorClassName( lineCategoryColors.get( dataKey, ) as AvailableChartColorsKeys, "fill", ), )} /> ) } return <React.Fragment key={index}></React.Fragment> }} key={`${category}-line-id`} name={category} type="linear" dataKey={category} stroke="" strokeWidth={2} strokeLinejoin="round" strokeLinecap="round" isAnimationActive={false} connectNulls={mergedLineSeries.connectNulls} onClick={(props: any, event) => { event.stopPropagation() const { name } = props onCategoryClick(name) }} /> ))} </RechartsComposedChart> </ResponsiveContainer> </div> ) },) ComboChart.displayName = "ComboChart" export { ComboChart, type ComboChartEventProps, type TooltipProps }
Example with single (shared) y-axis
"use client"
import React from "react"
import { ComboChart } from "@/components/ComboChart"
const chartdata = [ { date: "Jan 23", SolarPanels: 2890, Inverters: 2338, }, { date: "Feb 23", SolarPanels: 2756, Inverters: 2103, }, { date: "Mar 23", SolarPanels: 3322, Inverters: 2194, }, { date: "Apr 23", SolarPanels: 3470, Inverters: 2108, }, { date: "May 23", SolarPanels: 3475, Inverters: 1812, }, { date: "Jun 23", SolarPanels: 3129, Inverters: 1726, }, { date: "Jul 23", SolarPanels: 3490, Inverters: 1982, }, { date: "Aug 23", SolarPanels: 2903, Inverters: 2012, }, { date: "Sep 23", SolarPanels: 2643, Inverters: 2342, }, { date: "Oct 23", SolarPanels: 2837, Inverters: 2473, }, { date: "Nov 23", SolarPanels: 2954, Inverters: 3848, }, { date: "Dec 23", SolarPanels: 3239, Inverters: 3736, },]
export const ComboChartSingleAxisExample = () => ( <ComboChart data={chartdata} index="date" barSeries={{ categories: ["SolarPanels"], }} lineSeries={{ categories: ["Inverters"], colors: ["amber"], }} />)Example with OnValueChange
When you add onValueChange to the AreaChart, it becomes clickable.
null
"use client"
import React from "react"
import { ComboChart, ComboChartEventProps } from "@/components/ComboChart"
const chartdata = [ { date: "Jan 23", SolarPanels: 2890, Inverters: 2338, AveragePrice: 2614, }, { date: "Feb 23", SolarPanels: 2756, Inverters: 2103, AveragePrice: 2429.5, }, { date: "Mar 23", SolarPanels: 3322, Inverters: 2194, AveragePrice: 2758, }, { date: "Apr 23", SolarPanels: 3470, Inverters: 2108, AveragePrice: 2789, }, { date: "May 23", SolarPanels: 3475, Inverters: 1812, AveragePrice: 2643.5, }, { date: "Jun 23", SolarPanels: 3129, Inverters: 1726, AveragePrice: 2427.5, }, { date: "Jul 23", SolarPanels: 3490, Inverters: 1982, AveragePrice: 2736, }, { date: "Aug 23", SolarPanels: 2903, Inverters: 2012, AveragePrice: 2457.5, }, { date: "Sep 23", SolarPanels: 2643, Inverters: 2342, AveragePrice: 2492.5, }, { date: "Oct 23", SolarPanels: 2837, Inverters: 2473, AveragePrice: 2655, }, { date: "Nov 23", SolarPanels: 2954, Inverters: 3848, AveragePrice: 3401, }, { date: "Dec 23", SolarPanels: 3239, Inverters: 3736, AveragePrice: 3487.5, },]
export const ComboChartOnValueChangeExample = () => { const [value, setValue] = React.useState<ComboChartEventProps>(null) return ( <> <ComboChart data={chartdata} index="date" enableBiaxial={true} onValueChange={(v) => setValue(v)} barSeries={{ categories: ["SolarPanels", "Inverters"], yAxisLabel: "Solar Panels (Bars)", }} lineSeries={{ categories: ["AveragePrice"], showYAxis: true, yAxisLabel: "AveragePrice (Line)", colors: ["gray"], }} /> <pre className="mt-8 rounded-md bg-gray-950 p-3 text-sm text-white dark:bg-gray-800"> {JSON.stringify(value, null, 2)} </pre> </> )}Example with tooltipCallback
Revenue by month
$3,239
MoM Change:
9.65%
"use client"
import React from "react"
import { ComboChart, type TooltipProps } from "@/components/ComboChart"
const data = [ { date: "Jan 23", SolarPanels: 2890, MoMChange: 0 }, { date: "Feb 23", SolarPanels: 2756, MoMChange: -4.64 }, { date: "Mar 23", SolarPanels: 3322, MoMChange: 20.54 }, { date: "Apr 23", SolarPanels: 3470, MoMChange: 4.46 }, { date: "May 23", SolarPanels: 3475, MoMChange: 0.14 }, { date: "Jun 23", SolarPanels: 3129, MoMChange: -9.96 }, { date: "Jul 23", SolarPanels: 3490, MoMChange: 11.54 }, { date: "Aug 23", SolarPanels: 2903, MoMChange: -16.82 }, { date: "Sep 23", SolarPanels: 2643, MoMChange: -8.96 }, { date: "Oct 23", SolarPanels: 2837, MoMChange: 7.34 }, { date: "Nov 23", SolarPanels: 2954, MoMChange: 4.12 }, { date: "Dec 23", SolarPanels: 3239, MoMChange: 9.65 },]
export const ComboChartCallbackExample = () => { const [datas, setDatas] = React.useState<TooltipProps | null>(null)
const currencyFormatter = (number: number) => `$${Intl.NumberFormat("us").format(number)}`
const percentageFormatter = (number: number) => `${number.toFixed(2)}%`
const payload = datas?.payload?.[0]?.payload const solarPanelsValue = payload?.SolarPanels ?? data[data.length - 1].SolarPanels const momChangeValue = payload?.MoMChange ?? data[data.length - 1].MoMChange
const formattedSolarPanels = currencyFormatter(solarPanelsValue) const formattedMoMChange = percentageFormatter(momChangeValue)
return ( <div> <div className="flex gap-8"> <div> <p className="text-sm text-gray-700 dark:text-gray-300"> Revenue by month </p>
<p className="mt-2 text-xl font-semibold text-gray-900 dark:text-gray-50"> {formattedSolarPanels} </p> </div> <div> <p className="text-sm text-gray-700 dark:text-gray-300"> MoM Change: </p> <p className="mt-2 text-xl font-semibold text-gray-900 dark:text-gray-50"> {formattedMoMChange} </p> </div> </div> <ComboChart data={data} index="date" enableBiaxial={true} barSeries={{ colors: ["amber"], categories: ["SolarPanels"], valueFormatter: (v) => currencyFormatter(v), }} lineSeries={{ colors: ["gray"], categories: ["MoMChange"], valueFormatter: (v) => percentageFormatter(v), }} tooltipCallback={(props) => { if (props.active) { setDatas((prev) => { if (prev?.label === props.label) return prev return props }) } else { setDatas(null) } return null }} /> </div> )}Example with customTooltip
API Reference: AreaChart
- data
- Data used to display the chart.
Required
Record<string, any>[]
- index
- Key of the data object to map the data to the x axis.
Required
string[]
Default: []
- categories
- Select the categories from your data. Also used to populate the legend and toolip.
Required
string[]
Default: []
- colors
- Change the colors of the categories. To add, update, or remove the colors, edit the 'chartColors' array in your chartUtils.ts file. The AvailableChartColorsKeys will be automatically updated.
AvailableChartColorsKeys[]
Default: AvailableChartColors, which are by default: 'blue' | 'emerald' | 'violet' | 'amber' | 'gray' | 'cyan' | 'pink' | 'lime' | 'fuchsia'
- type
- Select how chart areas are positioned relative to each other.
'default' | 'stacked' | 'percent'
Default: 'default'
- valueFormatter
- Controls the text formatting for the y-axis values. Also used in the Tooltip.
(value: number) => string
- startEndOnly
- Show only the first and last elements in the x-axis.
boolean
Default: false
- showXAxis
- Controls the visibility of the X axis.
boolean
Default: true
- showYAxis
- Controls the visibility of the Y axis.
boolean
Default: true
- yAxisWidth
- Controls the width of the y-axis.
number
Default: 56
- showGridLines
- Controls the visibility of the gridlines within the plotted area.
boolean
Default: true
- intervalType
- Controls the interval logic of the X axis and how ticks and labels are placed.
equidistantPreserveStart | preserveStartEnd
Default: equidistantPreserveStart
- showTooltip
- Controls the visibility of the tooltip.
boolean
Default: true
- showLegend
- Controls the visibility of the legend.
boolean
Default: true
- autoMinValue
- Adjusts the minimum value in relation to the magnitude of the data.
boolean
Default: false
- minValue
- Sets the minimum value of the shown chart data.
number
- maxValue
- Sets the maximum value of the shown chart data.
number
- allowDecimals
- Controls if the ticks of a numeric axis are displayed as decimals or not.
boolean
Default: true
- onValueChange
- Callback function for when the value of the component changes.
(value: EventProps) => void
- enableLegendSlider
- Adds a slider functionality to the legend instead of wrapping the legend items.
boolean
Default: false
- tickGap
- Sets the minimum gap between two adjacent labels.
number
Default: 5
- connectNulls
- Connects datapoints that have null values between them.
boolean
Default: false
- xAxisLabel
- Add a label to the x-axis.
string
- yAxisLabel
- Add a label to the y-axis.
string
- fill
- Select the fill variant of the area.
'gradient' | 'solid' | 'none'
Default: 'gradient'
- tooltipCallback
- Callback function that returns the active, payload, when the tooltip changes.
(tooltipCallbackContent: TooltipProps) => void
- customTooltip
- Render a custom tooltip component.
React.ComponentType<TooltipProps>