CardMedia API
Demos
For examples and details on the usage of this React component, visit the component demo pages:
Import
import CardMedia from '@mui/material/CardMedia';
// or
import { CardMedia } from '@mui/material';
Props
Props of the native component are also available.
Name | Type | 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 | Array<func | object | bool> | func | 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.Theme default props
You can useMuiCardMedia
to change the default props of this component with the theme.CSS
The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.
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.