BarElement API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import { BarElement } from '@mui/x-charts/BarChart';
// or
import { BarElement } from '@mui/x-charts';
// or
import { BarElement } from '@mui/x-charts-pro';

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

Props

Name Type Default Description

slotProps

Name	Type	Default	Description
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.

object

{}

The props used for each component slot.

slots

object

{}

Overridable component slots.

See Slots API below for more details.

The component cannot hold a ref.

Slots

Slot name	Class name	Default component	Description
bar		`BarElementPath`	The component that renders the bar.

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 name	Rule name	Description
.MuiBarElement-faded	faded	Styles applied to the root element if it is faded.
.MuiBarElement-highlighted	highlighted	Styles applied to the root element if it is highlighted.
.MuiBarElement-root	root	Styles applied to the root element.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.