CardMedia API

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

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Card

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.

children

The content of the component.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

component

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

Type:elementType

image

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.

Type:string

src

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

Type:string

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

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.

.MuiCardMedia-img

Styles applied to the root element if component="picture or img".

Rule name:img

.MuiCardMedia-media

Styles applied to the root element if component="video, audio, picture, iframe, or img".

Rule name:media

.MuiCardMedia-root

Styles applied to the root element.

Rule name:root

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.