CardHeader API
The API documentation of the CardHeader React component. Learn more about the props and the CSS customization points.
Import
import CardHeader from '@material-ui/core/CardHeader';
// or
import { CardHeader } from '@material-ui/core';
You can learn more about the difference by reading this guide.
Component name
The MuiCardHeader
name can be used for providing default props or style overrides at the theme level.
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 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 ). |
|
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 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 thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.