Skip to content

Toolbar API

API documentation for the React Toolbar component. Learn about the available props, and the CSS API.

Import

import Toolbar from '@material-ui/core/Toolbar';
// or
import { Toolbar } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiToolbar can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeThe Toolbar children, usually a mixture of IconButton, Button and Typography. The Toolbar is a flex container, allowing flex item properites to be used to lay out the children.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
disableGuttersboolfalseIf true, disables gutter padding.
variant'dense'
| 'regular'
| string
'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 nameGlobal classDescription
root.MuiToolbar-rootStyles applied to the root element.
gutters.MuiToolbar-guttersStyles applied to the root element unless disableGutters={true}.
regular.MuiToolbar-regularStyles applied to the root element if variant="regular".
dense.MuiToolbar-denseStyles applied to the root element if variant="dense".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos