Skip to content

GridList API

The API documentation of the GridList React component. Learn more about the properties and the CSS customization points.

import GridList from '@material-ui/core/GridList';

Props

Name Type Default Description
cellHeight union: number |
 enum: 'auto'

180 Number of px for one cell height. You can set 'auto' if you want to let the children determine the height.
children * node Grid Tiles that will be in Grid 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 DOM element or a component.
spacing number 4 Number of px for the spacing between tiles.

The ref is forwarded to the root element.

Any other properties supplied will be provided to the root element (native element).

CSS

You can override all the class names injected by Material-UI thanks to the classes prop. This prop accepts the following keys:

Name Description
root Styles applied to the root element.

Have a look at the overriding styles with classes section and the implementation of the component for more detail.

If using the overrides key of the theme, you need to use the following style sheet name: MuiGridList.

Notes

The component is fully StrictMode compatible.

Demos