GridListTile API
The API documentation of the GridListTile React component. Learn more about the properties and the CSS customization points.
import GridListTile from '@material-ui/core/GridListTile';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 DOM 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 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. |
| tile | Styles applied to the div element that wraps the children. |
| imgFullHeight | Styles applied to an img element child, if needed to ensure it covers the tile. |
| imgFullWidth | Styles applied to an img element child, if needed to ensure it covers the tile. |
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: MuiGridListTile.
Notes
The component is fully StrictMode compatible.