UNPKG

2.01 kBTypeScriptView Raw
1import * as React from 'react';
2import { OverridableComponent, OverrideProps } from '@mui/types';
3import { SxProps, Breakpoint } from '@mui/system';
4import { Theme } from '../styles';
5import { ContainerClasses } from '../Container/containerClasses';
6export interface PigmentContainerOwnProps {
7 children?: React.ReactNode;
8 /**
9 * Override or extend the styles applied to the component.
10 */
11 classes?: Partial<ContainerClasses>;
12 /**
13 * If `true`, the left and right padding is removed.
14 * @default false
15 */
16 disableGutters?: boolean;
17 /**
18 * Set the max-width to match the min-width of the current breakpoint.
19 * This is useful if you'd prefer to design for a fixed set of sizes
20 * instead of trying to accommodate a fully fluid viewport.
21 * It's fluid by default.
22 * @default false
23 */
24 fixed?: boolean;
25 /**
26 * Determine the max-width of the container.
27 * The container width grows with the size of the screen.
28 * Set to `false` to disable `maxWidth`.
29 * @default 'lg'
30 */
31 maxWidth?: Breakpoint | false;
32 /**
33 * The system prop that allows defining system overrides as well as additional CSS styles.
34 */
35 sx?: SxProps<Theme>;
36}
37export interface PigmentContainerTypeMap<AdditionalProps = {}, RootComponent extends React.ElementType = 'div'> {
38 props: AdditionalProps & PigmentContainerOwnProps;
39 defaultComponent: RootComponent;
40}
41export type PigmentContainerProps<RootComponent extends React.ElementType = PigmentContainerTypeMap['defaultComponent'], AdditionalProps = {}> = OverrideProps<PigmentContainerTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
42 component?: React.ElementType;
43};
44/**
45 *
46 * Demos:
47 *
48 * - [Container](https://mui.com/material-ui/react-container/)
49 *
50 * API:
51 *
52 * - [PigmentContainer API](https://mui.com/material-ui/api/pigment-container/)
53 */
54declare const PigmentContainer: OverridableComponent<PigmentContainerTypeMap>;
55export default PigmentContainer;