@payfit/unity-components
Version:
30 lines (29 loc) • 1.05 kB
TypeScript
import { PropsWithChildren, ReactNode } from 'react';
export type AppLayoutProps = PropsWithChildren<{
/**
* The header component to be displayed at the top of the layout
* @default undefined
*/
header?: ReactNode;
/**
* The menu component to be displayed on the side of the layout
*/
menu: ReactNode;
/**
* The footer component to be displayed at the bottom of the layout
* @default undefined
*/
footer?: ReactNode;
/**
* Removes the padding top and right for the content
* @default: false
*/
withoutContentPadding?: boolean;
}>;
/**
* The `AppLayout` component creates a responsive base structure with a sticky menu sidebar.
* Use this when you need a complex layout with a persistent navigation menu.
*
* The menu remains sticky while the document scrolls.
*/
export declare function AppLayout({ children, menu: MenuElement, header: HeaderElement, footer: FooterElement, withoutContentPadding, }: AppLayoutProps): import("react/jsx-runtime").JSX.Element;