@zhoujw6/elpis NPM

elpis

一个企业级应用，通过全栈实现

model 配置

{
  mode: 'dashboard', // 模板类型，不同模板类型对应不一样的模板数据结构
  name: '', // 名称
  desc: '', // 描述
  icon: '', // 图标
  homePage: '', // 首页
  // 头部菜单
  menus: [
    {
      key: '', // 菜单唯一描述
      name: '', // 菜单标题
      menuType: '', // 枚举值： group / module

      // 当 menuType == group 时，可填
      subMenu:[{
        // 可递归 menuItem
      }, ...],

      // 当 menuType == module 时，可填
      moduleType: '', // 枚举值： sider / iframe / custom / schema

      // 当 moduleType == sider 时
      siderConfig: {
        menu: [{
          // 可递归 menuItem(除 moduleType 为 sider 的情况)
        }]
      },

      // 当 moduleType == iframe 时
      iframeConfig: {
        path: '', // iframe 地址
      },
      
      // 当 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 配置
                toFixed: 0, // 保留几位小数
                visible: true, // 默认值：true，false时，表示不在表单中显示
              },
              // 字段在 search-bar 中的相关配置
              searchOption: {
                ...eleComponentConfig, // 标准 el-component-column 配置
                comType: '', // 配置组件类型 input/select/switch/...
                default: '' // 默认值

                // 当 comType == 'select' 时
                enumList: [{ // 下拉框选项
                  label: '',
                  value: '',
                },...],

                // 当 comType =='dynamicSelect' 时
                api: '', // 下拉框选项数据源 API
              },
              // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的 key
              // 例如：createFormOption 对应 componentConfig 中的 createForm
              createFormOption: {
                ...eleComponentConfig, // 标准 el-component 配置
                comType: '', // 配置控件类型 input/select/switch/...
                visible: true, // 默认值：true，false时，表示不在表单中显示
                disabled: false, // 默认值：false，true时，表示该字段不可编辑
                default: '', // 默认值

                // 当 comType =='select' 时
                enumList: [{ // 下拉框选项
                  label: '',
                  value: '',
                },...],

                // 当 comType =='dynamicSelect' 时
                api: '', // 下拉框选项数据源 API
              },
              // 字段在 editForm 表单中的相关配置            
              editFormOption: {
                ...eleComponentConfig, // 标准 el-component 配置
                comType: '', // 配置控件类型 input/select/switch/...
                visible: true, // 默认值：true，false时，表示不在表单中显示
                disabled: false, // 默认值：false，true时，表示该字段不可编辑
                default: '', // 默认值

                // 当 comType =='select' 时
                enumList: [{ // 下拉框选项
                  label: '',
                  value: '',
                },...],

                // 当 comType =='dynamicSelect' 时
                api: '', // 下拉框选项数据源 API
              },
              // 字段在 editForm 表单中的相关配置            
              detailOptionOption: {
                ...eleComponentConfig, // 标准 el-component 配置
              }
            },
            ...
          },
          required: [], // 标记哪些字段是必填字段
        },
        // table 相关配置
        tableConfig: {
          headerButtons: [{
            label: '', // 按钮中文名
            eventKey: '', // 按钮事件名
            eventOption: {
              // 当 eventKey =='showComponent' 时
              comName: '', // 组件名称
            }, // 按钮具体配置
            ...elButtonConfig, // 标准 el-button 配置
          }, ...],
          rowButtons: [{
            label: '', // 按钮中文名
            eventKey: '', // 按钮事件名
            eventOption: {
              // 当 eventKey =='showComponent' 时
              comName: '', // 组件名称
              // 当 eventKey == 'remove' 时
              params: {
                // paramKey = 参数的键值(行数据中对应键值的字段名)
                // rowValueKey = 参数值（当格式为 schema::xxx 时，到table中找到相应的字段）
                // 例如：paramKey = 'id', rowValueKey = 'schema:id', 则最终的参数为 {id: rowData['id']}
                [paramKey]: rowValueKey 
              }
            }, // 按钮具体配置
            ...elButtonConfig, // 标准 el-button 配置
          }, ...],
        }, 
         // search-bar 相关配置
        searchConfig: {},
        // 动态组件 相关配置
        componentConfig: {
          // create-form 表单相关配置
          createForm: {
            title: '', // 表单标题
            saveBtnText: '', // 保存按钮文案
          },
          editForm: {
            mainKey: '', // 主键字段名，用于唯一标识要修改的数据
            title: '', // 表单标题
            saveBtnText: '', // 保存按钮文案
          },
          // detail-panel 相关配置
          detailPanel: {
            mainKey: '', // 主键字段名，用于唯一标识要修改的数据
            title: '', // 面板标题
          },
          // 其他组件（支持用户动态扩展）
          comA: {},
          comB: {},
          ...
        },
      }
    },
    ...
  ]
};

服务端启动

const { serverStart } = require('@zhoujw6/elpis');

// 启动 elpis 服务
const app = serverStart({
  name: 'ElpisDemo',
  homePage: '/view/project-list'
});

自定义服务端

router-schema
router
controller
service
extend
config

前端构建

const { frontendBuild } = require('@zhoujw6/elpis');

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

自定义页面扩展

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

dashboard / custom-view 自定义页面模板

在 app/pages/dashboard/xxx 下写页面

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

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

schema-form 控件扩展

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

schema-search-bar 控件扩展

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