ImageListItem API
The API documentation of the ImageListItem React component. Learn more about the props and the CSS customization points.
Import
import ImageListItem from '@material-ui/core/ImageListItem';
// or
import { ImageListItem } from '@material-ui/core';
You can learn more about the difference by reading this guide.
Component name
The MuiImageListItem
name can be used for providing default props or style overrides at the theme level.
Props
Name | Type | Default | Description |
---|---|---|---|
children | node | While you can pass any node as children, the main use case is for an img. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
cols | number | 1 | Width of the item in number of grid columns. |
component | elementType | 'li' | The component used for the root node. Either a string to use a HTML element or a component. |
rows | number | 1 | Height of the item in number of grid rows. |
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 | .MuiImageListItem-root | Styles applied to the root element. |
item | .MuiImageListItem-item | Styles applied to the div element that wraps the children. |
imgFullHeight | .MuiImageListItem-imgFullHeight | Styles applied to an img element child, if needed to ensure it covers the item. |
imgFullWidth | .MuiImageListItem-imgFullWidth | Styles applied to an img element child, if needed to ensure it covers the item. |
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.