@cyzcoder/elpis v1.0.1

#elpis

企业级项目,通过全栈实现

model配置

{
  mode: 'dashboard', // 模板类型,不同模板类型对应不一样的模板数据结构
  name: '', // 模板名称
  desc: '', // 模板描述
  icon: '', // 模板图标
  homePage: '', // 首页路径
  // 头部菜单
  menu: [{
    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/user/', // 数据源API(遵循 restful 规范)
      schema: {
        type: 'object',
        properties: {
          key: {
            ...schema, // 标准 schema 配置
            type: '', // 字段类型
            label: '', // 字段的中文名
            // 字段在 table 中的相关配置
            tableOption: {
              ...elTableColumnConfig, // 标准的el-table-column
              toFixed: 2, // 保留小数几位
              visible: true,  // 默认为 true (false 时 表示不在表单中显示)
            },
            // 字段在search-bar 中的相关配置
            searchOption: {
              ...eleComponentConfig, // 标准 el-component-column 配置
              comType: '', // 配置组件类型 input/select/xxx.....
              default: '', // 默认值

              // comType === 'select
              enumList: [], // 下拉框可选择

              // comType === 'dynamic-select
              api: ''
            },
            // 字段在不同动态 component 中的相关配置, 前缀对应 componentConfig 中的键值
            // 如: componentConfig.createForm, 这里对应 createFormOption
            // 字段在 createForm 中相关的配置
            createFormOption: {
              ...eleComponentConfig, // 标准 el-component 配置
              comType: '', // 控件类型 input/select/input-number
              visible: true, // 是否展示 (true/false). 默认为 true
              disabled: false, // 是否禁用(true/false), 默认为 false
              default: '', // 默认值

              // comType === 'select 生效
              enumList: [] // 枚举列表
            },
            // 字段在 editForm 表单中的相关配置
            editFormOption: {
              ...eleComponentConfig, // 标准 el-component 配置
              comType: '', // 控件类型 input/select/input-number
              visible: true, // 是否展示 (true/false). 默认为 true
              disabled: false, // 是否禁用(true/false), 默认为 false
              default: '', // 默认值

              // comType === 'select 生效
              enumList: [] // 枚举列表
            },
            detailPanelOption: {
              ...eleComponentConfig // 标准 el-component 配置
            }
          },
          ...
        }
        required: [], // 标记哪些字段是必填项
      }
    },
    // table 相关配置
    tableConfig: {
      headersButtons: [{
        label: '', // 按钮中文名
        eventKey: '', // 按钮点击的事件名
        // 按钮具体配置
        eventOption: {
          // 当 eventKey === 'showComponent
          comName: '' // 组件名称
        }, 
        ...elButtonConfig // 标准 el-button 配置
      }, ...],
      rowButtons: [{
        label: '',  // 按钮中文名
        eventKey: '', // 按钮点击的事件名
        eventOption: {
          // 当 eventKey === 'showComponent
          comName: '' // 组件名称
          
          // 当 eventKey === 'remove'
          params: {
            // paramKey = 参数的键值
            // rowValueKey = 参数值 (当格式为 schema::tableKey 的时候, 到 table 中 找相应的字段)
            paramKey: rowValueK
          }
        }, // 按钮具体配置
        ...elButtonConfig // 标准 el-button 配置
      }, ...]
    },
    searchConfig: {}, // search-bar 相关配置
    // 动态组件 相关配置
    componentConfig: {
      title: '', // 表单标题
      saveBtnText: '' // 保存按钮文案
    },
    // edit-form 表单相关配置
    editForm: {
      mainKey: '', // 表单组件,用于唯一标识要修改的数据对象
      title: '', // 表单标题
      saveBtnText: '', // 保存按钮文案
    },
    // detail-panel 相关配置
    detailPanel: {
      mainKey
    }
    // ...支持用户动态扩展
  }, ...]
}

服务端启动

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

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

自定义服务端

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

前端构建

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

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

### 自定义页面扩展
* 在`app/pages/` 目录下写入口 entry.xxx.js

### dashboard / custom-view 自定义页面扩展
* 在 `app/pages/dashboard/xxxx` 下写页面

### dashboard / schema-view / components 动态组件扩展
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/widgets/schema-form/complex-view` 下写控件
2. 配置到 `app/widgets/schema-form/form-item-config.js`

### schema-search-bar 控件扩展
1. 在 `app/widgets/schema-search-bar/complex-view` 下写控件
2. 配置到 `app/widgets/schema-search-bar/search-item-config.js`