Toolbar API
API documentation for the React Toolbar component. Learn about the available props and the CSS API.
Import
import Toolbar from '@mui/material/Toolbar';
// or
import { Toolbar } from '@mui/material';
Component name
The nameMuiToolbar
can be used when providing default props or style overrides in the theme.Props
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | The 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. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
component | elementType | 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. |
sx | 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.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiToolbar-root | Styles applied to the root element. |
gutters | .MuiToolbar-gutters | Styles applied to the root element unless disableGutters={true} . |
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 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.