Skip to content

AppBar API

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

Demos

Import

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

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

Props

Props of the Paper component are also available.

NameTypeDefaultDescription
childrennode-

The content of the component.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

color'default'
| 'inherit'
| 'primary'
| 'secondary'
| 'transparent'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
'primary'

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

enableColorOnDarkboolfalse

If true, the color prop is applied in dark mode.

position'absolute'
| 'fixed'
| 'relative'
| 'static'
| 'sticky'
'fixed'

The positioning type. The behavior of the different options is described in the MDN web docs. Note: sticky is not universally supported and will fall back to static when unavailable.

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.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the Paper component are also available in AppBar. You can take advantage of this to target nested components.

Theme default props

You can use MuiAppBar 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
.MuiAppBar-colorDefaultcolorDefaultStyles applied to the root element if color="default".
.MuiAppBar-colorErrorcolorErrorStyles applied to the root element if color="error".
.MuiAppBar-colorInfocolorInfoStyles applied to the root element if color="info".
.MuiAppBar-colorInheritcolorInheritStyles applied to the root element if color="inherit".
.MuiAppBar-colorPrimarycolorPrimaryStyles applied to the root element if color="primary".
.MuiAppBar-colorSecondarycolorSecondaryStyles applied to the root element if color="secondary".
.MuiAppBar-colorSuccesscolorSuccessStyles applied to the root element if color="success".
.MuiAppBar-colorTransparentcolorTransparentStyles applied to the root element if color="transparent".
.MuiAppBar-colorWarningcolorWarningStyles applied to the root element if color="warning".
.MuiAppBar-positionAbsolutepositionAbsoluteStyles applied to the root element if position="absolute".
.MuiAppBar-positionFixedpositionFixedStyles applied to the root element if position="fixed".
.MuiAppBar-positionRelativepositionRelativeStyles applied to the root element if position="relative".
.MuiAppBar-positionStaticpositionStaticStyles applied to the root element if position="static".
.MuiAppBar-positionStickypositionStickyStyles applied to the root element if position="sticky".
.MuiAppBar-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.