ImageList API

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

Component demos

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

Image List

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'

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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiImageList-masonry

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

Rule name:masonry

.MuiImageList-quilted

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

Rule name:quilted

.MuiImageList-root

Styles applied to the root element.

Rule name:root

.MuiImageList-standard

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

Rule name:standard

.MuiImageList-woven

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

Rule name:woven

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.