jamis
Version:
一种支持通过JSON配置方式生成页面的组件库
40 lines (39 loc) • 1.35 kB
TypeScript
/**
* @file Layout
* @description 页面布局，支持左边栏、顶部、内容区域布局。
* @author fex
*
* @param 参数说明：
* * children 会渲染在内容区。
* * header 头部区域
* * aside 边栏
* * asideClassName 边栏附加样式class
* * footer 页脚
* * folder 是否收起边栏
* * asideFixed 边栏是否为固定模式，如果是会用 position:fixed 来定位.
* * className 附件的样式名
* * contentClassName 内容区域附加样式名称
*/
import React from 'react';
import type { SchemaClassName } from 'jamis-core';
interface LayoutProps {
header?: boolean | React.ReactNode;
headerClassName?: SchemaClassName;
aside?: boolean | React.ReactNode;
asideClassName?: SchemaClassName;
asideStyle?: React.CSSProperties;
folded?: boolean;
className?: SchemaClassName;
contentClassName?: SchemaClassName;
contentStyle?: React.CSSProperties;
bodyClassName?: SchemaClassName;
bodyStyle?: React.CSSProperties;
footer?: boolean | React.ReactNode;
footerClassName?: SchemaClassName;
size?: 'sm' | 'base' | 'md' | 'lg';
children?: React.ReactNode;
data?: Record<string, any>;
offScreen?: boolean;
}
export declare const Layout: React.ForwardRefExoticComponent<LayoutProps & React.RefAttributes<HTMLDivElement>>;
export default Layout;