ImageList API
API documentation for the React ImageList component. Learn about the available props and the CSS API.
Import
import ImageList from '@mui/material/ImageList';
// or
import { ImageList } from '@mui/material';Component name
The nameMuiImageList can be used when providing default props or style overrides in the theme.Props
Props of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| children* | node | The content of the component, normally ImageListItems. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| cols | integer | 2 | Number of columns. |
| component | elementType | 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 | 'auto' | The height of one row in px. |
| sx | Array<func | object | bool> | func | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. | |
| variant | 'masonry' | 'quilted' | 'standard' | 'woven' | string | 'standard' | The variant to use. |
The
ref is forwarded to the root element.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiImageList-root | Styles applied to the root element. |
| masonry | .MuiImageList-masonry | Styles applied to the root element if variant="masonry". |
| quilted | .MuiImageList-quilted | Styles applied to the root element if variant="quilted". |
| standard | .MuiImageList-standard | Styles applied to the root element if variant="standard". |
| woven | .MuiImageList-woven | Styles applied to the root element if variant="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
styleOverridesproperty in a custom theme.