Skip to content

CardMedia API

The API documentation of the CardMedia React component. Learn more about the properties and the CSS customization points.

import CardMedia from '@material-ui/core/CardMedia';

Props

Name Type Default Description
classes object Override or extend the styles applied to the component. See CSS API below for more details.
component elementType 'div' Component for rendering image. Either a string to use a DOM element or a component.
image string 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.
src string An alias for image property. Available only with media components. Media components: video, audio, picture, iframe, img.

The ref is forwarded to the root element.

Any other properties supplied will be provided to the root element (native element).

CSS

You can override all the class names injected by Material-UI thanks to the classes prop. This prop accepts the following keys:

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

Have a look at the overriding styles with classes section and the implementation of the component for more detail.

If using the overrides key of the theme, you need to use the following style sheet name: MuiCardMedia.

Notes

The component is fully StrictMode compatible.

Demos