1.0.0 • Published 4 months ago

@sleepy_cat/elpis v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
4 months ago

#elpis ##一个企业级应用,全栈实现

model 配置

{
  mode: 'dashboard', // 模板类型,不同模板类型对应不一样的模板数据结构
  name: '', // 名称
  desc: '', // 描述
  icon: '', // icon
  homePage: '', // 首页(项目配置)
  // 头部菜单
  menu: [
    {
      key: '', // 菜单唯一标识
      name: '', // 菜单名称
      menuType: '', // 菜单类型 group / module
      // 当 menuType = group 时,可填
      subMenu: [{}], //
      // 当 menuType = module 时,可填
      moduleType: '', // 枚举值:sider/iframe/custom/schema

      // 当 moduleType = sider
      siderConfig: {
        menu: [{}],
      },

      // 当 moduleType = iframe
      iframeConfig: { path: '' }, //

      // 当 moduleType = custom
      customConfig: { path: '' }, //

      // 当 moduleType = schema
      schemaConfig: {
        api: '', // 数据源 API (遵循 RESTFUL 规范)
        schema: {
          // 板块数据结构
          type: 'object',
          properties: {
            key: {
              // ...schema 继承标准 schema 配置
              type: '', // 字段类型
              label: '', // 字段中文名
              // 字段在 table 中的相关配置
              tableOption: {
                // ...el-component-column 继承 el-component-column配置
                comType: '', // 组件类型
                default: '', // 默认值

                // comType = select
                enumList: [], // 下拉框数据源

                // comType = dynamicSelect
                api: '', // 根据 api 获取下拉框动态数据源
              },
              // 字段在不同动态 component 中的相关配置,前缀对应 componentConfig 中的键值
              // 如:componentConfig.createForm,这里对应 createFormOption
              // 字段子啊 createForm 中相关配置
              creatFormOption: {
                // ...eleComponentConfig 继承 el-component 配置
                comType: '', // 控件类型 input/select/...
                visible: true, // 是否展示, boolean ,默认 true
                disabled: false, // 是否禁用, boolean ,默认 false
                default: '', // 默认值
                // comType = select
                enumList: [], // 枚举列表
              },
              // 字段在 editForm 表单中的相关配置
              editFormOption: {
                // ...eleComponentConfig 继承 el-component 配置
                comType: '', // 控件类型 input/select/...
                visible: true, // 是否展示, boolean ,默认 true
                disabled: false, // 是否禁用, boolean ,默认 false
                default: '', // 默认值
                // comType = select
                enumList: [], // 枚举列表
              },
              // 字段在 detailPanel 表单中的相关配置
              detailPanel: {
                // ...eleComponentConfig 继承 el-component 配置
                comType: '', // 控件类型 input/select/...
              },
            },
          },
          required: [], // 标记哪些字段必填
        },
        // table 配置
        tableConfig: {
          headerButtons: [
            {
              label: '', // 按钮名称
              eventKey: '', // 事件名称
              eventOption: {
                // 事件具体配置
                // 当 eventKey = showComponent
                comName: '', // 组件名称
              },
              // ...elButtonConfig 继承 el-button 配置
            },
          ],
          rowButtons: [
            {
              label: '', // 按钮名称
              eventKey: '', // 事件名称
              eventOption: {
                // 当 eventKey = showComponent
                comName: '', // 组件名称
                params: {
                  // paramKey = 参数的键值
                  // rowValueKey = 参数值,格式为 schema::tableKey,对应 table 中的字段
                  // paramKey: rowValueKey
                },
              }, // 事件具体配置
              // ...elButtonConfig 继承 el-button 配置
            },
          ],
        },
        // search 配置
        searchConfig: {},
        // 动态组件 配置
        componentConfig: {
          createForm: {
            title: '', // 表单标题
            saveBtnText: '', // 保存按钮文案
          },
          // edit-form 表单相关配置
          editForm: {
            mainkey: '', // 表单主键,用于唯一标识要修改的数据对象
            title: '', // 表单标题
            saveBtnText: '',
          },
          // detail-panel 相关配置
          detailPanel: {
            mainkey: '', // 表单主键,用于唯一标识要修改的数据对象
            title: '', // 表单标题
            saveBtnText: '',
          }
        },
      },
    },
  ],
}

服务端启动

const { serverStart } = require("@sleepy_cat/elpis");

// 启动 elpis 服务
const app = serverStart({});

自定义服务端

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

前端构建

const { frontendBuild } = require("@sleepy_cat/elpis");

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

自定义页面扩展

  • app/pages/ 目录下写入口 entry.xxx.js

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

  1. app/pages/dashboard/complex-view/schema-view/components 下写组件
  2. 配置到 app/pages/dashboard/complex-view/schema-view/components/component-config.js

schema-form 控件扩展

  1. app/pages/widgets/schema-form/complex-view 下写控件
  2. 配置到 app/pages/widgets/schema-form/form-item-config.js

schema-search-bar 控件扩展

  1. app/pages/widgets/schema-search-bar/complex-view 下写控件
  2. 配置到 app/pages/widgets/schema-search-bar/schema-item-config.js