@worktif/purei
Version:
Work TIF Material UI Theme Provider and Customization Suite for React applications with dark mode support and dynamic color schemes
31 lines (30 loc) • 1.38 kB
TypeScript
import * as React from 'react';
import { Theme } from '@mui/material/styles';
type Props = {
children: any;
sx?: (theme: Theme) => any;
};
/**
* BaseLayout is a functional React component that provides a consistent base-layout structure for the application.
*
* It acts as a wrapper component to house nested children components within a predefined base-layout format. The base-layout includes
* elements such as notifications, a container, and a grid system to ensure responsive design and visual consistency.
*
* The component also uses a notification system, which dynamically renders based on the dialog state retrieved from the
* DialogContext.
*
* Dependencies:
* - Material-UI styles for theming and styling.
* - DialogContext to manage and render dialog-based information dynamically.
* - Notification component for rendering alerts or notices at the top level.
* - WorkTifLayout to encapsulate the provided children components within a specific base-layout structure.
*
* Props:
* @prop {React.ReactNode} children - The child components or elements to render inside the base-layout.
*
* Hooks utilized:
* - `useContext(DialogContext)` to access dialog state (open, dialogComponent, and title).
* - `useMemo` to memoize the notification component and prevent unnecessary re-renders.
*/
export declare const BaseLayout: React.FC<Props>;
export {};