Masonry API
API documentation for the React Masonry component. Learn about the available props and the CSS API.
Import
import Masonry from '@mui/lab/Masonry';
// or
import { Masonry } from '@mui/lab';
Component name
The nameMuiMasonry
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. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
columns | Array<number | string> | number | object | string | 4 | Number of columns. |
component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
defaultColumns | number | The default number of columns of the component. This is provided for server-side rendering. | |
defaultHeight | number | The default height of the component in px. This is provided for server-side rendering. | |
defaultSpacing | number | The default spacing of the component. Like spacing , it is a factor of the theme's spacing. This is provided for server-side rendering. | |
spacing | Array<number | string> | number | object | string | 1 | Defines the space between children. It is a factor of the theme's spacing. |
sx | Array<func | object | bool> | func | object | Allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
The
ref
is forwarded to the root element.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiMasonry-root | Styles applied to the root element. |
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
styleOverrides
property in a custom theme.