AppBar API

API reference docs for the React AppBar 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 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.

Name	Type	Default	Description
children	node		The content of the component.
classes	object		Override or extend the styles applied to the component. See CSS 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.
enableColorOnDark	bool	false	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.
sx	Array<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

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

Global class	Rule name	Description
.MuiAppBar-root	root	Styles applied to the root element.
.MuiAppBar-positionFixed	positionFixed	Styles applied to the root element if `position="fixed"`.
.MuiAppBar-positionAbsolute	positionAbsolute	Styles applied to the root element if `position="absolute"`.
.MuiAppBar-positionSticky	positionSticky	Styles applied to the root element if `position="sticky"`.
.MuiAppBar-positionStatic	positionStatic	Styles applied to the root element if `position="static"`.
.MuiAppBar-positionRelative	positionRelative	Styles applied to the root element if `position="relative"`.
.MuiAppBar-colorDefault	colorDefault	Styles applied to the root element if `color="default"`.
.MuiAppBar-colorPrimary	colorPrimary	Styles applied to the root element if `color="primary"`.
.MuiAppBar-colorSecondary	colorSecondary	Styles applied to the root element if `color="secondary"`.
.MuiAppBar-colorInherit	colorInherit	Styles applied to the root element if `color="inherit"`.
.MuiAppBar-colorTransparent	colorTransparent	Styles applied to the root element if `color="transparent"`.
.MuiAppBar-colorError	colorError	Styles applied to the root element if `color="error"`.
.MuiAppBar-colorInfo	colorInfo	Styles applied to the root element if `color="info"`.
.MuiAppBar-colorSuccess	colorSuccess	Styles applied to the root element if `color="success"`.
.MuiAppBar-colorWarning	colorWarning	Styles applied to the root element if `color="warning"`.

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.