CardMedia API
The API documentation of the CardMedia React component. Learn more about the props and the CSS customization points.
Import
import CardMedia from '@material-ui/core/CardMedia';
// or
import { CardMedia } from '@material-ui/core';
You can learn more about the difference by reading this guide.
Component name
The MuiCardMedia
name can be used for providing default props or style overrides at the theme level.
Props
Name | Type | Default | Description |
---|---|---|---|
children | node | The content of the component. | |
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 HTML 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 props supplied will be provided to the root element (native element).
CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiCardMedia-root | Styles applied to the root element. |
media | .MuiCardMedia-media | Styles applied to the root element if component="video, audio, picture, iframe, or img" . |
img | .MuiCardMedia-img | Styles applied to the root element if component="picture or img" . |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.