1.0.2 • Published 8 months ago

@ghyassd/elpis v1.0.2

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

###elpis

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

{
model: "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 === side外)
          },
        ],
      },
      // 当moduleType === iframe时
      iframeConfig: {
        path: "", // iframe路径
      },
      // 当moduleType === custom时
      customConfig: {
        path: "", // 自定义路由路径
      },
      // 当moduleType === schema时
      schemaConfig: {
        api: "", //数据源API(遵循RESTFUL规范)
        schema: {
          // 板块数据结构
          type: "object",
          properties: {
            key: {
              ...schema, // 标准schema配置
              label: "", // 字段中文名称
              type: "", // 字段类型
              // 字段在table中的相关配置
              tableOption: {
                ...elTableColumnConfig, // el-table-column配置
                toFixed: 2, // 保留小数位,默认2位
                visible: true, // 默认为true(false时,表示不在表单中展示)
              },
              // 字段在search-bar中的相关配置
              searchOption: {
                ...elComponentConfig, // el-component配置
                comType: "", // 组件类型,用到了哪个组件,就填哪个组件的类型名,如input,select等
                default: "", // 默认值
                // comType === select时,可填
                enumList: [], // 下拉框可选项
                // comType === 'dynamicSelect'时
                api: "",
              },
              // 字段在不同动态component中的相关配置,前缀对应componentConfig中的键值
              // 如:componentConfig.createForm这里对应createFormOption
              // 字段在createForm中相关配置
              createFormOption: {
                ...elComponentConfig, // el-component配置
                comType: "", // 控件类型 input/select/input-number
                visible: true, //是否展示 默认为true(false时,表示不在表单中展示)
                disabled: false, // 是否禁用 默认为false
                default: "", // 默认值
                // comType === select时,可填
                enumList: [], // 下拉框可选项
              },

              editFormOption: {
                ...elComponentConfig, // el-component配置
                comType: "", // 控件类型 input/select/input-number
                visible: true, //是否展示 默认为true(false时,表示不在表单中展示)
                disabled: false, // 是否禁用 默认为false
                default: "", // 默认值
              },

              detailPanelOption: {
                ...elComponentConfig, // el-component配置
              },
            },
          },
          required: [], // 标记哪些字段是必填项
        },
        tableConfig: {
          headerButtons: [
            {
              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: rowValueKey,
                },
              }, // 按钮事件具体配置
              ...elButtonConfig, // el-button配置
            },
          ],
        }, // 表格配置
        // 搜索栏配置
        searchConfig: {},
        // 自定义组件配置
        componentConfig: {
          // 新增form表单相关配置
          createForm: {
            title: "",
            saveBtnText: "",
          },
          // form表单相关配置
          editForm: {
            mainKey: "", // 表单主键,用于唯一标识要修改的数据对象
            title: "",
            saveBtnText: "",
          },
          // detailPanel相关配置
          detailPanel: {
            mainKey: "",
            title: "",
          },
          // 支持用户动态扩展
        },
      },
    },

],
};

服务启动

const { serverStart } = require("@ghyassd/elpis");
// 启动 elpis 服务
const app = serverStart({});

自定义服务端

router-schema router controller = controller

前端构建

const { frontendBuild } = require("@ghyassd/elpis");
frontendBuild(process.env._ENV);

webpack 扩展

在 app/webpack.config.js 中

自定义页面扩展

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

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

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

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

在 app/pages/dashboard/complex-view/schema-view/components/ 下写组件 配置到 app/pages/dashboard/complex-view/schema-view/components/components-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