elpis

企业级应用框架

model配置：

export const obj = {
  mode: "dashboard", // 模版类型，不同模板类型对应不一样的模板数据结构
  name: "", // 名称
  desc: "", // 描述
  icon: "", // 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 时可填
      customCofig: {
        path: "", // 自定义路由
      },

      // 当 moduleType 为 schema 时可填
      schemaConfig: {
        api: "", // 数据源 API （遵循 RESTFUL 规范）
        schema: {
          // 板块数据结构
          type: "object",
          properties: {
            key: {
              ...schema, // 标准 schema 配置
              type: "", // 字段类型
              label: "", // 字段中文名

              // 字段在 table 中的相关配置
              tableOption: {
                ...elTableColumnConfig, // 标准 el-table-column 配置
                visible: true, // 默认为 true（false 或不配置时，表示不在表格中显示）
              },

              // 字段在 search-bar 中的相关配置
              searchOption: {
                ...eleComponentConfig, // 标准 el-component-column 配置
                comType: "", // 配置组件类型 input/select…
                default: "", // 默认值

                // 当 comType === ‘select‘ 时
                enumList: [], // 下拉框可选项

                // 当 comType === 'dynamicSelect' 时
                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: [], // 枚举列表
              },

              // 字段在 edit-form 表单中的相关配置
              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 配置
              },
            },
            // ...
          },

          // 必填 properties
          required: [],
        },

        // table 相关配置
        tableConfig: {
          headerButtons: [
            {
              label: "", // 按钮中文名
              eventKey: "", // 按钮事件名
              // 按钮配置
              eventOption: {
                // 当 eventKey === 'showComponent' 时
                comName: "", // 组件名称（showComponent 调起的组件）
              },
              ...elButtonConfig,
            },
            // ...
          ],
          rowButtons: [
            {
              label: "", // 按钮中文名
              eventKey: "", // 按钮事件名
              // 按钮事件具体配置
              eventOption: {
                // 当 eventKey === 'showComponent' 时
                comName: "", // 组件名称（showComponent 调起的组件）

                // 当 eventKey === 'remove' 时
                params: {
                  // paramKey=接口参数名
                  // rowValueKey= 参数值 （格式为 schema::tableKey，到 table 中找相应的字段）
                  paramKey: rowValueKey,
                },
              }, // 按钮配置
              ...elButtonConfig,
            },
            // ...
          ],
        }, // table 相关配置

        // search-bar 相关配置
        searchConfig: {},

        // 动态组件 相关配置
        componentConfig: {
          // create-form 表单相关配置
          createForm: {
            title: "", // 表单标题
            saveBtnText: "", // 保存按钮文案
          },
          // edit-form 表单相关配置
          editForm: {
            title: "", // 表单标题
            saveBtnText: "", // 保存按钮文案
            mainKey: "", // 表单主键，用于唯一表示要修改的数据对象
          },

          // 详情面板的相关配置
          detailPanel: {
            title: "", // 表单标题
            mainKey: "", // 表单主键，用于唯一表示要修改的数据对象
          },
        },
      },
    },
    // ...
  ],
};

服务端启动：

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

const app = serverStart({});

自定义服务端：

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

前端构建：

const { frontendBuild } = require("@wanglindoc/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