CardHeader API
API reference docs for the React CardHeader component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import CardHeader from '@mui/material/CardHeader';
// or
import { CardHeader } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
Props of the native component are also available.
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 classes 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 |
slotProps | { action?: func | object, avatar?: func | object, content?: func | object, root?: func | object, subheader?: func | object, title?: func | object } | {} | The props used for each slot inside. |
slots | { action?: elementType, avatar?: elementType, content?: elementType, root?: elementType, subheader?: elementType, title?: elementType } | {} | The components used for each slot inside. |
subheader | node | - | The content of the component. |
subheaderTypographyProps | object | - | These props will be forwarded to the subheader (as long as disableTypography is not |
sx | Array<func | object | bool> | func | 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 |
ref
is forwarded to the root element.Theme default props
You can use MuiCardHeader
to change the default props of this component with the theme.
Slot name | Class name | Default component | Description |
---|---|---|---|
root | .MuiCardHeader-root | 'div' | The component that renders the root slot. |
avatar | .MuiCardHeader-avatar | 'div' | The component that renders the avatar slot. |
action | .MuiCardHeader-action | 'div' | The component that renders the action slot. |
content | .MuiCardHeader-content | 'div' | The component that renders the content slot. |
title | .MuiCardHeader-title | Typography | The component that renders the title slot (as long as disableTypography is not true ). Follow this guide to learn more about the requirements for this component. |
subheader | .MuiCardHeader-subheader | Typography | The component that renders the subheader slot (as long as disableTypography is not true ). Follow this guide to learn more about the requirements for this component. |
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.