Skip to content
Edit this page

AppBar API

The API documentation of the AppBar React component. Learn more about the props and the CSS customization points.

Import

import AppBar from '@material-ui/core/AppBar';
// or
import { AppBar } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiAppBar name can be used for providing default props or style overrides at the theme level.

Props

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'		 'primary' The color of the component. It supports those theme colors that make sense for this component.
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.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (Paper).

CSS

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

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the Paper component are also available. You can take advantage of this behavior to target nested components.

Demos