Skip to content
Edit this page

ImageList API

API reference docs for the React ImageList component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import ImageList from '@mui/material/ImageList';
// or
import { ImageList } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

childrenRequired

The content of the component, normally ImageListItems.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
cols

Number of columns.

Type:

integer

Default:

2
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
gap

The gap between items in px.

Type:

number

Default:

4
rowHeight

The height of one row in px.

Type:

'auto' | number

Default:

'auto'
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
variant

The variant to use.

Type:

'masonry' | 'quilted' | 'standard' | 'woven' | string

Default:

'standard'
The ref is forwarded to the root element.

Theme default props

You can use MuiImageList 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.


.MuiImageList-rootroot

Styles applied to the root element.

.MuiImageList-masonrymasonry

Styles applied to the root element if variant="masonry".

.MuiImageList-quiltedquilted

Styles applied to the root element if variant="quilted".

.MuiImageList-standardstandard

Styles applied to the root element if variant="standard".

.MuiImageList-wovenwoven

Styles applied to the root element if variant="woven".

You can override the style of the component using one of these customization options: