Skip to content

ChartsLegend API

API reference docs for the React ChartsLegend component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import { ChartsLegend } from '@mui/x-charts/ChartsLegend';
// or
import { ChartsLegend } from '@mui/x-charts';

Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

direction'column'
| 'row'		-

The direction of the legend layout. The default depends on the chart.

hiddenboolfalse

Set to true to hide the legend.

position{ horizontal: 'left'
| 'middle'
| 'right', vertical: 'bottom'
| 'middle'
| 'top' }		-

The position of the legend.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overridable component slots.

See Slots API below for more details.

The component cannot hold a ref.

Slots

Slot nameClass nameDefault componentDescription
legendDefaultChartsLegendCustom rendering of the legend.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiChartsLegend-columncolumnStyles applied to the legend with column layout.
.MuiChartsLegend-labellabelStyles applied to the series label.
.MuiChartsLegend-markmarkStyles applied to series mark element.
.MuiChartsLegend-rootrootStyles applied to the root element.
.MuiChartsLegend-rowrowStyles applied to the legend with row layout.
.MuiChartsLegend-seriesseriesStyles applied to a series element.

You can override the style of the component using one of these customization options: