Skip to content

CardMedia API

API reference docs for the React CardMedia component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import CardMedia from '@mui/material/CardMedia';
// or
import { CardMedia } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDescription
childrennode

The content of the component.

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.

imagestring

Image to be displayed as a background image. Either image or src prop must be specified. Note that caller must specify height otherwise the image will not be visible.

srcstring

An alias for image property. Available only with media components. Media components: video, audio, picture, iframe, img.

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.

The ref is forwarded to the root element.

Theme default props

You can use MuiCardMedia to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiCardMedia-imgimgStyles applied to the root element if component="picture or img".
.MuiCardMedia-mediamediaStyles applied to the root element if component="video, audio, picture, iframe, or img".
.MuiCardMedia-rootrootStyles applied to the root element.

You can override the style of the component using one of these customization options:

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.