GridListTile API
The API documentation of the GridListTile React component. Learn more about the props and the CSS customization points.
Import
import GridListTile from '@material-ui/core/GridListTile';
// or
import { GridListTile } from '@material-ui/core';
You can learn more about the difference by reading this guide.
⚠️ The GridList component was renamed to ImageList to align with the current Material Design naming.
You should use import { ImageListItem } from '@material-ui/core'
or import ImageListItem from '@material-ui/core/ImageListItem'
.
Component name
The MuiGridListTile
name can be used for providing default props or style overrides at the theme level.
Props
Name | Type | Default | Description |
---|---|---|---|
children | node | Theoretically you can pass any node as children, but the main use case is to pass an img, in which case GridListTile takes care of making the image "cover" available space (similar to background-size: cover or to object-fit: cover ). |
|
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
cols | number | 1 | Width of the tile in number of grid cells. |
component | elementType | 'li' | The component used for the root node. Either a string to use a HTML element or a component. |
rows | number | 1 | Height of the tile in number of grid cells. |
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 | .MuiGridListTile-root | Styles applied to the root element. |
tile | .MuiGridListTile-tile | Styles applied to the div element that wraps the children. |
imgFullHeight | .MuiGridListTile-imgFullHeight | Styles applied to an img element child, if needed to ensure it covers the tile. |
imgFullWidth | .MuiGridListTile-imgFullWidth | Styles applied to an img element child, if needed to ensure it covers the tile. |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.