CardMedia API
API documentation for the React CardMedia component. Learn about the available props, and the CSS API.
Import
import CardMedia from '@material-ui/core/CardMedia';
// or
import { CardMedia } from '@material-ui/core';
Component name
The nameMuiCardMedia
can be used when providing default props or style overrides in the theme.Props
Props of the native component are also available.
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 | The component used for the root node. 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 . | |
sx | 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.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 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.