GridListTileBar API
The API documentation of the GridListTileBar React component. Learn more about the properties and the CSS customization points.
import GridListTileBar from '@material-ui/core/GridListTileBar';Props
| Name | Type | Default | Description |
|---|---|---|---|
| actionIcon | node | An IconButton element to be used as secondary action target (primary action target is the tile itself). | |
| actionPosition | enum: 'left' | 'right' |
'right' | Position of secondary action IconButton. |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| subtitle | node | String or element serving as subtitle (support text). | |
| title | node | Title to be displayed on tile. | |
| titlePosition | enum: 'top' | 'bottom' |
'bottom' | Position of the title bar. |
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. |
| titlePositionBottom | Styles applied to the root element if titlePosition="bottom". |
| titlePositionTop | Styles applied to the root element if titlePosition="top". |
| rootSubtitle | Styles applied to the root element if a subtitle is provided. |
| titleWrap | Styles applied to the title and subtitle container element. |
| titleWrapActionPosLeft | Styles applied to the container element if actionPosition="left". |
| titleWrapActionPosRight | Styles applied to the container element if actionPosition="right". |
| title | Styles applied to the title container element. |
| subtitle | Styles applied to the subtitle container element. |
| actionIcon | Styles applied to the actionIcon if supplied. |
| actionIconActionPosLeft | Styles applied to the actionIcon if actionPosition="left". |
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: MuiGridListTileBar.
Notes
The component is fully StrictMode compatible.