Skip to content

🎉 v5 is out! Head to the documentation to get started.

ImageList API

The API documentation of the ImageList React component. Learn more about the props and the CSS customization points.

Import

import ImageList from '@material-ui/core/ImageList';
// or
import { ImageList } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiImageList name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
cellHeight number
| oneOf(['auto'
Deprecated. Use the rowHeight prop instead.

Cell height in px. Set to 'auto' to let the children determine the height.
children node Items that will be in the image list.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
cols number 2 Number of columns.
component elementType 'ul' The component used for the root node. Either a string to use a HTML element or a component.
gap number 4 The gap between items in px.
rowHeight 'auto'
| number
180 The height of one row in px.
spacing number Deprecated. Use the gap prop instead.

The spacing between items in px.

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 .MuiImageList-root Styles applied to the root element.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos