Skip to content

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

Props of the native component are also available.

NameTypeDefaultDescription
actionnode-

The action to display in the card header.

avatarnode-

The Avatar element to display.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

disableTypographyboolfalse

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.

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.

subheadernode-

The content of the component.

subheaderTypographyPropsobject-

These props will be forwarded to the subheader (as long as disableTypography is not true).

sxArray<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.

titlenode-

The content of the component.

titleTypographyPropsobject-

These props will be forwarded to the title (as long as disableTypography is not true).

The 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.

Slots

Slot nameClass nameDefault componentDescription
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-titleTypographyThe 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-subheaderTypographyThe 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.