1.0.0 • Published 3 months ago

@sunnyboy23/elpis v1.0.0

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

elpis

一个企业级应用框架,通过node全栈实现。

model配置

{
    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时
        customConfig:{
            path:'', //自定义路由路径

        },

        //当 moduleType == schema时
        schemaConfig:{
            api:'', //数据源API (遵循 RESTFUL 规范)
            schema:{
                //板块数据结构
                type:'object',
                properties:{
                    key:{
                        ...schema, //继承标准 schema 配置
                        type:'', //字段类型
                        label:'', //字段的中文名
                        //字段在table中的相关配置
                        tableOption:{
                            ...elTableColumConfig, //标准el-table-column 配置
                            toFixed:0, //暴露小数点后几位
                            visible:true //默认为true(false 表示不再表单中显示)
                        },
                        //字段在search中的配置
                        searchOption:{
                            ...eleComponentConfig,//标准el-component-column
                            comType:'', //配置组件类型 input/select/...
                            default:'', //默认值

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

                            //当comType === ‘dynamicSelect’时
                            api:''

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

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

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

服务端启动

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

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

自定义服务端

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

前端构建

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

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

自定义页面扩展

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

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

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

dashboard/custom-view/components 动态组件扩展

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