0.1.0 • Published 3 years ago

@saimo/common-layout v0.1.0

Weekly downloads
5
License
MIT
Repository
-
Last release
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

PropertyDescriptionTypeDefault Value
titlelayout 的 左上角 的 titleVNode | String'Ant Design Pro'
logolayout 的 左上角 logo 的 urlVNode | render-
loading*layout 的加载态boolean-
menuHeaderRender渲染 logo 和 titlev-slot | VNode | (logo,title)=>VNode | false-
layoutlayout 的菜单模式, sidemenu: 右侧导航, topmenu: 顶部导航'sidemenu' | 'topmenu' | 'saimolayout''sidemenu'
contentWidthlayout 的内容模式,Fluid:自适应,Fixed:定宽 1200px'Fixed' | 'Fluid'Fluid
menusVue-router routes 属性Object[{}]
collapsed控制菜单的收起和展开booleantrue
isMobile是否为手机模式booleanfalse
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 | falsefalse
handleMediaQuery媒体查询回调(querys: []) => void-
mediaQueryProLayout 当前的媒体查询Array-

PageHeaderWrapper

PropertyDescriptionTypeDefault Value
content内容区VNode | v-slot-
extra扩展区域VNode | v-slot-
extraContent扩展内容区VNode | v-slot-
tabListTabs 导航Array<{key: string, tab: sting}>-
tab-changeTab 改变事件(key) => void-
tab-active-key当前 Tab 选中项string-

SettingDrawer

{settings}

PropertyDescriptionTypeDefault Value
theme主题dark light realDarklight
layout布局模式sidemenu topmenusidemenu
primaryColor主色调 (*仅开发环境生效)#1890ff