Toolbar API

API reference docs for the React Toolbar 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:

App Bar

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.

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.

Type:

node

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object

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

Type:

elementType

If true, disables gutter padding.

Type:

bool

Default:

false

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

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object

The variant to use.

Type:

'dense' | 'regular' | string

Default:

'regular'

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Styles applied to the root element.

Styles applied to the root element unless disableGutters={true}.

Styles applied to the root element if variant="regular".

Styles applied to the root element if variant="dense".

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.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.