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.

Component 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.

children

The content of the component.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

color

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

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

Default:'primary'

enableColorOnDark

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

Type:bool

Default:false

position

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.

Type:'absolute'
| 'fixed'
| 'relative'
| 'static'
| 'sticky'

Default:'fixed'

sx

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 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.

.MuiAppBar-colorDefault

Styles applied to the root element if color="default".

Rule name:colorDefault

.MuiAppBar-colorError

Styles applied to the root element if color="error".

Rule name:colorError

.MuiAppBar-colorInfo

Styles applied to the root element if color="info".

Rule name:colorInfo

.MuiAppBar-colorInherit

Styles applied to the root element if color="inherit".

Rule name:colorInherit

.MuiAppBar-colorPrimary

Styles applied to the root element if color="primary".

Rule name:colorPrimary

.MuiAppBar-colorSecondary

Styles applied to the root element if color="secondary".

Rule name:colorSecondary

.MuiAppBar-colorSuccess

Styles applied to the root element if color="success".

Rule name:colorSuccess

.MuiAppBar-colorTransparent

Styles applied to the root element if color="transparent".

Rule name:colorTransparent

.MuiAppBar-colorWarning

Styles applied to the root element if color="warning".

Rule name:colorWarning

.MuiAppBar-positionAbsolute

Styles applied to the root element if position="absolute".

Rule name:positionAbsolute

.MuiAppBar-positionFixed

Styles applied to the root element if position="fixed".

Rule name:positionFixed

.MuiAppBar-positionRelative

Styles applied to the root element if position="relative".

Rule name:positionRelative

.MuiAppBar-positionStatic

Styles applied to the root element if position="static".

Rule name:positionStatic

.MuiAppBar-positionSticky

Styles applied to the root element if position="sticky".

Rule name:positionSticky

.MuiAppBar-root

Styles applied to the root element.

Rule name:root


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