CardHeader API
API documentation for the React CardHeader component. Learn about the available props, and the CSS API.
Import
import CardHeader from '@material-ui/core/CardHeader';
// or
import { CardHeader } from '@material-ui/core';
Component name
The nameMuiCardHeader
can be used when providing default props or style overrides in the theme.Props
Name | Type | Default | Description |
---|---|---|---|
action | node | The action to display in the card header. | |
avatar | node | The Avatar element to display. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
disableTypography | bool | false | If true , subheader and title won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the title text, and optional subheader text with the Typography component. |
subheader | node | The content of the component. | |
subheaderTypographyProps | object | These props will be forwarded to the subheader (as long as disableTypography is not true ). | |
sx | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. | |
title | node | The content of the component. | |
titleTypographyProps | object | These props will be forwarded to the title (as long as disableTypography is not true ). |
The
ref
is forwarded to the root element.Any other props supplied will be provided to the root element (native element).
CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiCardHeader-root | Styles applied to the root element. |
avatar | .MuiCardHeader-avatar | Styles applied to the avatar element. |
action | .MuiCardHeader-action | Styles applied to the action element. |
content | .MuiCardHeader-content | Styles applied to the content wrapper element. |
title | .MuiCardHeader-title | Styles applied to the title Typography element. |
subheader | .MuiCardHeader-subheader | Styles applied to the subheader Typography element. |
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.