@dobym/elpis
v1.0.1
Published
```javascript
Downloads
9
Readme
elpis
企业级框架,通过全栈实现
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 === shema 时
schemaConfig: {
api: '', // 数据源API (遵循 RESTFUL 规范)
shcema: { // 板块数据结构
type: 'object',
properties: {
key: {
...schema, // 标准schema 配置
type: '',// 字段类型
label: "", // 字段中文名
// 字段在 table 中的配置
tableOption: {
...elTableColumnConfig, // 标准 el-table-column 配置
toFixed: 0, // 保留小数点后几位
visible: true, // 默认为true(false 或不配置,表示不在表单中显示)
},
// 字段在search-bar 中的相关配置
searchOption: {
...eleComponentConfig, // 标准 el-table-column 配置
comType: '', // 配置空间类型 input/select/...
default: '', // 默认值
// comType === 'select'
enumList: [], // 下拉框可选项
// comType ==='daynamicSelect'
api: ''
},
// 字段在不同动态 component 中相关配置,前缀对应 componentConfig中的键值
// 如:componentConfig.createForm 这里对应 createFormOption
// 字段在 createForm 中相关配置
createFormOption: {
...eleComponentConfig, // 标准el-component 配置
comType: '',// 控件类型 input/select/...
required: false, // 表单项是否必填 默认为false
visible: true, // 是否展示(true/false) 默认true
disabled: false,// 是否禁用(true/false) 默认false
default: '', // 默认值
// comType === 'select' 时生效
enumList: [] // 枚举列表
},
// 字段在editForm 表单中的相关配置
editFormOption: {
...eleComponentConfig, // 标准el-component 配置
comType: '',// 控件类型 input/select/...
required: false, // 表单项是否必填 默认为false
visible: true, // 是否展示(true/false) 默认true
disabled: false,// 是否禁用(true/false) 默认false
default: '', // 默认值
// comType === 'select' 时生效
enumList: [] // 枚举列表
},
detailPanelOption: {
...eleComponentConfig, // 标准el-component 配置
},
},
...
},
required: [], // 标记哪些字段是必填项
},
// table相关配置
tableConfig: {
headerButtons: [{
label: '', // 按钮中文名
eventKey: "",// 按钮事件名
// 按钮事件具体配置
eventOption: {
// 当 eventKey === 'showComponent'
comName: '', // 组件名称
},
...elButtonConfig // 标准 el-button配置
}, ...],
rowButtons: [{
label: '',// 按钮中文名
eventKey: "",// 按钮事件名
eventOption: {
// 当eventKey === 'showComponent'
comName: '', // 组件名称
params: {
// paramKey == 参数的键值
// rowValueKey == 参数值 (当格式喂 schema:: tableKey的时候,到table中找到响应的字段)
paramKey: rowValueKey
}
}, // 按钮事件具体配置
...elButtonConfig // 标准 el-button 配置
}, ...]
},
searchConfig: {}, // 搜索相关配置
// 动态组件相关 配置
componentConfig: {
// create-form 表单相关配置
createForm: {
title: '',// 表单标题
saveBtnText: "",// 保存按钮文案
},
// edit-form 表单相关配置
editForm: {
mainKey: "", // 表单主键,用于唯一标识
title: '', // 表单标题
saveBtnText: '保存',// 保存按钮
},
// detail-panel 相关配置
detailPanel: {
mainKey: "", // 详情面板主键,用于唯一标识
title: '', // 详情面板标题
},
// 支持用户动态扩展
},
}
}, ...]
}
服务端启动
const {serverStart} = require('@doby/elpis')
// 启动 elpis 服务
const app = serverStart({})自定义服务端
- router-schema
- router
- controller
- service
- extend
- config
前端构建
const {frontendBuild} = require('@doby/elpis')
// 编译构建前端工程
frontendBuild(process.env._ENV)自定义页面扩展
- 在
app/pages/目录下写入口 entry.xxx.js
dashboard / custom-view 自定义页面扩展
- 在
app/pages/dashboard/xxxx下写页面
dashboard / schema-view / components 动态组件扩展
- 在
app/pages/dashboard/complex-view/schema-view/components下写组件 - 配置到
app/pages/dashboard/complex-view/schema-view/components/component-config.js
schema-view 控件扩展
- 在
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
