1.0.5 • Published 3 months ago
@tan_dream/elpis v1.0.5
elpis
一个企业级全栈应用框架
model 配置
{
mode: '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(除了moduoleType === 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: {
...elTableColumnCofing, // 标准el-table-column配置
toFixed: 0, // 保留小数点后几位
visiable: 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-column配置
comType: '', // 控件类型 input/select/input-number
visible: true, // 是否展示（true/false），默认为true
disabled: false, // 是否禁用（true/false）, 默认为false
default: '', // 默认值
// comType === 'select' 时生性
enumList: [] , // 枚举列表
},
// 字段在 editForm表单中的相关配置
editFormOption: {
...eleComponentConfig, // 标准el-component-column配置
comType: '', // 控件类型 input/select/input-number
visible: true, // 是否展示（true/false），默认为true
disabled: false, // 是否禁用（true/false）, 默认为false
default: '', // 默认值
// comType === 'select' 时生性
enumList: [] , // 枚举列表
},
detailPanelOption: {
...eleComponentConfig, // 标准el-component-column配置
}
},
...
},
required: [] // 必填项
},
// table 相关配置
tableConfig: {
headerButtons: [{
label: '', // 按钮中文名
evenKey: '', // 按钮事件名
// 按钮具体配置
eventOption: {
// 当 eventKey === 'showComponent'
comName: '' //组件名称
},
...elButtonConfig, // 标准 el-button配置
}, ...],
rowButtons: [{
label: '', // 按钮中文名
evenKey: '', // 按钮事件名
eventOption: {
// 当 eventKey === 'showComponent'
comName: '', //组件名称
// 当eventKey ==== 'remove'
params: {
// paramKey = 参数的键值
// rowValue = 参数值，格式为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: '', // 表单标题
}
// ...支持用户动态拓展
},
}
}, ...]
}服务端启动
const {
serverStart
} = require('@chenyiliang/elpis');
// 启动 elpis 服务
const app = serverStart({})自定义服务端
- router-schema
- router
- controller
- service
- extend
- config
前端构建
const {frontendBuild} = require('@chenyiliang/elpis');
// 编译构建前端工程
frontendBuild(process.env._ENV)在自定义页面拓展
- 在
app/pages/目录下写入口 entry.xxx.js
dashboard / custom-view 自定义页面拓展
- 在
app/pages/dashboard/xxx下写页面
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