CardMedia

CardMedia

The API documentation of the CardMedia React component.

Props

Name Type Default Description
classes object   Override or extend the styles applied to the component. See CSS API below for more details.
component union: string |
 func |
 object
'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.

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

CSS API

You can override all the class names injected by Material-UI thanks to the classes property. This property 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 overriding with classes section and the implementation of the component for more detail.

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

Demos