Mantine @mantine/charts 9.6.0 wrappers (generated).
Mantine @mantine/charts 9.6.0 wrappers (generated).
AreaChart — Area chart component with stacked, percent and split variants
https://mantine.dev/charts/area-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultMantineChartDotProps — Props passed down to all active dots. Ignored if withDots={false} is set.(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts AreaChart component((series: AreaChartSeries) => Partial<Omit<Props<any, any>, "ref">>) | Partial<Omit<Props<any, any>, "ref">> — Props passed down to recharts Area componentRechartsProps — Props passed down to the Brush componentReact.ReactNode — Additional components that are rendered inside recharts AreaChart componentboolean (default true) — If set, points with null values are connectedAreaChartCurveType (default 'monotone') — Type of the curveChartData (required) — Data used to display chartstring (required) — Key of the data object for x-axis valuesMantineChartDotProps — Props passed down to all dots. Ignored if withDots={false} is set.number (default 0.2) — Controls fill opacity of all areas"none" | "x" | "y" | "xy" — Specifies which lines should be displayed in the grid, 'x' by defaultMantineColor — Color of the grid and cursor lines, by default depends on color schemeRechartsProps — Props passed down to the CartesianGrid componentRechartsProps — Props passed down to the Legend component"horizontal" | "vertical" — Chart orientation, 'horizontal' by defaultChartReferenceAreaProps[] — Reference areas that should be displayed on the chartChartReferenceDotProps[] — Reference dots that should be displayed on the chartChartReferenceLineProps[] — Reference lines that should be displayed on the chartstring — A label to display next to the right y-axisRechartsProps — Props passed down to the YAxis recharts component rendered on the right sideAreaChartSeries[] (required) — An array of objects with name and color keys. Determines which data should be consumed from the data array.[MantineColor, MantineColor] (default ['green.7', 'red.7']) — A tuple of colors used when type="split" is set, ignored in all other cases. A tuple may include theme colors reference or any valid CSS colorsnumber — Offset for the split gradient. By default, value is inferred from data and series if possible. Must be generated from the data array with getSplitOffset function.string | number — Dash array for the grid lines and cursor, '5 5' by defaultnumber (default 2) — Stroke width for the chart areasMantineColor — Color of the text displayed inside the chart, 'dimmed' by default"none" | "x" | "y" | "xy" — Specifies which axis should have tick line, 'y' by defaultnumber — Tooltip position animation duration in ms, 0 by defaultRechartsProps — Props passed down to the Tooltip componentAreaChartType (default 'default') — Controls how chart areas are positioned relative to each other. Set to 'stream' to render a streamgraph.string — Unit displayed next to each tick in y-axis(value: number) => string — A function to format values on Y axis and inside the tooltipboolean — Determines whether a brush (range selector) should be displayed under the chart, false by defaultboolean (default true) — Determines whether dots should be displayedboolean (default false) — Determines whether the chart area should be represented with a gradient instead of the solid colorboolean — Determines whether chart legend should be displayed, false by defaultboolean (default false) — If set, each point has an associated labelboolean — Determines whether additional y-axis should be displayed on the right side of the chart, false by defaultboolean — Determines whether chart tooltip should be displayed, true by defaultboolean (default true) — Determines whether x-axis should be displayed. Defaults to false for type="stream" with orientation="vertical" – the floating baseline makes the values not meaningful to read off.boolean (default true) — Determines whether y-axis should be displayed. Defaults to false for type="stream" with orientation="horizontal" – the floating baseline makes the values not meaningful to read off.string — A label to display below the x-axisRechartsProps — Props passed down to the XAxis recharts componentstring — A label to display next to the y-axisRechartsProps — Props passed down to the YAxis recharts componentOptional leading props map; remaining args are children.
AreaChart — Area chart component with stacked, percent and split variants
https://mantine.dev/charts/area-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **activeDotProps** `MantineChartDotProps` — Props passed down to all active dots. Ignored if `withDots={false}` is set.
- **areaChartProps** `(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `AreaChart` component
- **areaProps** `((series: AreaChartSeries) => Partial<Omit<Props<any, any>, "ref">>) | Partial<Omit<Props<any, any>, "ref">>` — Props passed down to recharts `Area` component
- **brushProps** `RechartsProps` — Props passed down to the `Brush` component
- **children** `React.ReactNode` — Additional components that are rendered inside recharts `AreaChart` component
- **connectNulls** `boolean` _(default `true`)_ — If set, points with `null` values are connected
- **curveType** `AreaChartCurveType` _(default `'monotone'`)_ — Type of the curve
- **data** `ChartData` **(required)** — Data used to display chart
- **dataKey** `string` **(required)** — Key of the `data` object for x-axis values
- **dotProps** `MantineChartDotProps` — Props passed down to all dots. Ignored if `withDots={false}` is set.
- **fillOpacity** `number` _(default `0.2`)_ — Controls fill opacity of all areas
- **gridAxis** `"none" | "x" | "y" | "xy"` — Specifies which lines should be displayed in the grid, `'x'` by default
- **gridColor** `MantineColor` — Color of the grid and cursor lines, by default depends on color scheme
- **gridProps** `RechartsProps` — Props passed down to the `CartesianGrid` component
- **legendProps** `RechartsProps` — Props passed down to the `Legend` component
- **orientation** `"horizontal" | "vertical"` — Chart orientation, `'horizontal'` by default
- **referenceAreas** `ChartReferenceAreaProps[]` — Reference areas that should be displayed on the chart
- **referenceDots** `ChartReferenceDotProps[]` — Reference dots that should be displayed on the chart
- **referenceLines** `ChartReferenceLineProps[]` — Reference lines that should be displayed on the chart
- **rightYAxisLabel** `string` — A label to display next to the right y-axis
- **rightYAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component rendered on the right side
- **series** `AreaChartSeries[]` **(required)** — An array of objects with `name` and `color` keys. Determines which data should be consumed from the `data` array.
- **splitColors** `[MantineColor, MantineColor]` _(default `['green.7', 'red.7']`)_ — A tuple of colors used when `type="split"` is set, ignored in all other cases. A tuple may include theme colors reference or any valid CSS colors
- **splitOffset** `number` — Offset for the split gradient. By default, value is inferred from `data` and `series` if possible. Must be generated from the data array with `getSplitOffset` function.
- **strokeDasharray** `string | number` — Dash array for the grid lines and cursor, `'5 5'` by default
- **strokeWidth** `number` _(default `2`)_ — Stroke width for the chart areas
- **textColor** `MantineColor` — Color of the text displayed inside the chart, `'dimmed'` by default
- **tickLine** `"none" | "x" | "y" | "xy"` — Specifies which axis should have tick line, `'y'` by default
- **tooltipAnimationDuration** `number` — Tooltip position animation duration in ms, `0` by default
- **tooltipProps** `RechartsProps` — Props passed down to the `Tooltip` component
- **type** `AreaChartType` _(default `'default'`)_ — Controls how chart areas are positioned relative to each other. Set to `'stream'` to render a streamgraph.
- **unit** `string` — Unit displayed next to each tick in y-axis
- **valueFormatter** `(value: number) => string` — A function to format values on Y axis and inside the tooltip
- **withBrush** `boolean` — Determines whether a brush (range selector) should be displayed under the chart, `false` by default
- **withDots** `boolean` _(default `true`)_ — Determines whether dots should be displayed
- **withGradient** `boolean` _(default `false`)_ — Determines whether the chart area should be represented with a gradient instead of the solid color
- **withLegend** `boolean` — Determines whether chart legend should be displayed, `false` by default
- **withPointLabels** `boolean` _(default `false`)_ — If set, each point has an associated label
- **withRightYAxis** `boolean` — Determines whether additional y-axis should be displayed on the right side of the chart, `false` by default
- **withTooltip** `boolean` — Determines whether chart tooltip should be displayed, `true` by default
- **withXAxis** `boolean` _(default `true`)_ — Determines whether x-axis should be displayed. Defaults to `false` for `type="stream"` with `orientation="vertical"` – the floating baseline makes the values not meaningful to read off.
- **withYAxis** `boolean` _(default `true`)_ — Determines whether y-axis should be displayed. Defaults to `false` for `type="stream"` with `orientation="horizontal"` – the floating baseline makes the values not meaningful to read off.
- **xAxisLabel** `string` — A label to display below the x-axis
- **xAxisProps** `RechartsProps` — Props passed down to the `XAxis` recharts component
- **yAxisLabel** `string` — A label to display next to the y-axis
- **yAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component
Optional leading props map; remaining args are children.BarChart — Bar chart component with stacked and percent variants
https://mantine.dev/charts/bar-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by default(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts BarChart componentMantineColor — Controls color of the bar label, by default the value is determined by the chart orientation((series: BarChartSeries) => Partial<Omit<Props, "ref">>) | Partial<Omit<Props, "ref">> — Props passed down to recharts Bar componentRechartsProps — Props passed down to the Brush componentReact.ReactNode — Additional components that are rendered inside recharts BarChart componentMantineColor — Fill of hovered bar section, by default value is based on color schemeRecord<string, any>[] (required) — Data used to display chart.string (required) — Key of the data object for x-axis valuesnumber (default 1) — Controls fill opacity of all bars(value: number, series: BarChartSeries) => DefaultMantineColor — A function to assign dynamic bar color based on its value"none" | "x" | "y" | "xy" — Specifies which lines should be displayed in the grid, 'x' by defaultMantineColor — Color of the grid and cursor lines, by default depends on color schemeRechartsProps — Props passed down to the CartesianGrid componentRechartsProps — Props passed down to the Legend componentnumber — Maximum bar width in pxnumber (default 0) — Sets minimum height of the bar in px"horizontal" | "vertical" — Chart orientation, 'horizontal' by defaultChartReferenceAreaProps[] — Reference areas that should be displayed on the chartChartReferenceDotProps[] — Reference dots that should be displayed on the chartChartReferenceLineProps[] — Reference lines that should be displayed on the chartstring — A label to display next to the right y-axisRechartsProps — Props passed down to the YAxis recharts component rendered on the right sideBarChartSeries[] (required) — An array of objects with name and color keys. Determines which data should be consumed from the data array.string | number — Dash array for the grid lines and cursor, '5 5' by defaultMantineColor — Color of the text displayed inside the chart, 'dimmed' by default"none" | "x" | "y" | "xy" — Specifies which axis should have tick line, 'y' by defaultnumber — Tooltip position animation duration in ms, 0 by defaultRechartsProps — Props passed down to the Tooltip componentBarChartType (default 'default') — Controls how bars are positioned relative to each otherstring — Unit displayed next to each tick in y-axis(value: number) => string — A function to format values on Y axis and inside the tooltip((series: BarChartSeries) => Partial<Omit<Props, "ref">>) | Partial<Props> — Props passed down to recharts LabelList componentboolean (default false) — Determines whether a label with bar value should be displayed on top of each bar, incompatible with type="stacked" and type="percent"boolean — Determines whether a brush (range selector) should be displayed under the chart, false by defaultboolean — Determines whether chart legend should be displayed, false by defaultboolean — Determines whether additional y-axis should be displayed on the right side of the chart, false by defaultboolean — Determines whether chart tooltip should be displayed, true by defaultboolean — Determines whether x-axis should be displayed, true by defaultboolean — Determines whether y-axis should be displayed, true by defaultstring — A label to display below the x-axisRechartsProps — Props passed down to the XAxis recharts componentstring — A label to display next to the y-axisRechartsProps — Props passed down to the YAxis recharts componentOptional leading props map; remaining args are children.
BarChart — Bar chart component with stacked and percent variants
https://mantine.dev/charts/bar-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **barChartProps** `(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `BarChart` component
- **barLabelColor** `MantineColor` — Controls color of the bar label, by default the value is determined by the chart orientation
- **barProps** `((series: BarChartSeries) => Partial<Omit<Props, "ref">>) | Partial<Omit<Props, "ref">>` — Props passed down to recharts `Bar` component
- **brushProps** `RechartsProps` — Props passed down to the `Brush` component
- **children** `React.ReactNode` — Additional components that are rendered inside recharts `BarChart` component
- **cursorFill** `MantineColor` — Fill of hovered bar section, by default value is based on color scheme
- **data** `Record<string, any>[]` **(required)** — Data used to display chart.
- **dataKey** `string` **(required)** — Key of the `data` object for x-axis values
- **fillOpacity** `number` _(default `1`)_ — Controls fill opacity of all bars
- **getBarColor** `(value: number, series: BarChartSeries) => DefaultMantineColor` — A function to assign dynamic bar color based on its value
- **gridAxis** `"none" | "x" | "y" | "xy"` — Specifies which lines should be displayed in the grid, `'x'` by default
- **gridColor** `MantineColor` — Color of the grid and cursor lines, by default depends on color scheme
- **gridProps** `RechartsProps` — Props passed down to the `CartesianGrid` component
- **legendProps** `RechartsProps` — Props passed down to the `Legend` component
- **maxBarWidth** `number` — Maximum bar width in px
- **minBarSize** `number` _(default `0`)_ — Sets minimum height of the bar in px
- **orientation** `"horizontal" | "vertical"` — Chart orientation, `'horizontal'` by default
- **referenceAreas** `ChartReferenceAreaProps[]` — Reference areas that should be displayed on the chart
- **referenceDots** `ChartReferenceDotProps[]` — Reference dots that should be displayed on the chart
- **referenceLines** `ChartReferenceLineProps[]` — Reference lines that should be displayed on the chart
- **rightYAxisLabel** `string` — A label to display next to the right y-axis
- **rightYAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component rendered on the right side
- **series** `BarChartSeries[]` **(required)** — An array of objects with `name` and `color` keys. Determines which data should be consumed from the `data` array.
- **strokeDasharray** `string | number` — Dash array for the grid lines and cursor, `'5 5'` by default
- **textColor** `MantineColor` — Color of the text displayed inside the chart, `'dimmed'` by default
- **tickLine** `"none" | "x" | "y" | "xy"` — Specifies which axis should have tick line, `'y'` by default
- **tooltipAnimationDuration** `number` — Tooltip position animation duration in ms, `0` by default
- **tooltipProps** `RechartsProps` — Props passed down to the `Tooltip` component
- **type** `BarChartType` _(default `'default'`)_ — Controls how bars are positioned relative to each other
- **unit** `string` — Unit displayed next to each tick in y-axis
- **valueFormatter** `(value: number) => string` — A function to format values on Y axis and inside the tooltip
- **valueLabelProps** `((series: BarChartSeries) => Partial<Omit<Props, "ref">>) | Partial<Props>` — Props passed down to recharts `LabelList` component
- **withBarValueLabel** `boolean` _(default `false`)_ — Determines whether a label with bar value should be displayed on top of each bar, incompatible with `type="stacked"` and `type="percent"`
- **withBrush** `boolean` — Determines whether a brush (range selector) should be displayed under the chart, `false` by default
- **withLegend** `boolean` — Determines whether chart legend should be displayed, `false` by default
- **withRightYAxis** `boolean` — Determines whether additional y-axis should be displayed on the right side of the chart, `false` by default
- **withTooltip** `boolean` — Determines whether chart tooltip should be displayed, `true` by default
- **withXAxis** `boolean` — Determines whether x-axis should be displayed, `true` by default
- **withYAxis** `boolean` — Determines whether y-axis should be displayed, `true` by default
- **xAxisLabel** `string` — A label to display below the x-axis
- **xAxisProps** `RechartsProps` — Props passed down to the `XAxis` recharts component
- **yAxisLabel** `string` — A label to display next to the y-axis
- **yAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component
Optional leading props map; remaining args are children.BarsList — Display a list of bars with names and values
https://mantine.dev/charts/bars-list
Props (docgen 9.6.0):
boolean — If set, adjusts text color based on background colorMantineColor — Default bar background color, used when item does not have color specifiedMantineSpacing (default 5) — Controls gap between barsstring | number (default 32) — Bar heightMantineColor — Bar text color, overrides autoContraststring — Label displayed above the bars columnBarsListBarData[] (required) — Data for bars(data: BarsListBarData) => DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement> — Function to pass props down to the bar depending on the bar data payloadstring | number (default 100) — Minimum bar width(data: BarsListBarData, defaultBar: ReactNode) => ReactNode — Function to completely customize bar rendering(value: number) => string — Function to format value displaystring — Label displayed above the values columnOptional leading props map; remaining args are children.
BarsList — Display a list of bars with names and values https://mantine.dev/charts/bars-list Props (docgen 9.6.0): - **autoContrast** `boolean` — If set, adjusts text color based on background color - **barColor** `MantineColor` — Default bar background color, used when item does not have color specified - **barGap** `MantineSpacing` _(default `5`)_ — Controls gap between bars - **barHeight** `string | number` _(default `32`)_ — Bar height - **barTextColor** `MantineColor` — Bar text color, overrides autoContrast - **barsLabel** `string` — Label displayed above the bars column - **data** `BarsListBarData[]` **(required)** — Data for bars - **getBarProps** `(data: BarsListBarData) => DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>` — Function to pass props down to the bar depending on the bar data payload - **minBarSize** `string | number` _(default `100`)_ — Minimum bar width - **renderBar** `(data: BarsListBarData, defaultBar: ReactNode) => ReactNode` — Function to completely customize bar rendering - **valueFormatter** `(value: number) => string` — Function to format value display - **valueLabel** `string` — Label displayed above the values column Optional leading props map; remaining args are children.
BubbleChart — Bubble chart component
https://mantine.dev/charts/bubble-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultMantineColor (default blue.6) — Color of the chart items. Key of theme.colors or any valid CSS color.Record<string, any>[] (required) — Chart dataBubbleChartDataKey (required) — Data keys for x, y and z axisMantineColor — Color of the grid and cursor lines, by default depends on color schemestring — Chart label displayed next to the x axis[number, number] (required) — Z axis rangePartial<Omit<Props, "ref">> — Props passed down to the Scatter componentMantineColor (default 'dimmed') — Color of the text displayed inside the chartRechartsProps — Props passed down to the Tooltip component(value: number) => string — Function to format z axis valuesboolean (default true) — Determines whether the tooltip should be displayedRechartsProps — Props passed down to the XAxis recharts componentRechartsProps — Props passed down to the YAxis recharts componentOmit<Props<any, any>, "ref"> — Props passed down to the ZAxis recharts componentOptional leading props map; remaining args are children.
BubbleChart — Bubble chart component https://mantine.dev/charts/bubble-chart Props (docgen 9.6.0): - **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default - **color** `MantineColor` _(default `blue.6`)_ — Color of the chart items. Key of `theme.colors` or any valid CSS color. - **data** `Record<string, any>[]` **(required)** — Chart data - **dataKey** `BubbleChartDataKey` **(required)** — Data keys for x, y and z axis - **gridColor** `MantineColor` — Color of the grid and cursor lines, by default depends on color scheme - **label** `string` — Chart label displayed next to the x axis - **range** `[number, number]` **(required)** — Z axis range - **scatterProps** `Partial<Omit<Props, "ref">>` — Props passed down to the `Scatter` component - **textColor** `MantineColor` _(default `'dimmed'`)_ — Color of the text displayed inside the chart - **tooltipProps** `RechartsProps` — Props passed down to the `Tooltip` component - **valueFormatter** `(value: number) => string` — Function to format z axis values - **withTooltip** `boolean` _(default `true`)_ — Determines whether the tooltip should be displayed - **xAxisProps** `RechartsProps` — Props passed down to the `XAxis` recharts component - **yAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component - **zAxisProps** `Omit<Props<any, any>, "ref">` — Props passed down to the `ZAxis` recharts component Optional leading props map; remaining args are children.
BulletChart — Compact KPI chart with value, target, and qualitative ranges
https://mantine.dev/charts/bullet-chart
Props (docgen 9.6.0):
MantineColor (default 'white') — Color of the actual value bar,string | number (default 16) — Height of the actual value bar,((data: { value: number; target?: number; }) => ReactNode) | undefined — Custom tooltip contentReact.ReactNode — Label displayed next to the chart"horizontal" | "vertical" (default 'horizontal') — Orientation,BulletChartRange[] (required) — Qualitative ranges displayed as background bandsstring | number (default 32) — Height of the chart track area (ranges),number — Target value, displayed as a marker lineMantineColor (default 'dark' for light, 'white' for dark) — Color of the target marker,number (default 0.7) — Target marker size relative to chart size,string | number (default 2) — Target marker thickness,number (required) — Current actual value(value: number) => string — Value formatter for tooltip/display and labelsboolean (default false) — Whether to show tooltip on hover,Optional leading props map; remaining args are children.
BulletChart — Compact KPI chart with value, target, and qualitative ranges
https://mantine.dev/charts/bullet-chart
Props (docgen 9.6.0):
- **barColor** `MantineColor` _(default `'white'`)_ — Color of the actual value bar,
- **barSize** `string | number` _(default `16`)_ — Height of the actual value bar,
- **getTooltipLabel** `((data: { value: number; target?: number; }) => ReactNode) | undefined` — Custom tooltip content
- **label** `React.ReactNode` — Label displayed next to the chart
- **orientation** `"horizontal" | "vertical"` _(default `'horizontal'`)_ — Orientation,
- **ranges** `BulletChartRange[]` **(required)** — Qualitative ranges displayed as background bands
- **size** `string | number` _(default `32`)_ — Height of the chart track area (ranges),
- **target** `number` — Target value, displayed as a marker line
- **targetColor** `MantineColor` _(default `'dark' for light, 'white' for dark`)_ — Color of the target marker,
- **targetRatio** `number` _(default `0.7`)_ — Target marker size relative to chart size,
- **targetSize** `string | number` _(default `2`)_ — Target marker thickness,
- **value** `number` **(required)** — Current actual value
- **valueFormatter** `(value: number) => string` — Value formatter for tooltip/display and labels
- **withTooltip** `boolean` _(default `false`)_ — Whether to show tooltip on hover,
Optional leading props map; remaining args are children.CandlestickChart — Financial OHLC candlestick chart
https://mantine.dev/charts/candlestick-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultnumber (default 1) — Stroke width of the candle wick and body outlineReact.ReactNode — Additional components that are rendered inside recharts ComposedChart component(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts ComposedChart componentRecord<string, any>[] (required) — Data used to display chartstring (required) — Key of the data object for x-axis valuesCandlestickChartDataKeys (default { open: 'open', high: 'high', low: 'low', close: 'close' }) — Keys of the data object used to read open, high, low and close valuesMantineColor (default 'red.6') — Color of candles with close < open, key of theme.colors or any valid CSS color"none" | "x" | "y" | "xy" — Specifies which lines should be displayed in the grid, 'x' by defaultMantineColor — Color of the grid and cursor lines, by default depends on color schemeRechartsProps — Props passed down to the CartesianGrid componentPartial<CandlestickChartLabels> (default { open: 'Open', high: 'High', low: 'Low', close: 'Close' }) — Labels of open, high, low and close values displayed in the tooltipnumber — Maximum candle width in pxChartReferenceAreaProps[] — Reference areas that should be displayed on the chartChartReferenceDotProps[] — Reference dots that should be displayed on the chartChartReferenceLineProps[] — Reference lines that should be displayed on the chartstring | number — Dash array for the grid lines and cursor, '5 5' by defaultMantineColor — Color of the text displayed inside the chart, 'dimmed' by default"none" | "x" | "y" | "xy" — Specifies which axis should have tick line, 'y' by defaultnumber — Tooltip position animation duration in ms, 0 by defaultRechartsProps — Props passed down to the Tooltip componentstring — Unit displayed next to each tick in y-axisMantineColor (default 'teal.6') — Color of candles with close >= open, key of theme.colors or any valid CSS color(value: number) => string — A function to format values on Y axis and inside the tooltipboolean — Determines whether chart tooltip should be displayed, true by defaultboolean — Determines whether x-axis should be displayed, true by defaultboolean — Determines whether y-axis should be displayed, true by defaultstring — A label to display below the x-axisRechartsProps — Props passed down to the XAxis recharts componentstring — A label to display next to the y-axisRechartsProps — Props passed down to the YAxis recharts componentOptional leading props map; remaining args are children.
CandlestickChart — Financial OHLC candlestick chart
https://mantine.dev/charts/candlestick-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **candleStrokeWidth** `number` _(default `1`)_ — Stroke width of the candle wick and body outline
- **children** `React.ReactNode` — Additional components that are rendered inside recharts `ComposedChart` component
- **composedChartProps** `(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `ComposedChart` component
- **data** `Record<string, any>[]` **(required)** — Data used to display chart
- **dataKey** `string` **(required)** — Key of the `data` object for x-axis values
- **dataKeys** `CandlestickChartDataKeys` _(default ``{ open: 'open', high: 'high', low: 'low', close: 'close' }``)_ — Keys of the `data` object used to read open, high, low and close values
- **downColor** `MantineColor` _(default `'red.6'`)_ — Color of candles with `close < open`, key of `theme.colors` or any valid CSS color
- **gridAxis** `"none" | "x" | "y" | "xy"` — Specifies which lines should be displayed in the grid, `'x'` by default
- **gridColor** `MantineColor` — Color of the grid and cursor lines, by default depends on color scheme
- **gridProps** `RechartsProps` — Props passed down to the `CartesianGrid` component
- **labels** `Partial<CandlestickChartLabels>` _(default ``{ open: 'Open', high: 'High', low: 'Low', close: 'Close' }``)_ — Labels of open, high, low and close values displayed in the tooltip
- **maxCandleWidth** `number` — Maximum candle width in px
- **referenceAreas** `ChartReferenceAreaProps[]` — Reference areas that should be displayed on the chart
- **referenceDots** `ChartReferenceDotProps[]` — Reference dots that should be displayed on the chart
- **referenceLines** `ChartReferenceLineProps[]` — Reference lines that should be displayed on the chart
- **strokeDasharray** `string | number` — Dash array for the grid lines and cursor, `'5 5'` by default
- **textColor** `MantineColor` — Color of the text displayed inside the chart, `'dimmed'` by default
- **tickLine** `"none" | "x" | "y" | "xy"` — Specifies which axis should have tick line, `'y'` by default
- **tooltipAnimationDuration** `number` — Tooltip position animation duration in ms, `0` by default
- **tooltipProps** `RechartsProps` — Props passed down to the `Tooltip` component
- **unit** `string` — Unit displayed next to each tick in y-axis
- **upColor** `MantineColor` _(default `'teal.6'`)_ — Color of candles with `close >= open`, key of `theme.colors` or any valid CSS color
- **valueFormatter** `(value: number) => string` — A function to format values on Y axis and inside the tooltip
- **withTooltip** `boolean` — Determines whether chart tooltip should be displayed, `true` by default
- **withXAxis** `boolean` — Determines whether x-axis should be displayed, `true` by default
- **withYAxis** `boolean` — Determines whether y-axis should be displayed, `true` by default
- **xAxisLabel** `string` — A label to display below the x-axis
- **xAxisProps** `RechartsProps` — Props passed down to the `XAxis` recharts component
- **yAxisLabel** `string` — A label to display next to the y-axis
- **yAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component
Optional leading props map; remaining args are children.ChartBrush
Optional leading props map; remaining args are children.
ChartBrush Optional leading props map; remaining args are children.
ChartLegend
Props (docgen 9.6.0):
boolean (default false) — Determines whether the legend should be centered"bottom" | "top" | "middle" (required) — Position of the legend relative to the chart, used to apply margin on the corresponding side(area: string | number | null) => void (required) — Function called when mouse enters/leaves one of the legend itemsreadonly Record<string, any>[] (required) — Chart data provided by rechartsChartSeries[] — Data used for labels, only applicable for area charts: AreaChart, LineChart, BarChartboolean (default true) — Determines whether color swatch should be shown next to the labelOptional leading props map; remaining args are children.
ChartLegend Props (docgen 9.6.0): - **centered** `boolean` _(default `false`)_ — Determines whether the legend should be centered - **legendPosition** `"bottom" | "top" | "middle"` **(required)** — Position of the legend relative to the chart, used to apply margin on the corresponding side - **onHighlight** `(area: string | number | null) => void` **(required)** — Function called when mouse enters/leaves one of the legend items - **payload** `readonly Record<string, any>[]` **(required)** — Chart data provided by recharts - **series** `ChartSeries[]` — Data used for labels, only applicable for area charts: AreaChart, LineChart, BarChart - **showColor** `boolean` _(default `true`)_ — Determines whether color swatch should be shown next to the label Optional leading props map; remaining args are children.
ChartTooltip
Props (docgen 9.6.0):
React.ReactNode — Main tooltip labelRecord<string, any>[] | readonly Record<string, any>[] (required) — Chart data provided by rechartsstring | number — Segment to display data for, identified by its index in the data array (preferred, isolates duplicate names) or by its name. Only applicable when type="radial". If not set, all data is rendered.ChartSeries[] — Chart series data, applicable only for area typeboolean (default true) — Determines whether the color swatch should be visible"area" | "radial" | "scatter" (default 'area') — Tooltip type that determines the content and styles, area for LineChart, AreaChart and BarChart, radial for DonutChart and PieChartstring — Data units, provided by parent component(value: number) => ReactNode — A function to format valuesOptional leading props map; remaining args are children.
ChartTooltip Props (docgen 9.6.0): - **label** `React.ReactNode` — Main tooltip label - **payload** `Record<string, any>[] | readonly Record<string, any>[]` **(required)** — Chart data provided by recharts - **segmentId** `string | number` — Segment to display data for, identified by its index in the data array (preferred, isolates duplicate names) or by its name. Only applicable when `type="radial"`. If not set, all data is rendered. - **series** `ChartSeries[]` — Chart series data, applicable only for `area` type - **showColor** `boolean` _(default `true`)_ — Determines whether the color swatch should be visible - **type** `"area" | "radial" | "scatter"` _(default `'area'`)_ — Tooltip type that determines the content and styles, `area` for LineChart, AreaChart and BarChart, `radial` for DonutChart and PieChart - **unit** `string` — Data units, provided by parent component - **valueFormatter** `(value: number) => ReactNode` — A function to format values Optional leading props map; remaining args are children.
CompositeChart — Composed chart with support for Area, Bar and Line charts
https://mantine.dev/charts/composite-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultMantineChartDotProps — Props passed down to all active dots. Ignored if withDots={false} is set.Partial<Omit<Props<any, any>, "ref">> | ((series: CompositeChartSeries) => Partial<Omit<Props<any, any>, "ref">>) — Props passed down to recharts Area componentPartial<Omit<Props, "ref">> | ((series: CompositeChartSeries) => Partial<Omit<Props, "ref">>) — Props passed down to recharts Bar componentRechartsProps — Props passed down to the Brush componentReact.ReactNode — Additional components that are rendered inside recharts AreaChart component(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts AreaChart componentboolean (default true) — Determines whether points with null values should be connectedCompositeChartCurveType (default 'monotone') — Type of the curveRecord<string, any>[] (required) — Data used to display chartstring (required) — Key of the data object for x-axis valuesMantineChartDotProps — Props passed down to all dots. Ignored if withDots={false} is set."none" | "x" | "y" | "xy" — Specifies which lines should be displayed in the grid, 'x' by defaultMantineColor — Color of the grid and cursor lines, by default depends on color schemeRechartsProps — Props passed down to the CartesianGrid componentRechartsProps — Props passed down to the Legend component((series: CompositeChartSeries) => Partial<Omit<Props, "ref">>) | Partial<Omit<Props, "ref">> — Props passed down to recharts Line componentnumber — Maximum bar width in pxnumber (default 0) — Sets minimum height of the bar in pxChartReferenceAreaProps[] — Reference areas that should be displayed on the chartChartReferenceDotProps[] — Reference dots that should be displayed on the chartChartReferenceLineProps[] — Reference lines that should be displayed on the chartstring — A label to display next to the right y-axisRechartsProps — Props passed down to the YAxis recharts component rendered on the right sideCompositeChartSeries[] (required) — An array of objects with name and color keys. Determines which data should be consumed from the data array.string | number — Dash array for the grid lines and cursor, '5 5' by defaultnumber (default 2) — Stroke width for the chart linesMantineColor — Color of the text displayed inside the chart, 'dimmed' by default"none" | "x" | "y" | "xy" — Specifies which axis should have tick line, 'y' by defaultnumber — Tooltip position animation duration in ms, 0 by defaultRechartsProps — Props passed down to the Tooltip componentstring — Unit displayed next to each tick in y-axis(value: number) => string — A function to format values on Y axis and inside the tooltipboolean (default false) — Determines whether a label with bar value should be displayed on top of each barboolean — Determines whether a brush (range selector) should be displayed under the chart, false by defaultboolean (default true) — Determines whether dots should be displayedboolean — Determines whether chart legend should be displayed, false by defaultboolean (default false) — Determines whether each point should have associated labelboolean — Determines whether additional y-axis should be displayed on the right side of the chart, false by defaultboolean — Determines whether chart tooltip should be displayed, true by defaultboolean — Determines whether x-axis should be displayed, true by defaultboolean — Determines whether y-axis should be displayed, true by defaultstring — A label to display below the x-axisRechartsProps — Props passed down to the XAxis recharts componentstring — A label to display next to the y-axisRechartsProps — Props passed down to the YAxis recharts componentOptional leading props map; remaining args are children.
CompositeChart — Composed chart with support for Area, Bar and Line charts
https://mantine.dev/charts/composite-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **activeDotProps** `MantineChartDotProps` — Props passed down to all active dots. Ignored if `withDots={false}` is set.
- **areaProps** `Partial<Omit<Props<any, any>, "ref">> | ((series: CompositeChartSeries) => Partial<Omit<Props<any, any>, "ref">>)` — Props passed down to recharts `Area` component
- **barProps** `Partial<Omit<Props, "ref">> | ((series: CompositeChartSeries) => Partial<Omit<Props, "ref">>)` — Props passed down to recharts `Bar` component
- **brushProps** `RechartsProps` — Props passed down to the `Brush` component
- **children** `React.ReactNode` — Additional components that are rendered inside recharts `AreaChart` component
- **composedChartProps** `(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `AreaChart` component
- **connectNulls** `boolean` _(default `true`)_ — Determines whether points with `null` values should be connected
- **curveType** `CompositeChartCurveType` _(default `'monotone'`)_ — Type of the curve
- **data** `Record<string, any>[]` **(required)** — Data used to display chart
- **dataKey** `string` **(required)** — Key of the `data` object for x-axis values
- **dotProps** `MantineChartDotProps` — Props passed down to all dots. Ignored if `withDots={false}` is set.
- **gridAxis** `"none" | "x" | "y" | "xy"` — Specifies which lines should be displayed in the grid, `'x'` by default
- **gridColor** `MantineColor` — Color of the grid and cursor lines, by default depends on color scheme
- **gridProps** `RechartsProps` — Props passed down to the `CartesianGrid` component
- **legendProps** `RechartsProps` — Props passed down to the `Legend` component
- **lineProps** `((series: CompositeChartSeries) => Partial<Omit<Props, "ref">>) | Partial<Omit<Props, "ref">>` — Props passed down to recharts `Line` component
- **maxBarWidth** `number` — Maximum bar width in px
- **minBarSize** `number` _(default `0`)_ — Sets minimum height of the bar in px
- **referenceAreas** `ChartReferenceAreaProps[]` — Reference areas that should be displayed on the chart
- **referenceDots** `ChartReferenceDotProps[]` — Reference dots that should be displayed on the chart
- **referenceLines** `ChartReferenceLineProps[]` — Reference lines that should be displayed on the chart
- **rightYAxisLabel** `string` — A label to display next to the right y-axis
- **rightYAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component rendered on the right side
- **series** `CompositeChartSeries[]` **(required)** — An array of objects with `name` and `color` keys. Determines which data should be consumed from the `data` array.
- **strokeDasharray** `string | number` — Dash array for the grid lines and cursor, `'5 5'` by default
- **strokeWidth** `number` _(default `2`)_ — Stroke width for the chart lines
- **textColor** `MantineColor` — Color of the text displayed inside the chart, `'dimmed'` by default
- **tickLine** `"none" | "x" | "y" | "xy"` — Specifies which axis should have tick line, `'y'` by default
- **tooltipAnimationDuration** `number` — Tooltip position animation duration in ms, `0` by default
- **tooltipProps** `RechartsProps` — Props passed down to the `Tooltip` component
- **unit** `string` — Unit displayed next to each tick in y-axis
- **valueFormatter** `(value: number) => string` — A function to format values on Y axis and inside the tooltip
- **withBarValueLabel** `boolean` _(default `false`)_ — Determines whether a label with bar value should be displayed on top of each bar
- **withBrush** `boolean` — Determines whether a brush (range selector) should be displayed under the chart, `false` by default
- **withDots** `boolean` _(default `true`)_ — Determines whether dots should be displayed
- **withLegend** `boolean` — Determines whether chart legend should be displayed, `false` by default
- **withPointLabels** `boolean` _(default `false`)_ — Determines whether each point should have associated label
- **withRightYAxis** `boolean` — Determines whether additional y-axis should be displayed on the right side of the chart, `false` by default
- **withTooltip** `boolean` — Determines whether chart tooltip should be displayed, `true` by default
- **withXAxis** `boolean` — Determines whether x-axis should be displayed, `true` by default
- **withYAxis** `boolean` — Determines whether y-axis should be displayed, `true` by default
- **xAxisLabel** `string` — A label to display below the x-axis
- **xAxisProps** `RechartsProps` — Props passed down to the `XAxis` recharts component
- **yAxisLabel** `string` — A label to display next to the y-axis
- **yAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component
Optional leading props map; remaining args are children.DonutChart — Donut chart component
https://mantine.dev/charts/donut-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by default((series: DonutChartCell) => Partial<Omit<SVGProps<SVGElement>, "ref">>) | Partial<Omit<SVGProps<SVGElement>, "ref">> — Props passed down to each segment of the chartstring | number — Chart label, displayed in the center of the chartReact.ReactNode — Additional elements rendered inside PieChart componentDonutChartCell[] (required) — Data used to render chartnumber (default 360) — Controls angle at which charts ends. Set to 0 to render the chart as semicircle.MantineColor — Controls text color of all labels, by default depends on color scheme"value" | "name" | "percent" — Type of labels to display, 'value' by defaultRechartsProps — Props passed down to recharts Legend componentnumber (default 0) — Controls padding between segments(PolarChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts PieChart componentPartial<Omit<Props, "ref">> — Props passed down to recharts Pie componentnumber (default 80) — Controls chart width and height, height is increased by 40 if withLabels prop is set. Cannot be less than thickness.number (default 0) — Controls angle at which chart starts. Set to 180 to render the chart as semicircle.MantineColor — Controls color of the segments stroke, by default depends on color schemenumber (default 1) — Controls width of segments strokenumber (default 20) — Controls thickness of the chart segmentsnumber (default 0) — Tooltip animation duration in ms"all" | "segment" (default 'all') — Determines which data is displayed in the tooltip. 'all' – display all values, 'segment' – display only hovered segment.RechartsProps — Props passed down to Tooltip recharts component(value: number) => string — A function to format values inside the tooltipboolean (default false) — Determines whether each segment should have associated labelboolean (default true) — Determines whether segments labels should have lines that connect the segment with the labelboolean (default false) — Determines whether the legend should be displayedboolean (default true) — Determines whether the tooltip should be displayed when one of the section is hoveredOptional leading props map; remaining args are children.
DonutChart — Donut chart component
https://mantine.dev/charts/donut-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **cellProps** `((series: DonutChartCell) => Partial<Omit<SVGProps<SVGElement>, "ref">>) | Partial<Omit<SVGProps<SVGElement>, "ref">>` — Props passed down to each segment of the chart
- **chartLabel** `string | number` — Chart label, displayed in the center of the chart
- **children** `React.ReactNode` — Additional elements rendered inside `PieChart` component
- **data** `DonutChartCell[]` **(required)** — Data used to render chart
- **endAngle** `number` _(default `360`)_ — Controls angle at which charts ends. Set to `0` to render the chart as semicircle.
- **labelColor** `MantineColor` — Controls text color of all labels, by default depends on color scheme
- **labelsType** `"value" | "name" | "percent"` — Type of labels to display, `'value'` by default
- **legendProps** `RechartsProps` — Props passed down to recharts `Legend` component
- **paddingAngle** `number` _(default `0`)_ — Controls padding between segments
- **pieChartProps** `(PolarChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `PieChart` component
- **pieProps** `Partial<Omit<Props, "ref">>` — Props passed down to recharts `Pie` component
- **size** `number` _(default `80`)_ — Controls chart width and height, height is increased by 40 if `withLabels` prop is set. Cannot be less than `thickness`.
- **startAngle** `number` _(default `0`)_ — Controls angle at which chart starts. Set to `180` to render the chart as semicircle.
- **strokeColor** `MantineColor` — Controls color of the segments stroke, by default depends on color scheme
- **strokeWidth** `number` _(default `1`)_ — Controls width of segments stroke
- **thickness** `number` _(default `20`)_ — Controls thickness of the chart segments
- **tooltipAnimationDuration** `number` _(default `0`)_ — Tooltip animation duration in ms
- **tooltipDataSource** `"all" | "segment"` _(default `'all'`)_ — Determines which data is displayed in the tooltip. `'all'` – display all values, `'segment'` – display only hovered segment.
- **tooltipProps** `RechartsProps` — Props passed down to `Tooltip` recharts component
- **valueFormatter** `(value: number) => string` — A function to format values inside the tooltip
- **withLabels** `boolean` _(default `false`)_ — Determines whether each segment should have associated label
- **withLabelsLine** `boolean` _(default `true`)_ — Determines whether segments labels should have lines that connect the segment with the label
- **withLegend** `boolean` _(default `false`)_ — Determines whether the legend should be displayed
- **withTooltip** `boolean` _(default `true`)_ — Determines whether the tooltip should be displayed when one of the section is hovered
Optional leading props map; remaining args are children.FunnelChart — Funnel chart component
https://mantine.dev/charts/funnel-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultReact.ReactNode — Additional elements rendered inside FunnelChart componentFunnelChartCell[] (required) — Data used to render chart(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts FunnelChart componentPartial<Omit<Props, "ref">> — Props passed down to recharts Pie componentMantineColor (default 'white') — Controls text color of all labels"left" | "right" | "inside" (default 'right') — Controls labels position relative to the segmentRechartsProps — Props passed down to recharts Legend componentnumber (default 300) — Controls chart width and heightMantineColor — Controls color of the segments stroke, by default depends on color schemenumber (default 1) — Controls width of segments strokenumber (default 0) — Tooltip animation duration in ms"all" | "segment" (default 'all') — Determines which data is displayed in the tooltip. 'all' – display all values, 'segment' – display only hovered segment.RechartsProps — Props passed down to Tooltip recharts component(value: number) => string — A function to format values inside the tooltip and labelsboolean (default false) — Determines whether each segment should have associated labelboolean (default false) — Determines whether the legend should be displayedboolean (default true) — Determines whether the tooltip should be displayed when a section is hoveredOptional leading props map; remaining args are children.
FunnelChart — Funnel chart component
https://mantine.dev/charts/funnel-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **children** `React.ReactNode` — Additional elements rendered inside `FunnelChart` component
- **data** `FunnelChartCell[]` **(required)** — Data used to render chart
- **funnelChartProps** `(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `FunnelChart` component
- **funnelProps** `Partial<Omit<Props, "ref">>` — Props passed down to recharts `Pie` component
- **labelColor** `MantineColor` _(default `'white'`)_ — Controls text color of all labels
- **labelsPosition** `"left" | "right" | "inside"` _(default `'right'`)_ — Controls labels position relative to the segment
- **legendProps** `RechartsProps` — Props passed down to recharts `Legend` component
- **size** `number` _(default `300`)_ — Controls chart width and height
- **strokeColor** `MantineColor` — Controls color of the segments stroke, by default depends on color scheme
- **strokeWidth** `number` _(default `1`)_ — Controls width of segments stroke
- **tooltipAnimationDuration** `number` _(default `0`)_ — Tooltip animation duration in ms
- **tooltipDataSource** `"all" | "segment"` _(default `'all'`)_ — Determines which data is displayed in the tooltip. `'all'` – display all values, `'segment'` – display only hovered segment.
- **tooltipProps** `RechartsProps` — Props passed down to `Tooltip` recharts component
- **valueFormatter** `(value: number) => string` — A function to format values inside the tooltip and labels
- **withLabels** `boolean` _(default `false`)_ — Determines whether each segment should have associated label
- **withLegend** `boolean` _(default `false`)_ — Determines whether the legend should be displayed
- **withTooltip** `boolean` _(default `true`)_ — Determines whether the tooltip should be displayed when a section is hovered
Optional leading props map; remaining args are children.GaugeChart — Radial gauge chart for KPI and status display
https://mantine.dev/charts/gauge-chart
Props (docgen 9.6.0):
number (default 120) — End angle in degrees,MantineColor — Color of the filled arc when sections are not providedReact.ReactNode — Label displayed in the center of the gaugenumber (default 100) — Maximum value of the gauge,number (default 0) — Minimum value of the gauge,boolean (default false) — Whether to round arc endpoints. Not applied to sections – rounded caps of adjacent sections would overlap each other.GaugeChartSection[] — Threshold sections of the gauge arc, each section is filled from the previous section upper bound to its own value. If set, the arc is not filled based on value.number (default 200) — Chart size (width and height),number (default -120) — Start angle in degrees,number — Value marked on the arc with a line marker, use to display a goal or the current value of a gauge with sectionsMantineColor — Color of the target markernumber (default 2) — Thickness of the target marker,number (default 12) — Arc thickness in px,MantineColor — Color of the gauge track (unfilled portion)number (required) — Current value to display. Fills the arc from min up to value, unless sections is set – then the arc is colored by thresholds and the value is displayed only in the center label.(value: number) => string (default (v) => String(v)) — Value formatter for default label,Optional leading props map; remaining args are children.
GaugeChart — Radial gauge chart for KPI and status display https://mantine.dev/charts/gauge-chart Props (docgen 9.6.0): - **endAngle** `number` _(default `120`)_ — End angle in degrees, - **filledColor** `MantineColor` — Color of the filled arc when sections are not provided - **label** `React.ReactNode` — Label displayed in the center of the gauge - **max** `number` _(default `100`)_ — Maximum value of the gauge, - **min** `number` _(default `0`)_ — Minimum value of the gauge, - **roundCaps** `boolean` _(default `false`)_ — Whether to round arc endpoints. Not applied to `sections` – rounded caps of adjacent sections would overlap each other. - **sections** `GaugeChartSection[]` — Threshold sections of the gauge arc, each section is filled from the previous section upper bound to its own `value`. If set, the arc is not filled based on `value`. - **size** `number` _(default `200`)_ — Chart size (width and height), - **startAngle** `number` _(default `-120`)_ — Start angle in degrees, - **target** `number` — Value marked on the arc with a line marker, use to display a goal or the current value of a gauge with `sections` - **targetColor** `MantineColor` — Color of the target marker - **targetSize** `number` _(default `2`)_ — Thickness of the target marker, - **thickness** `number` _(default `12`)_ — Arc thickness in px, - **trackColor** `MantineColor` — Color of the gauge track (unfilled portion) - **value** `number` **(required)** — Current value to display. Fills the arc from `min` up to `value`, unless `sections` is set – then the arc is colored by thresholds and the value is displayed only in the center label. - **valueFormatter** `(value: number) => string` _(default `(v) => String(v)`)_ — Value formatter for default label, Optional leading props map; remaining args are children.
Heatmap — Heatmap chart component
https://mantine.dev/charts/heatmap
Props (docgen 9.6.0):
string[] — Colors array, used to calculate color for each value, by default 4 shades of green colors are usedRecord<string, number> (required) — Heatmap data, key is date in YYYY-MM-DD format (interpreted as a UTC calendar day)[number, number] — Heatmap domain, array of 2 numbers, min and max values, calculated from data by defaultstring | Date — Heatmap end date. Current date by default. Date is normalized to UTC midnight of the intended calendar day.0 | 2 | 1 | 3 | 4 | 5 | 6 (default 1 – Monday) — First day of week, 0 – Sunday, 1 – Monday.number (default 12) — Font size of month and weekday labelsnumber (default 1) — Gap between rects in px(input: HeatmapRectData) => SVGProps<SVGRectElement> — Props passed down to each rect depending on its date and associated value(input: HeatmapRectData) => ReactNode — A function to generate tooltip label based on the hovered rect date and value, required for the tooltip to be visible[string, string] (default ['Less', 'More']) — Legend labels, array of 2 elements: [min label, max label]string[] — Month labels, array of 12 elements, can be used for localization"bottom" | "top" (default 'top') — Month labels position relative to the heatmapnumber (default 30) — Height of month labels rownumber (default 2) — Rect radius in pxnumber (default 10) — Size of day rect in pxboolean (default false) — If set, inserts a spacer column between monthsstring | Date — Heatmap start date. Current date - 1 year by default. Date is normalized to UTC midnight of the intended calendar day.Partial<TooltipFloatingProps> — Props passed down to the Tooltip.Floating componentstring[] — Weekday labels, array of 7 elements, can be used for localizationnumber (default 30) — Width of weekday labels columnboolean (default false) — If set, legend with color levels is displayed below the heatmapboolean (default false) — If set, month labels are displayedboolean (default true) — If set, trailing dates that do not fall into the given startDate – endDate range are displayed to fill empty space.boolean (default false) — If set, tooltip is displayed on rect hoverboolean (default false) — If set, weekday labels are displayedOptional leading props map; remaining args are children.
Heatmap — Heatmap chart component https://mantine.dev/charts/heatmap Props (docgen 9.6.0): - **colors** `string[]` — Colors array, used to calculate color for each value, by default 4 shades of green colors are used - **data** `Record<string, number>` **(required)** — Heatmap data, key is date in `YYYY-MM-DD` format (interpreted as a UTC calendar day) - **domain** `[number, number]` — Heatmap domain, array of 2 numbers, min and max values, calculated from data by default - **endDate** `string | Date` — Heatmap end date. Current date by default. Date is normalized to UTC midnight of the intended calendar day. - **firstDayOfWeek** `0 | 2 | 1 | 3 | 4 | 5 | 6` _(default `1 – Monday`)_ — First day of week, 0 – Sunday, 1 – Monday. - **fontSize** `number` _(default `12`)_ — Font size of month and weekday labels - **gap** `number` _(default `1`)_ — Gap between rects in px - **getRectProps** `(input: HeatmapRectData) => SVGProps<SVGRectElement>` — Props passed down to each rect depending on its date and associated value - **getTooltipLabel** `(input: HeatmapRectData) => ReactNode` — A function to generate tooltip label based on the hovered rect date and value, required for the tooltip to be visible - **legendLabels** `[string, string]` _(default `['Less', 'More']`)_ — Legend labels, array of 2 elements: [min label, max label] - **monthLabels** `string[]` — Month labels, array of 12 elements, can be used for localization - **monthLabelsPosition** `"bottom" | "top"` _(default `'top'`)_ — Month labels position relative to the heatmap - **monthsLabelsHeight** `number` _(default `30`)_ — Height of month labels row - **rectRadius** `number` _(default `2`)_ — Rect radius in px - **rectSize** `number` _(default `10`)_ — Size of day rect in px - **splitMonths** `boolean` _(default `false`)_ — If set, inserts a spacer column between months - **startDate** `string | Date` — Heatmap start date. Current date - 1 year by default. Date is normalized to UTC midnight of the intended calendar day. - **tooltipProps** `Partial<TooltipFloatingProps>` — Props passed down to the `Tooltip.Floating` component - **weekdayLabels** `string[]` — Weekday labels, array of 7 elements, can be used for localization - **weekdaysLabelsWidth** `number` _(default `30`)_ — Width of weekday labels column - **withLegend** `boolean` _(default `false`)_ — If set, legend with color levels is displayed below the heatmap - **withMonthLabels** `boolean` _(default `false`)_ — If set, month labels are displayed - **withOutsideDates** `boolean` _(default `true`)_ — If set, trailing dates that do not fall into the given `startDate` – `endDate` range are displayed to fill empty space. - **withTooltip** `boolean` _(default `false`)_ — If set, tooltip is displayed on rect hover - **withWeekdayLabels** `boolean` _(default `false`)_ — If set, weekday labels are displayed Optional leading props map; remaining args are children.
LineChart — Line chart component
https://mantine.dev/charts/line-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultMantineChartDotProps — Props passed down to all active dots. Ignored if withDots={false} is set.RechartsProps — Props passed down to the Brush componentReact.ReactNode — Additional components that are rendered inside recharts LineChart componentboolean (default true) — Determines whether points with null values should be connectedLineChartCurveType (default 'monotone') — Type of the curveRecord<string, any>[] (required) — Data used to display chartstring (required) — Key of the data object for x-axis valuesMantineChartDotProps — Props passed down to all dots. Ignored if withDots={false} is set.number (default 1) — Controls fill opacity of all linesLineChartGradientStop[] (default [{ offset: 0, color: 'red' }, { offset: 100, color: 'blue' }]) — Data used to generate gradient stops"none" | "x" | "y" | "xy" — Specifies which lines should be displayed in the grid, 'x' by defaultMantineColor — Color of the grid and cursor lines, by default depends on color schemeRechartsProps — Props passed down to the CartesianGrid componentRechartsProps — Props passed down to the Legend component(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts LineChart componentPartial<Omit<Props, "ref">> | ((series: LineChartSeries) => Partial<Omit<Props, "ref">>) — Props passed down to recharts Line component"horizontal" | "vertical" — Chart orientation, 'horizontal' by defaultChartReferenceAreaProps[] — Reference areas that should be displayed on the chartChartReferenceDotProps[] — Reference dots that should be displayed on the chartChartReferenceLineProps[] — Reference lines that should be displayed on the chartstring — A label to display next to the right y-axisRechartsProps — Props passed down to the YAxis recharts component rendered on the right sideLineChartSeries[] (required) — An array of objects with name and color keys. Determines which data should be consumed from the data array.string | number — Dash array for the grid lines and cursor, '5 5' by defaultnumber (default 2) — Stroke width for the chart linesMantineColor — Color of the text displayed inside the chart, 'dimmed' by default"none" | "x" | "y" | "xy" — Specifies which axis should have tick line, 'y' by defaultnumber — Tooltip position animation duration in ms, 0 by defaultRechartsProps — Props passed down to the Tooltip componentLineChartType (default 'default') — Controls styles of the linestring — Unit displayed next to each tick in y-axis(value: number) => string — A function to format values on Y axis and inside the tooltipboolean — Determines whether a brush (range selector) should be displayed under the chart, false by defaultboolean (default true) — Determines whether dots should be displayedboolean — Determines whether chart legend should be displayed, false by defaultboolean (default false) — Determines whether each point should have associated labelboolean — Determines whether additional y-axis should be displayed on the right side of the chart, false by defaultboolean — Determines whether chart tooltip should be displayed, true by defaultboolean — Determines whether x-axis should be displayed, true by defaultboolean — Determines whether y-axis should be displayed, true by defaultstring — A label to display below the x-axisRechartsProps — Props passed down to the XAxis recharts componentstring — A label to display next to the y-axisRechartsProps — Props passed down to the YAxis recharts componentOptional leading props map; remaining args are children.
LineChart — Line chart component
https://mantine.dev/charts/line-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **activeDotProps** `MantineChartDotProps` — Props passed down to all active dots. Ignored if `withDots={false}` is set.
- **brushProps** `RechartsProps` — Props passed down to the `Brush` component
- **children** `React.ReactNode` — Additional components that are rendered inside recharts `LineChart` component
- **connectNulls** `boolean` _(default `true`)_ — Determines whether points with `null` values should be connected
- **curveType** `LineChartCurveType` _(default `'monotone'`)_ — Type of the curve
- **data** `Record<string, any>[]` **(required)** — Data used to display chart
- **dataKey** `string` **(required)** — Key of the `data` object for x-axis values
- **dotProps** `MantineChartDotProps` — Props passed down to all dots. Ignored if `withDots={false}` is set.
- **fillOpacity** `number` _(default `1`)_ — Controls fill opacity of all lines
- **gradientStops** `LineChartGradientStop[]` _(default `[{ offset: 0, color: 'red' }, { offset: 100, color: 'blue' }]`)_ — Data used to generate gradient stops
- **gridAxis** `"none" | "x" | "y" | "xy"` — Specifies which lines should be displayed in the grid, `'x'` by default
- **gridColor** `MantineColor` — Color of the grid and cursor lines, by default depends on color scheme
- **gridProps** `RechartsProps` — Props passed down to the `CartesianGrid` component
- **legendProps** `RechartsProps` — Props passed down to the `Legend` component
- **lineChartProps** `(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `LineChart` component
- **lineProps** `Partial<Omit<Props, "ref">> | ((series: LineChartSeries) => Partial<Omit<Props, "ref">>)` — Props passed down to recharts `Line` component
- **orientation** `"horizontal" | "vertical"` — Chart orientation, `'horizontal'` by default
- **referenceAreas** `ChartReferenceAreaProps[]` — Reference areas that should be displayed on the chart
- **referenceDots** `ChartReferenceDotProps[]` — Reference dots that should be displayed on the chart
- **referenceLines** `ChartReferenceLineProps[]` — Reference lines that should be displayed on the chart
- **rightYAxisLabel** `string` — A label to display next to the right y-axis
- **rightYAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component rendered on the right side
- **series** `LineChartSeries[]` **(required)** — An array of objects with `name` and `color` keys. Determines which data should be consumed from the `data` array.
- **strokeDasharray** `string | number` — Dash array for the grid lines and cursor, `'5 5'` by default
- **strokeWidth** `number` _(default `2`)_ — Stroke width for the chart lines
- **textColor** `MantineColor` — Color of the text displayed inside the chart, `'dimmed'` by default
- **tickLine** `"none" | "x" | "y" | "xy"` — Specifies which axis should have tick line, `'y'` by default
- **tooltipAnimationDuration** `number` — Tooltip position animation duration in ms, `0` by default
- **tooltipProps** `RechartsProps` — Props passed down to the `Tooltip` component
- **type** `LineChartType` _(default `'default'`)_ — Controls styles of the line
- **unit** `string` — Unit displayed next to each tick in y-axis
- **valueFormatter** `(value: number) => string` — A function to format values on Y axis and inside the tooltip
- **withBrush** `boolean` — Determines whether a brush (range selector) should be displayed under the chart, `false` by default
- **withDots** `boolean` _(default `true`)_ — Determines whether dots should be displayed
- **withLegend** `boolean` — Determines whether chart legend should be displayed, `false` by default
- **withPointLabels** `boolean` _(default `false`)_ — Determines whether each point should have associated label
- **withRightYAxis** `boolean` — Determines whether additional y-axis should be displayed on the right side of the chart, `false` by default
- **withTooltip** `boolean` — Determines whether chart tooltip should be displayed, `true` by default
- **withXAxis** `boolean` — Determines whether x-axis should be displayed, `true` by default
- **withYAxis** `boolean` — Determines whether y-axis should be displayed, `true` by default
- **xAxisLabel** `string` — A label to display below the x-axis
- **xAxisProps** `RechartsProps` — Props passed down to the `XAxis` recharts component
- **yAxisLabel** `string` — A label to display next to the y-axis
- **yAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component
Optional leading props map; remaining args are children.MatrixChart — Generic x/y heatmap with categorical axes
https://mantine.dev/charts/matrix-chart
Props (docgen 9.6.0):
number (default 2) — Cell border radius,number (default 20) — Cell size in px,DefaultMantineColor[] — Array of colors for value interpolation, by default 4 shades of green colors are usedMatrixChartData (required) — Array of cell objects with x, y, and value[number, number] — Value domain [min, max] for color interpolation, auto-calculated if not setMantineColor — Color for empty/null cellsnumber (default 12) — Font size for axis labels,number (default 1) — Gap between cells in px,(cell: MatrixChartCell) => SVGProps<SVGRectElement> — Callback to add custom props to cells(cell: MatrixChartCell) => ReactNode — A function to generate tooltip label based on the hovered cell, required for the tooltip to be visible[string, string] (default ['Less', 'More']) — Legend labels,Partial<TooltipFloatingProps> — Props passed down to the Tooltip.Floating componentboolean (default false) — Whether to show legend,boolean (default false) — If set, tooltip is displayed on cell hover, requires getTooltipLabel to be setboolean (default false) — If set, x-axis labels are displayed,boolean (default false) — If set, y-axis labels are displayed,string[] — Labels for x-axis (columns), displayed along top or bottomnumber (default 60) — Height reserved for x-axis labels,"bottom" | "top" (default 'bottom') — X-axis label position,number (default -90) — Rotation angle for x-axis labels in degrees,string[] — Labels for y-axis (rows), displayed along left sidenumber (default 60) — Width reserved for y-axis labels,Optional leading props map; remaining args are children.
MatrixChart — Generic x/y heatmap with categorical axes https://mantine.dev/charts/matrix-chart Props (docgen 9.6.0): - **cellRadius** `number` _(default `2`)_ — Cell border radius, - **cellSize** `number` _(default `20`)_ — Cell size in px, - **colors** `DefaultMantineColor[]` — Array of colors for value interpolation, by default 4 shades of green colors are used - **data** `MatrixChartData` **(required)** — Array of cell objects with x, y, and value - **domain** `[number, number]` — Value domain [min, max] for color interpolation, auto-calculated if not set - **emptyColor** `MantineColor` — Color for empty/null cells - **fontSize** `number` _(default `12`)_ — Font size for axis labels, - **gap** `number` _(default `1`)_ — Gap between cells in px, - **getCellProps** `(cell: MatrixChartCell) => SVGProps<SVGRectElement>` — Callback to add custom props to cells - **getTooltipLabel** `(cell: MatrixChartCell) => ReactNode` — A function to generate tooltip label based on the hovered cell, required for the tooltip to be visible - **legendLabels** `[string, string]` _(default `['Less', 'More']`)_ — Legend labels, - **tooltipProps** `Partial<TooltipFloatingProps>` — Props passed down to the `Tooltip.Floating` component - **withLegend** `boolean` _(default `false`)_ — Whether to show legend, - **withTooltip** `boolean` _(default `false`)_ — If set, tooltip is displayed on cell hover, requires `getTooltipLabel` to be set - **withXLabels** `boolean` _(default `false`)_ — If set, x-axis labels are displayed, - **withYLabels** `boolean` _(default `false`)_ — If set, y-axis labels are displayed, - **xLabels** `string[]` — Labels for x-axis (columns), displayed along top or bottom - **xLabelsHeight** `number` _(default `60`)_ — Height reserved for x-axis labels, - **xLabelsPosition** `"bottom" | "top"` _(default `'bottom'`)_ — X-axis label position, - **xLabelsRotation** `number` _(default `-90`)_ — Rotation angle for x-axis labels in degrees, - **yLabels** `string[]` — Labels for y-axis (rows), displayed along left side - **yLabelsWidth** `number` _(default `60`)_ — Width reserved for y-axis labels, Optional leading props map; remaining args are children.
PieChart — Pie chart component
https://mantine.dev/charts/pie-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultPartial<Omit<SVGProps<SVGElement>, "ref">> | ((series: PieChartCell) => Partial<Omit<SVGProps<SVGElement>, "ref">>) — Props passed down to each segment of the chartReact.ReactNode — Additional elements rendered inside PieChart componentPieChartCell[] (required) — Data used to render chartnumber (default 360) — Controls angle at which charts ends. Set to 0 to render the chart as semicircle.MantineColor — Controls text color of all labels, white by default"outside" | "inside" (default 'outside') — Controls labels position relative to the segment"value" | "name" | "percent" (default 'value') — Type of labels to displayRechartsProps — Props passed down to recharts Legend componentnumber (default 0) — Controls padding between segments(PolarChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts PieChart componentPartial<Omit<Props, "ref">> — Props passed down to recharts Pie componentnumber (default 80) — Controls chart width and height, height is increased by 40 if withLabels prop is set. Cannot be less than thickness.number (default 0) — Controls angle at which chart starts. Set to 180 to render the chart as semicircle.MantineColor — Controls color of the segments stroke, by default depends on color schemenumber (default 1) — Controls width of segments strokenumber (default 0) — Tooltip animation duration in ms"all" | "segment" (default 'all') — Determines which data is displayed in the tooltip. 'all' – display all values, 'segment' – display only hovered segment.RechartsProps — Props passed down to Tooltip recharts component(value: number) => string — A function to format values inside the tooltipboolean (default false) — Determines whether each segment should have associated labelboolean (default true) — Determines whether segments labels should have lines that connect the segment with the labelboolean (default false) — Determines whether the legend should be displayedboolean (default true) — Determines whether the tooltip should be displayed when one of the section is hoveredOptional leading props map; remaining args are children.
PieChart — Pie chart component
https://mantine.dev/charts/pie-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **cellProps** `Partial<Omit<SVGProps<SVGElement>, "ref">> | ((series: PieChartCell) => Partial<Omit<SVGProps<SVGElement>, "ref">>)` — Props passed down to each segment of the chart
- **children** `React.ReactNode` — Additional elements rendered inside `PieChart` component
- **data** `PieChartCell[]` **(required)** — Data used to render chart
- **endAngle** `number` _(default `360`)_ — Controls angle at which charts ends. Set to `0` to render the chart as semicircle.
- **labelColor** `MantineColor` — Controls text color of all labels, white by default
- **labelsPosition** `"outside" | "inside"` _(default `'outside'`)_ — Controls labels position relative to the segment
- **labelsType** `"value" | "name" | "percent"` _(default `'value'`)_ — Type of labels to display
- **legendProps** `RechartsProps` — Props passed down to recharts `Legend` component
- **paddingAngle** `number` _(default `0`)_ — Controls padding between segments
- **pieChartProps** `(PolarChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `PieChart` component
- **pieProps** `Partial<Omit<Props, "ref">>` — Props passed down to recharts `Pie` component
- **size** `number` _(default `80`)_ — Controls chart width and height, height is increased by 40 if `withLabels` prop is set. Cannot be less than `thickness`.
- **startAngle** `number` _(default `0`)_ — Controls angle at which chart starts. Set to `180` to render the chart as semicircle.
- **strokeColor** `MantineColor` — Controls color of the segments stroke, by default depends on color scheme
- **strokeWidth** `number` _(default `1`)_ — Controls width of segments stroke
- **tooltipAnimationDuration** `number` _(default `0`)_ — Tooltip animation duration in ms
- **tooltipDataSource** `"all" | "segment"` _(default `'all'`)_ — Determines which data is displayed in the tooltip. `'all'` – display all values, `'segment'` – display only hovered segment.
- **tooltipProps** `RechartsProps` — Props passed down to `Tooltip` recharts component
- **valueFormatter** `(value: number) => string` — A function to format values inside the tooltip
- **withLabels** `boolean` _(default `false`)_ — Determines whether each segment should have associated label
- **withLabelsLine** `boolean` _(default `true`)_ — Determines whether segments labels should have lines that connect the segment with the label
- **withLegend** `boolean` _(default `false`)_ — Determines whether the legend should be displayed
- **withTooltip** `boolean` _(default `true`)_ — Determines whether the tooltip should be displayed when one of the section is hovered
Optional leading props map; remaining args are children.RadarChart — Radar chart component
https://mantine.dev/charts/radar-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultMantineChartDotProps — Props passed down to all active dots. Ignored if withDots={false} is set.React.ReactNode — Additional components that are rendered inside recharts RadarChart componentRecord<string, any>[] (required) — Data used in the chartstring (required) — Key of the data object for axis valuesMantineChartDotProps — Props passed down to all dots. Ignored if withDots={false} is set.MantineColor — Controls color of the grid lines. By default, color depends on the color scheme.RechartsProps — Props passed down to recharts Legend componentRechartsProps — Props passed down to recharts PolarAngleAxis componentRechartsProps — Props passed down to recharts PolarGrid componentRechartsProps — Props passed down to recharts PolarRadiusAxis component(PolarChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts RadarChart component((series: RadarChartSeries) => Partial<Omit<Props, "ref">>) | Partial<Omit<Props, "ref">> — Props passed down to recharts Radar componentRadarChartSeries[] (required) — Determines which data should be consumed from the data array.MantineColor — Controls color of all text elements. By default, color depends on the color scheme.number (default 0) — Tooltip position animation duration in msRechartsProps — Props passed down to recharts Tooltip componentboolean (default false) — Determines whether dots should be displayedboolean (default false) — Determines whether the legend should be displayedboolean (default true) — Determines whether PolarAngleAxis component should be displayedboolean (default true.) — Determines whether PolarGrid component should be displayedboolean (default false) — Determines whether PolarRadiusAxisProps component should be displayedboolean (default false) — Determines whether Tooltip component should be displayedOptional leading props map; remaining args are children.
RadarChart — Radar chart component
https://mantine.dev/charts/radar-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **activeDotProps** `MantineChartDotProps` — Props passed down to all active dots. Ignored if `withDots={false}` is set.
- **children** `React.ReactNode` — Additional components that are rendered inside recharts `RadarChart` component
- **data** `Record<string, any>[]` **(required)** — Data used in the chart
- **dataKey** `string` **(required)** — Key of the `data` object for axis values
- **dotProps** `MantineChartDotProps` — Props passed down to all dots. Ignored if `withDots={false}` is set.
- **gridColor** `MantineColor` — Controls color of the grid lines. By default, color depends on the color scheme.
- **legendProps** `RechartsProps` — Props passed down to recharts Legend component
- **polarAngleAxisProps** `RechartsProps` — Props passed down to recharts PolarAngleAxis component
- **polarGridProps** `RechartsProps` — Props passed down to recharts PolarGrid component
- **polarRadiusAxisProps** `RechartsProps` — Props passed down to recharts PolarRadiusAxis component
- **radarChartProps** `(PolarChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts RadarChart component
- **radarProps** `((series: RadarChartSeries) => Partial<Omit<Props, "ref">>) | Partial<Omit<Props, "ref">>` — Props passed down to recharts Radar component
- **series** `RadarChartSeries[]` **(required)** — Determines which data should be consumed from the `data` array.
- **textColor** `MantineColor` — Controls color of all text elements. By default, color depends on the color scheme.
- **tooltipAnimationDuration** `number` _(default `0`)_ — Tooltip position animation duration in ms
- **tooltipProps** `RechartsProps` — Props passed down to recharts Tooltip component
- **withDots** `boolean` _(default `false`)_ — Determines whether dots should be displayed
- **withLegend** `boolean` _(default `false`)_ — Determines whether the legend should be displayed
- **withPolarAngleAxis** `boolean` _(default `true`)_ — Determines whether PolarAngleAxis component should be displayed
- **withPolarGrid** `boolean` _(default `true.`)_ — Determines whether PolarGrid component should be displayed
- **withPolarRadiusAxis** `boolean` _(default `false`)_ — Determines whether PolarRadiusAxisProps component should be displayed
- **withTooltip** `boolean` _(default `false`)_ — Determines whether Tooltip component should be displayed
Optional leading props map; remaining args are children.RadialBarChart — Radial bar chart component
https://mantine.dev/charts/radial-bar-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultnumber — Size of bars in px, 20 by defaultRecord<string, any>[] (required) — Chart datastring (required) — Key from data object to use as data keystring — Color of the empty background, by default depends on the color schemenumber (default -270) — Angle at which chart endsRechartsProps — Props passed down to recharts Legend component(PolarChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts RadarChartChart componentOmit<RadialBarProps, "ref"> — Props passed down to recharts RadialBar componentnumber (default 90) — Angle at which chart startsRechartsProps — Props passed down to Tooltip recharts componentboolean (default true) — Determines whether empty bars area should be visibleboolean (default false) — Determines whether labels should be displayedboolean (default false) — Determines whether the legend should be displayedboolean (default true) — Determines whether the tooltip should be displayed when one of the bars is hoveredOptional leading props map; remaining args are children.
RadialBarChart — Radial bar chart component
https://mantine.dev/charts/radial-bar-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **barSize** `number` — Size of bars in px, `20` by default
- **data** `Record<string, any>[]` **(required)** — Chart data
- **dataKey** `string` **(required)** — Key from data object to use as data key
- **emptyBackgroundColor** `string` — Color of the empty background, by default depends on the color scheme
- **endAngle** `number` _(default `-270`)_ — Angle at which chart ends
- **legendProps** `RechartsProps` — Props passed down to recharts Legend component
- **radialBarChartProps** `(PolarChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts RadarChartChart component
- **radialBarProps** `Omit<RadialBarProps, "ref">` — Props passed down to recharts RadialBar component
- **startAngle** `number` _(default `90`)_ — Angle at which chart starts
- **tooltipProps** `RechartsProps` — Props passed down to `Tooltip` recharts component
- **withBackground** `boolean` _(default `true`)_ — Determines whether empty bars area should be visible
- **withLabels** `boolean` _(default `false`)_ — Determines whether labels should be displayed
- **withLegend** `boolean` _(default `false`)_ — Determines whether the legend should be displayed
- **withTooltip** `boolean` _(default `true`)_ — Determines whether the tooltip should be displayed when one of the bars is hovered
Optional leading props map; remaining args are children.SankeyChart — Sankey diagram component
https://mantine.dev/charts/sankey-chart
Props (docgen 9.6.0):
React.ReactNode — Additional elements rendered inside Sankey componentDefaultMantineColor[] — An array of colors used for nodes when no color is set on individual nodesSankeyChartData (required) — Data used to render chart, must include nodes and links arraysnumber (default 300) — Controls chart heightnumber (default 32) — The number of relaxation iterationsMantineColor — Default color for links, by default depends on color schemenumber (default 0.5) — The curvature of links between nodesnumber (default 0.4) — Opacity of the link fillMantineColor — Default color for nodes, by default depends on color schemenumber (default 10) — The padding between nodesnumber (default 10) — The width of each nodePartial<Omit<Props, "data" | "ref">> — Props passed down to recharts Sankey componentMantineColor (default dimmed) — Controls text color of labelsnumber (default 0) — Tooltip animation duration in msRechartsProps — Props passed down to Tooltip recharts component(value: number) => string — A function to format values inside the tooltip and node labelsboolean (default true) — Determines whether the tooltip should be displayed when hoveredOptional leading props map; remaining args are children.
SankeyChart — Sankey diagram component https://mantine.dev/charts/sankey-chart Props (docgen 9.6.0): - **children** `React.ReactNode` — Additional elements rendered inside `Sankey` component - **colors** `DefaultMantineColor[]` — An array of colors used for nodes when no `color` is set on individual nodes - **data** `SankeyChartData` **(required)** — Data used to render chart, must include `nodes` and `links` arrays - **height** `number` _(default `300`)_ — Controls chart height - **iterations** `number` _(default `32`)_ — The number of relaxation iterations - **linkColor** `MantineColor` — Default color for links, by default depends on color scheme - **linkCurvature** `number` _(default `0.5`)_ — The curvature of links between nodes - **linkOpacity** `number` _(default `0.4`)_ — Opacity of the link fill - **nodeColor** `MantineColor` — Default color for nodes, by default depends on color scheme - **nodePadding** `number` _(default `10`)_ — The padding between nodes - **nodeWidth** `number` _(default `10`)_ — The width of each node - **sankeyProps** `Partial<Omit<Props, "data" | "ref">>` — Props passed down to recharts `Sankey` component - **textColor** `MantineColor` _(default `dimmed`)_ — Controls text color of labels - **tooltipAnimationDuration** `number` _(default `0`)_ — Tooltip animation duration in ms - **tooltipProps** `RechartsProps` — Props passed down to `Tooltip` recharts component - **valueFormatter** `(value: number) => string` — A function to format values inside the tooltip and node labels - **withTooltip** `boolean` _(default `true`)_ — Determines whether the tooltip should be displayed when hovered Optional leading props map; remaining args are children.
ScatterChart — Scatter chart component
https://mantine.dev/charts/scatter-chart
Props (docgen 9.6.0):
boolean — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, true by defaultScatterChartSeries[] (required) — Data that is used to build the chart{ x: string; y: string; } (required) — Keys that should be used to retrieve data from the data array on x and y axis"none" | "x" | "y" | "xy" — Specifies which lines should be displayed in the grid, 'x' by defaultMantineColor — Color of the grid and cursor lines, by default depends on color schemeRechartsProps — Props passed down to the CartesianGrid component{ x?: string; y?: string | undefined; } | undefined — Labels that should be used instead of keys names in the tooltipRechartsProps — Props passed down to the Legend component"horizontal" | "vertical" — Chart orientation, 'horizontal' by default"x" | "y" — If set, displays labels next to points for the given axisChartReferenceAreaProps[] — Reference areas that should be displayed on the chartChartReferenceDotProps[] — Reference dots that should be displayed on the chartChartReferenceLineProps[] — Reference lines that should be displayed on the chartstring — A label to display next to the right y-axisRechartsProps — Props passed down to the YAxis recharts component rendered on the right side(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined — Props passed down to recharts ScatterChart componentPartial<Omit<Props, "ref">> — Props passed down to recharts Scatter componentstring | number — Dash array for the grid lines and cursor, '5 5' by defaultMantineColor — Color of the text displayed inside the chart, 'dimmed' by default"none" | "x" | "y" | "xy" — Specifies which axis should have tick line, 'y' by defaultnumber — Tooltip position animation duration in ms, 0 by defaultRechartsProps — Props passed down to the Tooltip component{ x?: string; y?: string | undefined; } | undefined — Units displayed after value on axis and inside the tooltip((value: number) => string) | { x?: ((value: number) => string); y?: ((value: number) => string) | undefined; } | undefined — A function to format values on x/y axis and in the tooltipboolean — Determines whether chart legend should be displayed, false by defaultboolean — Determines whether additional y-axis should be displayed on the right side of the chart, false by defaultboolean — Determines whether chart tooltip should be displayed, true by defaultboolean — Determines whether x-axis should be displayed, true by defaultboolean — Determines whether y-axis should be displayed, true by defaultstring — A label to display below the x-axisRechartsProps — Props passed down to the XAxis recharts componentstring — A label to display next to the y-axisRechartsProps — Props passed down to the YAxis recharts componentOptional leading props map; remaining args are children.
ScatterChart — Scatter chart component
https://mantine.dev/charts/scatter-chart
Props (docgen 9.6.0):
- **accessibilityLayer** `boolean` — Determines whether the chart should be keyboard-navigable with the recharts accessibility layer, `true` by default
- **data** `ScatterChartSeries[]` **(required)** — Data that is used to build the chart
- **dataKey** `{ x: string; y: string; }` **(required)** — Keys that should be used to retrieve data from the data array on x and y axis
- **gridAxis** `"none" | "x" | "y" | "xy"` — Specifies which lines should be displayed in the grid, `'x'` by default
- **gridColor** `MantineColor` — Color of the grid and cursor lines, by default depends on color scheme
- **gridProps** `RechartsProps` — Props passed down to the `CartesianGrid` component
- **labels** `{ x?: string; y?: string | undefined; } | undefined` — Labels that should be used instead of keys names in the tooltip
- **legendProps** `RechartsProps` — Props passed down to the `Legend` component
- **orientation** `"horizontal" | "vertical"` — Chart orientation, `'horizontal'` by default
- **pointLabels** `"x" | "y"` — If set, displays labels next to points for the given axis
- **referenceAreas** `ChartReferenceAreaProps[]` — Reference areas that should be displayed on the chart
- **referenceDots** `ChartReferenceDotProps[]` — Reference dots that should be displayed on the chart
- **referenceLines** `ChartReferenceLineProps[]` — Reference lines that should be displayed on the chart
- **rightYAxisLabel** `string` — A label to display next to the right y-axis
- **rightYAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component rendered on the right side
- **scatterChartProps** `(CartesianChartProps<unknown> & { ref?: Ref<SVGSVGElement>; }) | undefined` — Props passed down to recharts `ScatterChart` component
- **scatterProps** `Partial<Omit<Props, "ref">>` — Props passed down to recharts `Scatter` component
- **strokeDasharray** `string | number` — Dash array for the grid lines and cursor, `'5 5'` by default
- **textColor** `MantineColor` — Color of the text displayed inside the chart, `'dimmed'` by default
- **tickLine** `"none" | "x" | "y" | "xy"` — Specifies which axis should have tick line, `'y'` by default
- **tooltipAnimationDuration** `number` — Tooltip position animation duration in ms, `0` by default
- **tooltipProps** `RechartsProps` — Props passed down to the `Tooltip` component
- **unit** `{ x?: string; y?: string | undefined; } | undefined` — Units displayed after value on axis and inside the tooltip
- **valueFormatter** `((value: number) => string) | { x?: ((value: number) => string); y?: ((value: number) => string) | undefined; } | undefined` — A function to format values on x/y axis and in the tooltip
- **withLegend** `boolean` — Determines whether chart legend should be displayed, `false` by default
- **withRightYAxis** `boolean` — Determines whether additional y-axis should be displayed on the right side of the chart, `false` by default
- **withTooltip** `boolean` — Determines whether chart tooltip should be displayed, `true` by default
- **withXAxis** `boolean` — Determines whether x-axis should be displayed, `true` by default
- **withYAxis** `boolean` — Determines whether y-axis should be displayed, `true` by default
- **xAxisLabel** `string` — A label to display below the x-axis
- **xAxisProps** `RechartsProps` — Props passed down to the `XAxis` recharts component
- **yAxisLabel** `string` — A label to display next to the y-axis
- **yAxisProps** `RechartsProps` — Props passed down to the `YAxis` recharts component
Optional leading props map; remaining args are children.Sparkline — Simplified area chart to show trends
https://mantine.dev/charts/sparkline
Props (docgen 9.6.0):
Omit<Props<any, any>, "data" | "ref" | "dataKey"> — Props passed down to the underlying recharts Area componentMantineColor (default theme.primaryColor) — Key of theme.colors or any valid CSS colorboolean (default true) — Determines whether null values should be connected with other valuesAreaChartCurveType (default 'linear') — Type of the curve(number | null)[] (required) — Data used to render the chartnumber (default 0.6) — Controls fill opacity of the areanumber (default 2) — Area stroke widthSparklineTrendColors — If set, color prop is ignored and chart color is determined by the difference between first and last value.boolean (default true) — Determines whether the chart fill should be a gradientOptional leading props map; remaining args are children.
Sparkline — Simplified area chart to show trends https://mantine.dev/charts/sparkline Props (docgen 9.6.0): - **areaProps** `Omit<Props<any, any>, "data" | "ref" | "dataKey">` — Props passed down to the underlying recharts `Area` component - **color** `MantineColor` _(default `theme.primaryColor`)_ — Key of `theme.colors` or any valid CSS color - **connectNulls** `boolean` _(default `true`)_ — Determines whether null values should be connected with other values - **curveType** `AreaChartCurveType` _(default `'linear'`)_ — Type of the curve - **data** `(number | null)[]` **(required)** — Data used to render the chart - **fillOpacity** `number` _(default `0.6`)_ — Controls fill opacity of the area - **strokeWidth** `number` _(default `2`)_ — Area stroke width - **trendColors** `SparklineTrendColors` — If set, `color` prop is ignored and chart color is determined by the difference between first and last value. - **withGradient** `boolean` _(default `true`)_ — Determines whether the chart fill should be a gradient Optional leading props map; remaining args are children.
SunburstChart — Sunburst chart component for hierarchical data
https://mantine.dev/charts/sunburst-chart
Props (docgen 9.6.0):
React.ReactNode — Additional elements rendered inside SunburstChart componentSunburstChartData[] (required) — Data used to render chartstring (default 'value') — Key in data object for the valuenumber (default 360) — Angle in degrees at which the chart should endnumber (default 1) — Gap between sectors and rings in pxnumber (default 50) — Controls the radius of the inner circle at the center of the chartnumber (default 300) — Controls chart width and heightnumber (default 0) — Angle in degrees from which the chart should startMantineColor — Controls color of the sectors stroke, by default depends on color schemePartial<Omit<SunburstChartProps, "data" | "ref" | "dataKey">> — Props passed down to recharts SunburstChart componentnumber (default 0) — Tooltip animation duration in msRechartsProps — Props passed down to Tooltip recharts component(value: number) => string — A function to format values inside the tooltip and labelsboolean (default false) — Determines whether value labels are displayed inside each sectorboolean (default true) — Determines whether the tooltip should be displayed when a node is hoveredOptional leading props map; remaining args are children.
SunburstChart — Sunburst chart component for hierarchical data https://mantine.dev/charts/sunburst-chart Props (docgen 9.6.0): - **children** `React.ReactNode` — Additional elements rendered inside `SunburstChart` component - **data** `SunburstChartData[]` **(required)** — Data used to render chart - **dataKey** `string` _(default `'value'`)_ — Key in data object for the value - **endAngle** `number` _(default `360`)_ — Angle in degrees at which the chart should end - **gap** `number` _(default `1`)_ — Gap between sectors and rings in px - **innerRadius** `number` _(default `50`)_ — Controls the radius of the inner circle at the center of the chart - **size** `number` _(default `300`)_ — Controls chart width and height - **startAngle** `number` _(default `0`)_ — Angle in degrees from which the chart should start - **strokeColor** `MantineColor` — Controls color of the sectors stroke, by default depends on color scheme - **sunburstChartProps** `Partial<Omit<SunburstChartProps, "data" | "ref" | "dataKey">>` — Props passed down to recharts `SunburstChart` component - **tooltipAnimationDuration** `number` _(default `0`)_ — Tooltip animation duration in ms - **tooltipProps** `RechartsProps` — Props passed down to `Tooltip` recharts component - **valueFormatter** `(value: number) => string` — A function to format values inside the tooltip and labels - **withLabels** `boolean` _(default `false`)_ — Determines whether value labels are displayed inside each sector - **withTooltip** `boolean` _(default `true`)_ — Determines whether the tooltip should be displayed when a node is hovered Optional leading props map; remaining args are children.
Treemap — Treemap chart component
https://mantine.dev/charts/treemap
Props (docgen 9.6.0):
number (default 1.618033988749895) — The treemap will try to keep every single rectangle's aspect ratio near the aspectRatio givenboolean — Determines whether text color should be adjusted based on background color to improve contrastReact.ReactNode — Additional elements rendered inside Treemap componentTreemapData[] (required) — Data used to render chartstring (default 'value') — Key in data object for the valuenumber (default 300) — Controls chart heightMantineColor — Controls color of the node stroke, by default depends on color schemenumber (default 1) — Controls width of node strokeMantineColor (default dimmed) — Controls text color of labelsnumber (default 0) — Tooltip animation duration in msRechartsProps — Props passed down to Tooltip recharts componentPartial<Omit<Props<TreemapDataType, any>, "data" | "ref" | "dataKey">> — Props passed down to recharts Treemap component(value: number) => string — A function to format values inside the tooltipboolean (default true) — Determines whether the tooltip should be displayed when a node is hoveredOptional leading props map; remaining args are children.
Treemap — Treemap chart component https://mantine.dev/charts/treemap Props (docgen 9.6.0): - **aspectRatio** `number` _(default `1.618033988749895`)_ — The treemap will try to keep every single rectangle's aspect ratio near the aspectRatio given - **autoContrast** `boolean` — Determines whether text color should be adjusted based on background color to improve contrast - **children** `React.ReactNode` — Additional elements rendered inside `Treemap` component - **data** `TreemapData[]` **(required)** — Data used to render chart - **dataKey** `string` _(default `'value'`)_ — Key in data object for the value - **height** `number` _(default `300`)_ — Controls chart height - **strokeColor** `MantineColor` — Controls color of the node stroke, by default depends on color scheme - **strokeWidth** `number` _(default `1`)_ — Controls width of node stroke - **textColor** `MantineColor` _(default `dimmed`)_ — Controls text color of labels - **tooltipAnimationDuration** `number` _(default `0`)_ — Tooltip animation duration in ms - **tooltipProps** `RechartsProps` — Props passed down to `Tooltip` recharts component - **treemapProps** `Partial<Omit<Props<TreemapDataType, any>, "data" | "ref" | "dataKey">>` — Props passed down to recharts `Treemap` component - **valueFormatter** `(value: number) => string` — A function to format values inside the tooltip - **withTooltip** `boolean` _(default `true`)_ — Determines whether the tooltip should be displayed when a node is hovered Optional leading props map; remaining args are children.
WaffleChart — Part-to-whole grid chart with colored cells
https://mantine.dev/charts/waffle-chart
Props (docgen 9.6.0):
number (default 0) — Cell border radius,number (default 10) — Number of columns,WaffleChartCell[] (required) — Array of data segments with name, value, and colorMantineColor — Color of empty (unfilled) cells"right-to-left" | "left-to-right" | "top-to-bottom" | "bottom-to-top" (default 'left-to-right') — Fill direction,number (default 2) — Gap between cells in px,(cell: WaffleChartCell & { count: number; }) => ReactNode — Custom tooltip label formatter"left" | "right" | "bottom" | "top" (default 'bottom') — Legend position,number (default 10) — Number of rows,number — Chart size (width), auto-calculated from columns if not setnumber — Total value for the chart, determines how many cells are filled vs empty, sum of all values by defaultboolean (default true) — Whether to show legend,boolean (default false) — Whether to show tooltip on hover,Optional leading props map; remaining args are children.
WaffleChart — Part-to-whole grid chart with colored cells
https://mantine.dev/charts/waffle-chart
Props (docgen 9.6.0):
- **cellRadius** `number` _(default `0`)_ — Cell border radius,
- **columns** `number` _(default `10`)_ — Number of columns,
- **data** `WaffleChartCell[]` **(required)** — Array of data segments with name, value, and color
- **emptyColor** `MantineColor` — Color of empty (unfilled) cells
- **fillDirection** `"right-to-left" | "left-to-right" | "top-to-bottom" | "bottom-to-top"` _(default `'left-to-right'`)_ — Fill direction,
- **gap** `number` _(default `2`)_ — Gap between cells in px,
- **getTooltipLabel** `(cell: WaffleChartCell & { count: number; }) => ReactNode` — Custom tooltip label formatter
- **legendPosition** `"left" | "right" | "bottom" | "top"` _(default `'bottom'`)_ — Legend position,
- **rows** `number` _(default `10`)_ — Number of rows,
- **size** `number` — Chart size (width), auto-calculated from columns if not set
- **total** `number` — Total value for the chart, determines how many cells are filled vs empty, sum of all values by default
- **withLegend** `boolean` _(default `true`)_ — Whether to show legend,
- **withTooltip** `boolean` _(default `false`)_ — Whether to show tooltip on hover,
Optional leading props map; remaining args are children.cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |