pagelix

一个企业级全栈应用框架。

model 配置

module.exports = {
  mode: 'dashboard', // 模板类型，不同模板类型对应不一样的模板数据结构
  name: '', // 名称
  desc: '', // 描述
  icon: '', // 图标
  homePage: '', // 首页（项目配置）
  // 头部菜单
  menu: [
    // 头部菜单
    {
      key: '',
      name: '',
      menuType: '', // 枚举值，group / module
      // 当menuType为group时，subMenu可填
      subMenu: [
        // 可递归 menuItem
      ],
      // 当menuType为module时，moduleType可填
      moduleType: '', // 枚举值：sider/ iframe / custom / schema
      // 当moduleType为sider时
      siderConfig: {
        menu: [
          // 可递归 menuItem（除了siderConfig）
        ],
      },
      // 当moduleType为iframe时
      iframeConfig: {
        path: '', // iframe的path
      },
      // 当moduleType为custom时
      customConfig: {
        path: '', // 自定义页面的路由路径
      },
      // 当moduleType为schema时
      schemaConfig: {
        api: '', // 数据源API，遵循RESTful规范
        schema: {
          type: 'object',
          properties: {
            key: {
              ...schema, // 标准schema配置
              type: '', // 字段类型
              label: '', // 字段中文名
              //字段在table中的相关配置
              tableOption: {
                ...elTableColumnConfig, // 标准的el-table-column配置
                toFix: 0, // 保留小数点后几位
                visible: true, // 字段是否在table中显示，默认true（配置为false时，表示不在表单中显示）
              },
              // 字段在search-bar中的相关配置
              searchOption: {
                ...elComponentConfig, // 标准的element component配置
                comType: '', // 配置控件类型 input/select ...
                default: '', // 配置默认值
                // 当comType为select时，enumList可填
                enumList: [
                  {
                    label: '',
                    value: '',
                  },
                ],
                // 当comType为dynamicSelect时，则需要配置api
                api: '',
              },
              // 字段在不同动态component中的相关配置，前缀对应 componentConfig中的key
              // 如 componentConfig.createForm 在这里对应createFormOption
              // 字段在createForm中相关配置
              createFormOption: {
                ...eleComponentConfig, // 兼容el-component中的配置
                comType: '', // 控件类型，比如input select 等等
                visible: true, // 是否展示，默认为true
                disabled: false, // 是否禁用，默认false
                default: '', // 默认值
                // comType === 'select'时生效
                enumList: [], // 枚举列表
              },
              // 字段在editForm表单中的相关配置
              editFormOption: {
                ...eleComponentConfig, // 兼容el-component中的配置
                comType: '', // 控件类型，比如input select 等等
                visible: true, // 是否展示，默认为true
                disabled: false, // 是否禁用，默认false
                default: '', // 默认值
                // comType === 'select'时生效
                enumList: [], // 枚举列表
              },
              detailPanelOption: {
                ...eleComponentConfig, // 兼容el-component中的配置
              },
            },
          },
          // 在schema中标识出来哪些字段是必填字段，方便在后序动态组件中进行处理（如表单校验）
          required: [],
        },
        // table相关配置
        tableConfig: {
          // 表头按钮配置
          headerButtons: [
            {
              label: '', // 按钮中文名
              eventKey: '', // 按钮事件名
              // 按钮具体配置
              eventOption: {
                // 当eventKey==='showComponent'时
                comName: '', // 需要展示的动态组件是哪个
              },
              ...elButtonConfig, // 标准的el-button配置
            },
            //...
          ],
          // 行按钮配置
          rowButtons: [
            {
              label: '', // 按钮中文名
              eventKey: '', // 按钮事件名
              eventOption: {
                // 当eventKey==='showComponent'时
                comName: '', // 需要展示的动态组件是哪个

                // 使用params来配置事件对应所携带的参数（比如eventKey==='remove'时）
                params: {
                  // paramKey为参数的键
                  // rowValueKey为参数的值，可以为固定值，也可以是一个规则，当解析器去解析取rowData中的某个值
                  // 当格式为：schema::tableKey 时就去table中找相应的字段，如user_id: schema::user_id
                  paramKey: rowValueKey,
                },
              }, // 按钮具体配置
              ...elButtonConfig, // 标准的el-button配置
            },
            //...
          ],
        },
        // search-bar 相关配置
        searchConfig: {},
        // 动态组件相关配置
        componentConfig: {
          // createForm 表单相关配置
          createForm: {
            title: '', // 表单标题
            saveBtnText: '', // 保存按钮文案
          },
          // editForm 表单相关配置
          editForm: {
            mainKey: '', // 表单主键，用于唯一标识修改的数据对象
            title: '', // 表单标题
            saveBtnText: '', // 保存按钮文案
          },
          // detailPanel 相关配置
          detailPanel: {
            mainKey: '', // 主键，用于唯一标识数据对象
            title: '', // 标题
          },
          // 支持动态扩展..
        },
      },
    },
  ],
}

服务端启动

const { serverStart } = require('pagelix')

// 启动pagelix服务
const app = serverStart({
  name: '',
  homePage: '',
})

自定义服务端

• router-schema
• router
• controller
• service
• extend
• config

前端构建

const { frontendBuild } = require('pagelix')

// 编译构建前端工程
frontendBuild(process.env._ENV)

自定义页面扩展

1. 在 app/pages/[pageName] 目录下写自定义页面[pageName].vue

2. 在 app/pages/[pageName] 目录下写入口 entry.[pageName].js:

import pagelixBoot from '$pagelixBoot'
import demo from './demo.vue'

pagelixBoot(demo)

dashboard/custom-view 自定义页面扩展

• 在 app/pages/dashboard/[pageName] 目录下写自定义页面[pageName].vue

dashboard/schema-view/components 动态组件扩展

1. 在app/pages/dashboard/complex-view/schema-view/components/[componentName]下编写组件[componentName].vue

2. 在app/pages/dashboard/complex-view/schema-view/components/component-config.js中配置组件：

   import demoComponent from './demo-component/demo-component.vue'
   
   const ComponentConfig = {
     demoComponent: {
       component: demoComponent,
     },
   }
   
   export default ComponentConfig

schema-form 控件扩展

1. 在app/pages/widgets/schema-form/complex-view/[componentName]下编写控件[componentName].vue

2. 在app/pages/widgets/schema-form/form-item-config.js中配置控件：

   import demoComponent from './demo-component/demo-component.vue'
   
   const FormItemConfig = {
     demoComponent: {
       component: demoComponent,
     },
   }
   
   export default FormItemConfig

schema-search-bar 控件扩展

1. 在app/pages/widgets/schema-search-bar/complex-view/[componentName]下编写控件[componentName].vue

2. 在app/pages/widgets/schema-search-bar/search-item-config.js中配置控件：

   import demoComponent from './demo-component/demo-component.vue'
   
   const SearchItemConfig = {
     demoComponent: {
       component: demoComponent,
     },
   }
   
   export default SearchItemConfig