Skip to content
Edit this page

ImageList API

API documentation for the React ImageList component. Learn about the available props, and the CSS API.

Import

import ImageList from '@material-ui/core/ImageList';
// or
import { ImageList } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiImageList can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
children*nodeItems that will be in the image list.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
colsnumber2Number of columns.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
gapnumber4The gap between items in px.
rowHeight'auto'
| number		'auto'The height of one row in px.
variant'masonry'
| 'quilted'
| 'standard'
| 'woven'
| string		'standard'The variant to use.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiImageList-rootStyles applied to the root element.
masonry.MuiImageList-masonryStyles applied to the root element if variant="masonry".
quilted.MuiImageList-quiltedStyles applied to the root element if variant="quilted".
standard.MuiImageList-standardStyles applied to the root element if variant="standard".
woven.MuiImageList-wovenStyles applied to the root element if variant="woven".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos