ruoyi-plus-vben5/packages/@core/uikit/layout-ui/src/vben-layout.ts

182 lines
3.1 KiB
TypeScript
Raw Normal View History

2024-05-19 21:20:42 +08:00
import type {
ContentCompactType,
2024-06-01 23:15:29 +08:00
LayoutHeaderModeType,
2024-05-19 21:20:42 +08:00
LayoutType,
2024-06-01 23:15:29 +08:00
ThemeModeType,
2024-05-19 21:20:42 +08:00
} from '@vben-core/typings';
interface VbenLayoutProps {
/**
*
* @default 'wide'
*/
contentCompact?: ContentCompactType;
/**
*
* @default 1200
*/
contentCompactWidth?: number;
/**
* padding
* @default 16
*/
contentPadding?: number;
/**
* paddingBottom
* @default 16
*/
contentPaddingBottom?: number;
/**
* paddingLeft
* @default 16
*/
contentPaddingLeft?: number;
/**
* paddingRight
* @default 16
*/
contentPaddingRight?: number;
/**
* paddingTop
* @default 16
*/
contentPaddingTop?: number;
/**
* footer背景颜色
* @default #fff
*/
footerBackgroundColor?: string;
2024-06-09 13:31:43 +08:00
/**
* footer
* @default false
*/
footerEnable?: boolean;
2024-05-19 21:20:42 +08:00
/**
* footer
* @default true
*/
footerFixed?: boolean;
/**
* footer
* @default 32
*/
footerHeight?: number;
/**
*
* @default #fff
*/
headerBackgroundColor?: string;
/**
* header高度
* @default 48
*/
headerHeight?: number;
/**
* header高度增加高度
* header高度
* @default 10
*/
headerHeightOffset?: number;
2024-06-01 22:17:52 +08:00
/**
*
* @default false
*/
headerHidden?: boolean;
2024-05-19 21:20:42 +08:00
/**
* header
* @default 'fixed'
*/
2024-06-01 23:15:29 +08:00
headerMode?: LayoutHeaderModeType;
2024-05-19 21:20:42 +08:00
/**
* header是否显示
* @default true
*/
headerVisible?: boolean;
/**
*
* @default false
*/
isMobile?: boolean;
/**
*
* side-nav
* header-nav
* mixed-nav &
* side-mixed-nav
* full-content
* @default side-nav
*/
layout?: LayoutType;
/**
*
* @default false
*/
sideCollapse?: boolean;
/**
* title
* @default true
*/
sideCollapseShowTitle?: boolean;
/**
*
* @default 48
*/
sideCollapseWidth?: number;
2024-06-01 22:17:52 +08:00
/**
*
* @default false
*/
sideHidden?: boolean;
2024-05-19 21:20:42 +08:00
/**
*
* @default false
*/
sideMixedExtraVisible?: boolean;
/**
*
* @default 80
*/
sideMixedWidth?: number;
/**
*
* @default false
*/
sideSemiDark?: boolean;
/**
*
* @default dark
*/
2024-06-01 23:15:29 +08:00
sideTheme?: ThemeModeType;
2024-05-19 21:20:42 +08:00
/**
*
* @default true
*/
sideVisible?: boolean;
/**
*
* @default 210
*/
sideWidth?: number;
/**
* footer背景颜色
* @default #fff
*/
tabsBackgroundColor?: string;
/**
* tab高度
* @default 30
*/
tabsHeight?: number;
/**
* tab是否可见
* @default true
*/
tabsVisible?: boolean;
/**
* zIndex
* @default 100
*/
zIndex?: number;
}
export type { VbenLayoutProps };