#elpis

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

model 配置

{
  mode: "dashboard", // 模板类型，不同模板类型对应不一样的模板数据结构
  name: "", // 名称
  desc: "", // 描述
  icon: "", // 图标
  homePage: "", // 首页
  // 头部菜单
  menu: [
    {
      key: "", // 菜单唯一标识
      name: "", // 菜单名称
      menuType: "", // 菜单类型，目前支持 group(有子菜单)、module

      // 当menuType为group时，subMenu为子菜单
      subMenu: [
        // 子菜单列表，结构同menu
        // {
        //   // 可递归menuItem
        // },
      ],

      // 当menuType为module时，moduleType要填写模块类型
      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
        schema: {
          type: "object",
          properties: {
            key: {
              // ...schema, // 标准 schema 结构
              type: "",
              label: "",
              // 字段在 table 中的相关配置
              tableOption: {
                // element-ui el-table-column 配置
                ...elTableColumnConfig,
                // 自定义配置
                visible: true,
                toFixed: 2, // 保留小数点几位
              },
              // 字段在 search-bar 中的相关配置
              searchOption: {
                // comType: "input", // 组件类型
                // default: '', // 默认值
                // ...eleComponentConfig, // element-ui 组件配置
              },
              /**
               * 字段在不同动态 component 中的相关配置
               * componentConfig 的属性 key 对应为 keyOption
               * 例如：componentConfig.comA => comAOption
               */
              createFormOption: {
                ...eleComponentConfig, // el-component 组件的配置
                comType: "", // 控件类型 input、select、radio、checkbox...
                visible: true, // 是否显示，默认为true
                disabled: false, // 是否禁用，默认为false
                default: "", // 默认值
                // comType 为 select 时的配置
                enumList: [], // 枚举列表
              },
              // 编辑表单
              editFormOption: {
                ...eleComponentConfig, // el-component 组件的配置
                comType: "", // 控件类型 input、select、radio、checkbox...
                visible: true, // 是否显示，默认为true
                disabled: false, // 是否禁用，默认为false
                default: "", // 默认值
                // comType 为 select 时的配置
                enumList: [], // 枚举列表
              },
              detailPanelOption: {
                ...eleComponentConfig
              },

              comAOption: {},
              comBOption: {},
            },
          },
          required: [], // 哪些字段是必填的
        },
        // 表格配置
        tableConfig: {
          // 表头按钮
          headerButtons: [
            {
              label: "按钮名称",
              eventKey: "按钮事件key",
              eventOption: {}, // 按钮具体配置
              ...elButtonConfig,
            },
          ],
          // 行内按钮
          rowButtons: [
            {
              label: "按钮名称",
              eventKey: "按钮事件key",
              // 按钮具体配置
              eventOption: {
                // 当 eventKey === 'showComponent' 时，展示什么组件
                comName: "",
                // 例如：eventKey 为 edit
                params: {
                  // paramKey是传给接口的参数名，field是从table中取值的字段
                  paramKey: "schema::field",
                },
              },
              ...elButtonConfig,
            },
          ],
        },
        // 搜索配置
        searchConfig: {},
        // 动态组件 相关配置
        componentConfig: {
          // create-form 表单相关配置
          createForm: {
            title: "", // 表单标题
            saveBtnText: "", // 保存按钮文字
          },
          editForm: {
            title: '',
            saveBtnText: '',
            mainKey: '' // 唯一标识
          },
          detailPanel: {
            mainKey: '',
            title: ''
          },
          // ...其他扩展
          comA: {},
          comB: {},
        },
      },
    },
    // ...
  ],
};

服务端启动

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

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

自定义服务器

• route-scheme
• router
• Controller
• service
• extend
• config

前端构建

const { frontendBuild } = require("@qsb-elpis/elpis");
// 编译构建前端工程
frontendBuild(process.env._ENV);

自定义页面扩展

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

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

• 在 app/pages/dashboard/xxxx 下写页面

dashboard /shcema-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