AppBar API
API documentation for the React AppBar component. Learn about the available props, and the CSS API.
Import
import AppBar from '@material-ui/core/AppBar';
// or
import { AppBar } from '@material-ui/core';
Component name
The nameMuiAppBar
can be used when providing default props or style overrides in the theme.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. |
sx | 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.Any other props supplied will be provided to the root element (Paper).
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 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 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.