Skip to content

🎉 Material UI v5 is out now! Check out the announcement blog post →

Toolbar API

The API documentation of the Toolbar React component. Learn more about the props and the CSS customization points.

Import

import Toolbar from '@material-ui/core/Toolbar';
// or
import { Toolbar } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiToolbar name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
children node Toolbar children, usually a mixture of IconButton, Button and Typography.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
component elementType 'div' The component used for the root node. Either a string to use a HTML element or a component.
disableGutters bool false If true, disables gutter padding.
variant 'regular'
| 'dense'
'regular' The variant to use.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name Global class Description
root .MuiToolbar-root Styles applied to the root element.
gutters .MuiToolbar-gutters Styles applied to the root element if disableGutters={false}.
regular .MuiToolbar-regular Styles applied to the root element if variant="regular".
dense .MuiToolbar-dense Styles applied to the root element if variant="dense".

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos