PigmentContainer API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import PigmentContainer from '@mui/material/PigmentContainer';

Name	Type	Default	Description
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
disableGutters	bool	false	If `true`, the left and right padding is removed.
fixed	bool	false	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`.
sx	Array<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.

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiContainer-disableGutters	disableGutters	Styles applied to the root element if `disableGutters={true}`.
.MuiContainer-fixed	fixed	Styles applied to the root element if `fixed={true}`.
.MuiContainer-maxWidthLg	maxWidthLg	Styles applied to the root element if `maxWidth="lg"`.
.MuiContainer-maxWidthMd	maxWidthMd	Styles applied to the root element if `maxWidth="md"`.
.MuiContainer-maxWidthSm	maxWidthSm	Styles applied to the root element if `maxWidth="sm"`.
.MuiContainer-maxWidthXl	maxWidthXl	Styles applied to the root element if `maxWidth="xl"`.
.MuiContainer-maxWidthXs	maxWidthXs	Styles applied to the root element if `maxWidth="xs"`.
.MuiContainer-root	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.

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