lune-ui-lib
Version:
Lune UI Components Library
22 lines (21 loc) • 1.13 kB
TypeScript
import { ContainerProps } from '@mui/material/Container';
import { Breakpoint } from '@mui/system';
import React from 'react';
export interface MainLayoutContainerProps extends ContainerProps {
headerComponent?: React.ReactNode;
children: React.ReactNode;
maxWidth?: Breakpoint | false;
}
/**
* A layout container for the main content of standard views
* Provides a maxWidth for a container with your content and center it within the view,
* so you don't have to worry about padding on x-axis.
* Adds margins on y-axis;
* [Story](https://storybook.lune.co/?path=/story/MainLayoutContainer)
* @param headerComponent - top part of the column (title or back button usually)
* @param children - your content (the component will NOT provide spacing the children)
* @param maxWidth - can be used to change the container maxWidth by passing a breakpoint or 'false' to remove it
* by default is set to 'md' breakpoint
*/
declare const MainLayoutContainer: ({ headerComponent, children, maxWidth, ...rest }: MainLayoutContainerProps) => import("react/jsx-runtime").JSX.Element;
export default MainLayoutContainer;