Skip to content

PigmentContainer API

API reference docs for the React PigmentContainer component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import PigmentContainer from '@mui/material/PigmentContainer';
// or
import { PigmentContainer } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

disableGuttersboolfalse

If true, the left and right padding is removed.

fixedboolfalse

Set the max-width to match the min-width of the current breakpoint. This is useful if you'd prefer to design for a fixed set of sizes instead of trying to accommodate a fully fluid viewport. It's fluid by default.

maxWidth'lg'
| 'md'
| 'sm'
| 'xl'
| 'xs'
| false		'lg'

Determine the max-width of the container. The container width grows with the size of the screen. Set to false to disable maxWidth.

sxArray<func
| object
| bool>
| func
| object		-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

The component cannot hold a ref.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.