0.1.0 • Published 3 years ago
Usage
npm i @saimo/common-layout --save
// or
yarn add @saimo/common-layout
import CommonLayout from '@saimo/common-layout'
// by jsx
export default {
name: 'BasicLayout',
render () {
return (
<CommonLayout>
<router-view />
</CommonLayout>
)
}
}
<template>
<common-layout
title="Saimo Admin"
:menus="menus"
:collapsed="collapsed"
:mediaQuery="query"
:isMobile="isMobile"
:handleMediaQuery="handleMediaQuery"
:handleCollapse="handleCollapse"
:i18nRender="i18nRender"
v-bind="settings"
>
<template v-slot:menuHeaderRender>
<div>
<img src="../assets/logo.svg" />
<h1>Pro Layout</h1>
</div>
</template>
<template v-slot:headerContentRender>
<div>headerContentRender</div>
</template>
<template v-slot:rightContentRender>
<div :class="['ant-pro-global-header-index-right', settings.layout === 'topmenu' && `ant-pro-global-header-index-${settings.theme}`]">
rightContentRender
</div>
</template>
<template v-slot:footerRender>
<div>footerRender</div>
</template>
<setting-drawer
:settings="settings"
lang="zh-CN"
@change="handleSettingChange"
/>
<router-view />
</common-layout>
</template>
<script>
// by template
import CommonLayout, { SettingDrawer } from '@saimo/common-layout'
import { asyncRouterMap } from '../config/router.config'
export default {
name: 'BasicLayout',
data () {
return {
// base
menus: [],
// 侧栏收起状态
collapsed: false,
// 自动隐藏头部栏
autoHideHeader: false,
// 媒体查询
query: {},
// 布局类型
layout: 'sidemenu', // 'sidemenu', 'topmenu'
// 定宽: true / 流式: false
contentWidth: false, // layout of content: `Fluid` or `Fixed`, only works when layout is topmenu
// 是否手机模式
isMobile: false,
settings: {
// 布局类型
layout: defaultSettings.layout, // 'sidemenu', 'topmenu', 'saimolayout'
// CONTENT_WIDTH_TYPE
contentWidth: defaultSettings.contentWidth,
// 主题 'dark' | 'light'
theme: defaultSettings.navTheme,
// 主色调
primaryColor: defaultSettings.primaryColor,
fixedHeader: defaultSettings.fixedHeader,
fixSiderbar: defaultSettings.fixSiderbar,
colorWeak: defaultSettings.colorWeak,
hideHintAlert: false,
hideCopyButton: false
}
}
},
created () {
this.menus = asyncRouterMap.find(item => item.path === '/').children
},
methods: {
i18nRender,
handleMediaQuery (val) {
this.query = val
if (this.isMobile && !val['screen-xs']) {
this.isMobile = false
return
}
if (!this.isMobile && val['screen-xs']) {
this.isMobile = true
this.collapsed = false
}
},
handleCollapse (val) {
this.collapsed = val
},
handleSettingChange ({ type, value }) {
console.log('type', type, value)
type && (this.settings[type] = value)
// TODO something...
}
},
components: {
CommonLayout,
SettingDrawer
}
}
</script>
API
ProLayout
Property | Description | Type | Default Value |
---|
title | layout 的 左上角 的 title | VNode | String | 'Ant Design Pro' |
logo | layout 的 左上角 logo 的 url | VNode | render | - |
loading* | layout 的加载态 | boolean | - |
menuHeaderRender | 渲染 logo 和 title | v-slot | VNode | (logo,title)=>VNode | false | - |
layout | layout 的菜单模式, sidemenu: 右侧导航, topmenu: 顶部导航 | 'sidemenu' | 'topmenu' | 'saimolayout' | 'sidemenu' |
contentWidth | layout 的内容模式,Fluid:自适应,Fixed:定宽 1200px | 'Fixed' | 'Fluid' | Fluid |
menus | Vue-router routes 属性 | Object | [{}] |
collapsed | 控制菜单的收起和展开 | boolean | true |
isMobile | 是否为手机模式 | boolean | false |
handleCollapse | 菜单的折叠收起事件 | (collapsed: boolean) => void | - |
headerRender | 自定义头的 render 方法 | (props: BasicLayoutProps) => VNode | - |
rightContentRender | 自定义头右部的 render 方法 | (props: HeaderViewProps) => VNode | - |
collapsedButtonRender | 自定义 侧栏收缩按钮 的方法 | (collapsed: boolean) => VNode | - |
footerRender | 自定义 底部区域内容 | (props: BasicLayoutProps) => VNode | - |
breadcrumbRender | 自定义面包屑渲染方法 | ({ route, params, routes, paths, h }) => VNode[] | - |
i18nRender | 本地化渲染函数 (this.$t) | Function (key: string) => string | false | false |
handleMediaQuery | 媒体查询回调 | (querys: []) => void | - |
mediaQuery | ProLayout 当前的媒体查询 | Array | - |
PageHeaderWrapper
Property | Description | Type | Default Value |
---|
content | 内容区 | VNode | v-slot | - |
extra | 扩展区域 | VNode | v-slot | - |
extraContent | 扩展内容区 | VNode | v-slot | - |
tabList | Tabs 导航 | Array<{key: string, tab: sting}> | - |
tab-change | Tab 改变事件 | (key) => void | - |
tab-active-key | 当前 Tab 选中项 | string | - |
SettingDrawer
{settings}
Property | Description | Type | Default Value |
---|
theme | 主题 | dark light realDark | light |
layout | 布局模式 | sidemenu topmenu | sidemenu |
primaryColor | 主色调 (*仅开发环境生效) | #1890ff | |