Skip to content
Edit this page

AppBar API

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

Import

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

Component name

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

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 API below for more details.
color'default'
| 'inherit'
| 'primary'
| 'secondary'
| 'transparent'
| string		'primary'
The color of the component. It supports those theme colors that make sense for this component.
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.
sxobject
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 on AppBar. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiAppBar-rootStyles applied to the root element.
positionFixed.MuiAppBar-positionFixedStyles applied to the root element if position="fixed".
positionAbsolute.MuiAppBar-positionAbsoluteStyles applied to the root element if position="absolute".
positionSticky.MuiAppBar-positionStickyStyles applied to the root element if position="sticky".
positionStatic.MuiAppBar-positionStaticStyles applied to the root element if position="static".
positionRelative.MuiAppBar-positionRelativeStyles applied to the root element if position="relative".
colorDefault.MuiAppBar-colorDefaultStyles applied to the root element if color="default".
colorPrimary.MuiAppBar-colorPrimaryStyles applied to the root element if color="primary".
colorSecondary.MuiAppBar-colorSecondaryStyles applied to the root element if color="secondary".
colorInherit.MuiAppBar-colorInheritStyles applied to the root element if color="inherit".
colorTransparent.MuiAppBar-colorTransparentStyles applied to the root element if color="transparent".

You can override the style of the component using one of these customization options:

Demos