CardHeader API
The API documentation of the CardHeader React component. Learn more about the properties and the CSS customization points.
import CardHeader from '@material-ui/core/CardHeader';
Props
Name | Type | Default | Description |
---|---|---|---|
action | node | The action to display in the card header. | |
avatar | node | The Avatar for the Card Header. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
component | elementType | 'div' | The component used for the root node. Either a string to use a DOM element or a component. |
disableTypography | bool | false | If true , the children 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 ). |
|
title | node | The content of the Card Title. | |
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 properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes
prop.
This prop accepts the following keys:
Name | Description |
---|---|
root | Styles applied to the root element. |
avatar | Styles applied to the avatar element. |
action | Styles applied to the action element. |
content | Styles applied to the content wrapper element. |
title | Styles applied to the title Typography element. |
subheader | Styles applied to the subheader Typography element. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides
key of the theme,
you need to use the following style sheet name: MuiCardHeader
.
Notes
The component is fully StrictMode compatible.