@jh_zhou/elpis
v1.0.8
Published
全栈应用框架
Readme
#elpis
企业级全栈应用框架
model配置
{
model: 'dashboard', // 模板类型 不同模板类型对应不同的数据结构
name: '', // 名称
desc: '', // 描述
icon: '', // icon
homaPage: '', // 首页(项目配置)
// 头部菜单
menu: [{
key: '',// 菜单唯一描述
name: '', // 菜单名称
menuType: '', //枚举值 group/module
// 当menuType==group时，可填
subMenu: [{
// 可递归 menuItem
}, ...],
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: {
...elTableColumnConfig, // 标准el-table-column配置
toFixed: 0, // 保留小数点后几位
visible: true, // 默认为true(false时，表示不在表单中显示)
},
// 字段在 searchOption 中的相关配置
searchOption: {
...elComponentConfig, // 标准 element-ui 组件配置
comType: '', // 配置组件类型，例如input,select...
default: '', // 组件默认值
// comType === select时
enumList: [], // 下拉选项配置
},
// 字段在不同动态compoenet中的相关配置 前缀对应 componentConfig 中的键值
// 如：componentConfig.createForm, 这里对应createFormOption
// 字段在createForm中相关配置
createFormOption: {
...elComponentConfig, // 标准 element-ui 组件配置
comType: '', // 控件类型，例如input,select,input-number...
visible: true, // 是否展示(true/false),默认为true
disabled: false, // 是否禁用,默认为false
default: '', // 组件默认值
// comType === select 时 配置生效
enumList: [], // 枚举列表
},
// 字段在editForm中相关配置
editFormOption: {
...elComponentConfig, // 标准 element-ui 组件配置
comType: '', // 控件类型，例如input,select,input-number...
visible: true, // 是否展示(true/false),默认为true
disabled: false, // 是否禁用,默认为false
default: '', // 组件默认值
// comType === select 时 配置生效
enumList: [], // 枚举列表
},
// 字段在detail-panel中相关配置
detailPanelOption: {
...elComponentConfig, // 标准 element-ui 组件配置
comType: '', // 控件类型，例如input,select,input-number...
default: '', // 组件默认值
// comType === select 时 配置生效
enumList: [], // 枚举列表
},
...
},
...
},
required: [], // 标记哪些字段是必填项
},
// table 相关配置
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 配置
},
...
],
},
// search-bar 相关配置
searchConfig: {},
// 动态组件 模块组件
componentConfig: {
// create-form 表单相关配置
createForm: {
title: '', // 表单标题
saveBtnText: '', // 保存按钮文案
},
// edit-form 表单相关配置
editForm: {
mainKey: '', // 表单主键 用于唯一标识要修改的数据对象
title: '', // 表单标题
saveBtnText: '', // 保存按钮文案
},
// detail-panel 相关配置
detailPanel: {
mainKey: '', // 表单主键 用于唯一标识要修改的数据对象
title: '', // 表单标题
saveBtnText: '', // 保存按钮文案
},
// ...支持用户动态扩展
}
},
}, ...],
}服务端启动
const {
serverStart
} = require('@jh_zhou/elpis');
// 启动 elpis服务
const app = serverStart({
name: 'ElpisDemo',
homePage: '/view/project-list'
});自定义服务端
- router-schema
- router
- controller
- service
- extend
- config
前端构建
const { frontendBuild } = require('@jh_zhou/elpis');
// 编译构建前端工程
frontendBuild(process.env._ENV);自定义页面拓展
- 在
app/pages/目录下写入口 entry.xxx.js
dashboard / custom-view 自定义页面扩展
- 在
app/pages/dashboard/目录下写页面
dashboard / schema-view / components 动态组件扩展
- 在
app/pages/dashboard/complex-view/schema-view/components下写组件 - 在
app/pages/dashboard/complex-view/schema-view/components/component-config.js进行配置
schema-form 控件扩展
- 在
app/widgets/schema-form/complex-view下写组件 - 在
app/widgets/schema-form/form-item-config.js进行配置
schema-search-bar 控件扩展
- 在
app/widgets/schema-search-bar/complex-view下写组件 - 在
app/widgets/schema-search-bar/search-item-config.js进行配置