Skip to content

Toolbar API

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

Demos

Import

import Toolbar from '@mui/material/Toolbar';
// or
import { Toolbar } from '@mui/material';

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode-

The Toolbar children, usually a mixture of IconButton, Button and Typography. The Toolbar is a flex container, allowing flex item properties to be used to lay out the children.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

disableGuttersboolfalse

If true, disables gutter padding.

sxArray<func
| object
| bool>
| func
| object
-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

variant'dense'
| 'regular'
| string
'regular'

The variant to use.

The ref is forwarded to the root element.

Theme default props

You can use MuiToolbar to change the default props of this component with the theme.

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
.MuiToolbar-densedenseStyles applied to the root element if variant="dense".
.MuiToolbar-guttersguttersStyles applied to the root element unless disableGutters={true}.
.MuiToolbar-regularregularStyles applied to the root element if variant="regular".
.MuiToolbar-rootrootStyles applied to the root element.

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

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.